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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Live;
use Piwik\Cache;
use Piwik\CacheId;
use Piwik\Plugin;
use Piwik\Piwik;
use Piwik\Plugins\Live\ProfileSummary\ProfileSummaryAbstract;
/**
*
*/
class ProfileSummaryProvider
{
/**
* @var Plugin\Manager
*/
private $pluginManager;
public function __construct(Plugin\Manager $pluginManager)
{
$this->pluginManager = $pluginManager;
}
/**
* Returns all available profile summaries
*
* @return ProfileSummaryAbstract[]
* @throws \Exception
*/
public function getAllInstances()
{
$cacheId = CacheId::pluginAware('ProfileSummaries');
$cache = Cache::getTransientCache();
if (!$cache->contains($cacheId)) {
$instances = [];
/**
* Triggered to add new live profile summaries.
*
* **Example**
*
* public function addProfileSummary(&$profileSummaries)
* {
* $profileSummaries[] = new MyCustomProfileSummary();
* }
*
* @param ProfileSummaryAbstract[] $profileSummaries An array of profile summaries
*/
Piwik::postEvent('Live.addProfileSummaries', array(&$instances));
foreach ($this->getAllProfileSummaryClasses() as $className) {
$instances[] = new $className();
}
/**
* Triggered to filter / restrict profile summaries.
*
* **Example**
*
* public function filterProfileSummary(&$profileSummaries)
* {
* foreach ($profileSummaries as $index => $profileSummary) {
* if ($profileSummary->getId() === 'myid') {}
* unset($profileSummaries[$index]); // remove all summaries having this ID
* }
* }
* }
*
* @param ProfileSummaryAbstract[] $profileSummaries An array of profile summaries
*/
Piwik::postEvent('Live.filterProfileSummaries', array(&$instances));
$cache->save($cacheId, $instances);
}
return $cache->fetch($cacheId);
}
/**
* Returns class names of all VisitorDetails classes.
*
* @return string[]
* @api
*/
protected function getAllProfileSummaryClasses()
{
return $this->pluginManager->findMultipleComponents('ProfileSummary', 'Piwik\Plugins\Live\ProfileSummary\ProfileSummaryAbstract');
}
}
|
