VisitProperties.php
79 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Matomo - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | */ |
| 8 | |
| 9 | namespace Piwik\Tracker\Visit; |
| 10 | |
| 11 | /** |
| 12 | * Holds temporary data for tracking requests. |
| 13 | */ |
| 14 | class VisitProperties |
| 15 | { |
| 16 | /** |
| 17 | * Information about the current visit. This array holds the column values that will be inserted or updated |
| 18 | * in the `log_visit` table, or the values for the last known visit of the current visitor. |
| 19 | * |
| 20 | * @var array |
| 21 | */ |
| 22 | private $visitInfo = array(); |
| 23 | |
| 24 | public function __construct(array $visitInfo = []) |
| 25 | { |
| 26 | $this->visitInfo = $visitInfo; |
| 27 | } |
| 28 | |
| 29 | /** |
| 30 | * Returns a visit property, or `null` if none is set. |
| 31 | * |
| 32 | * @param string $name The property name. |
| 33 | * @return mixed |
| 34 | */ |
| 35 | public function getProperty($name) |
| 36 | { |
| 37 | return isset($this->visitInfo[$name]) ? $this->visitInfo[$name] : null; |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * Returns all visit properties by reference. |
| 42 | * |
| 43 | * @return array |
| 44 | */ |
| 45 | public function &getProperties() |
| 46 | { |
| 47 | return $this->visitInfo; |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * Sets a visit property. |
| 52 | * |
| 53 | * @param string $name The property name. |
| 54 | * @param mixed $value The property value. |
| 55 | */ |
| 56 | public function setProperty($name, $value) |
| 57 | { |
| 58 | $this->visitInfo[$name] = $value; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Unsets all visit properties. |
| 63 | */ |
| 64 | public function clearProperties() |
| 65 | { |
| 66 | $this->visitInfo = array(); |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Sets all visit properties. |
| 71 | * |
| 72 | * @param array $properties |
| 73 | */ |
| 74 | public function setProperties($properties) |
| 75 | { |
| 76 | $this->visitInfo = $properties; |
| 77 | } |
| 78 | } |
| 79 |