Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP
  • Overview
  • Namespace
  • Class
  • Tree
 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 
<?php
namespace Apptus\ESales\Connector\Report;

/**
 * A class holding the number of clicks, number of displays and click through rate for a public panel path.
 */
class Placement {
    private $path;
    private $clicks;
    private $displays;

    /**
     * @internal
     * @param string
     * @param int
     * @param int
     * @param Rate
     * @throws \InvalidArgumentException
     */
    public function __construct($path, $clicks, $displays) {
        $path = (string) $path;
        if (trim($path) === '') {
            throw new \InvalidArgumentException('Path can not be null or empty.');
        }

        $this->path = $path;
        $this->clicks = $clicks;
        $this->displays = $displays;
    }

    /**
     * @return string
     *            The public panel path.
     */
    public function path() {
        return $this->path;
    }

    /**
     * @return int
     *            The number of clicks on the public panel path.
     */
    public function clicks() {
        return $this->clicks;
    }

    /**
     * @return int
     *            The number of displays of the public panel path.
     */
    public function displays() {
        return $this->displays;
    }

    /**
     * @return Rate
     *            The click through rate for the public panel path.
     */
    public function ctr() {
        return $this->displays == 0 ? Rate::NaN() : new Rate($this->clicks / $this->displays);
    }

    public function __toString() {
        return 'Placement{' .
               'path=\'' . $this->path . '\'' .
               ', clicks=' . $this->clicks .
               ', displays=' . $this->displays .
               ', ctr=' . $this->ctr() .
               '}';
    }
}
Apptus ESales Connector PHP API documentation generated by ApiGen