Factory.php
| 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 | use Piwik\Piwik; |
| 12 | use Piwik\Tracker\Visit; |
| 13 | use Piwik\Tracker\VisitInterface; |
| 14 | use Exception; |
| 15 | |
| 16 | class Factory |
| 17 | { |
| 18 | /** |
| 19 | * Returns the Tracker_Visit object. |
| 20 | * This method can be overwritten to use a different Tracker_Visit object |
| 21 | * |
| 22 | * @throws Exception |
| 23 | * @return \Piwik\Tracker\Visit |
| 24 | */ |
| 25 | public static function make() |
| 26 | { |
| 27 | $visit = null; |
| 28 | |
| 29 | /** |
| 30 | * Triggered before a new **visit tracking object** is created. Subscribers to this |
| 31 | * event can force the use of a custom visit tracking object that extends from |
| 32 | * {@link Piwik\Tracker\VisitInterface}. |
| 33 | * |
| 34 | * @param \Piwik\Tracker\VisitInterface &$visit Initialized to null, but can be set to |
| 35 | * a new visit object. If it isn't modified |
| 36 | * Piwik uses the default class. |
| 37 | */ |
| 38 | Piwik::postEvent('Tracker.makeNewVisitObject', array(&$visit)); |
| 39 | |
| 40 | if (!isset($visit)) { |
| 41 | $visit = new Visit(); |
| 42 | } elseif (!($visit instanceof VisitInterface)) { |
| 43 | throw new Exception("The Visit object set in the plugin must implement VisitInterface"); |
| 44 | } |
| 45 | |
| 46 | return $visit; |
| 47 | } |
| 48 | } |
| 49 |