Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/API/SegmentMetadata.php')
-rw-r--r--plugins/API/SegmentMetadata.php36
1 files changed, 32 insertions, 4 deletions
diff --git a/plugins/API/SegmentMetadata.php b/plugins/API/SegmentMetadata.php
index 95757638c2..1cce5fd3dd 100644
--- a/plugins/API/SegmentMetadata.php
+++ b/plugins/API/SegmentMetadata.php
@@ -10,6 +10,7 @@ namespace Piwik\Plugins\API;
use Piwik\Columns\Dimension;
use Piwik\Piwik;
+use Piwik\Plugin\Segment;
class SegmentMetadata
{
@@ -17,14 +18,41 @@ class SegmentMetadata
{
$segments = array();
+ /**
+ * Triggered to add custom segment definitions.
+ *
+ * **Example**
+ *
+ * public function addSegments(&$segments)
+ * {
+ * $segment = new Segment();
+ * $segment->setSegment('my_segment_name');
+ * $segment->setType(Segment::TYPE_DIMENSION);
+ * $segment->setName('My Segment Name');
+ * $segment->setSqlSegment('log_table.my_segment_name');
+ * $segments[] = $segment;
+ * }
+ *
+ * @param array &$segments An array containing a list of segment entries.
+ */
+ Piwik::postEvent('Segment.addSegments', array(&$segments));
+
foreach (Dimension::getAllDimensions() as $dimension) {
foreach ($dimension->getSegments() as $segment) {
- if ($segment->isRequiresAtLeastViewAccess()) {
- $segment->setPermission($isAuthenticatedWithViewAccess);
- }
+ $segments[] = $segment;
+ }
+ }
- $segments[] = $segment->toArray();
+ /** @var Segment[] $dimensionSegments */
+ $dimensionSegments = $segments;
+ $segments = array();
+
+ foreach ($dimensionSegments as $segment) {
+ if ($segment->isRequiresAtLeastViewAccess()) {
+ $segment->setPermission($isAuthenticatedWithViewAccess);
}
+
+ $segments[] = $segment->toArray();
}
foreach ($segments as &$segment) {