diff options
author | diosmosis <benaka@piwik.pro> | 2015-07-10 07:58:19 +0300 |
---|---|---|
committer | diosmosis <benaka@piwik.pro> | 2015-08-06 17:37:59 +0300 |
commit | d337b5f19acf28eb1522d32dff7af07a9b775020 (patch) | |
tree | b8bf67baac55af06c3d1cc701cb2ecb9fd3a3e7c /core/Tracker/Visit/VisitProperties.php | |
parent | e3447f7ff5ebe77e741395ee8a07d6a3402ab5de (diff) |
Document VisitProperties + add some tracker debug logging to new code in Visit::handle().
Diffstat (limited to 'core/Tracker/Visit/VisitProperties.php')
-rw-r--r-- | core/Tracker/Visit/VisitProperties.php | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/core/Tracker/Visit/VisitProperties.php b/core/Tracker/Visit/VisitProperties.php index 02228dfde8..7cc5133de7 100644 --- a/core/Tracker/Visit/VisitProperties.php +++ b/core/Tracker/Visit/VisitProperties.php @@ -8,14 +8,16 @@ namespace Piwik\Tracker\Visit; - /** - * TODO + * Holds temporary data for tracking requests. + * + * RequestProcessors */ class VisitProperties { /** - * TODO + * Information about the current visit. This array holds the column values that will be inserted or updated + * in the `log_visit` table, or the values for the last known visit of the current visitor. * * @var array */ @@ -30,11 +32,25 @@ class VisitProperties */ private $requestMetadata = array(); + /** + * Set a request metadata value. + * + * @param string $pluginName eg, `'Actions'`, `'Goals'`, `'YourPlugin'` + * @param string $key + * @param mixed $value + */ public function setRequestMetadata($pluginName, $key, $value) { $this->requestMetadata[$pluginName][$key] = $value; } + /** + * Get a request metadata value. Returns `null` if none exists. + * + * @param string $pluginName eg, `'Actions'`, `'Goals'`, `'YourPlugin'` + * @param string $key + * @return mixed + */ public function getRequestMetadata($pluginName, $key) { return @$this->requestMetadata[$pluginName][$key]; |