Piwik\Plugins\API\SegmentMetadata::getSegmentsMetadata PHP Method

getSegmentsMetadata() public method

public getSegmentsMetadata ( $idSites = [], $_hideImplementationData = true, $isAuthenticatedWithViewAccess )
    public function getSegmentsMetadata($idSites = array(), $_hideImplementationData = true, $isAuthenticatedWithViewAccess)
    {
        $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) {
                $segments[] = $segment;
            }
        }
        /** @var Segment[] $dimensionSegments */
        $dimensionSegments = $segments;
        $segments = array();
        foreach ($dimensionSegments as $segment) {
            if ($segment->isRequiresAtLeastViewAccess()) {
                $segment->setPermission($isAuthenticatedWithViewAccess);
            }
            $segments[] = $segment->toArray();
        }
        foreach ($segments as &$segment) {
            $segment['name'] = Piwik::translate($segment['name']);
            $segment['category'] = Piwik::translate($segment['category']);
            if ($_hideImplementationData) {
                unset($segment['sqlFilter']);
                unset($segment['sqlFilterValue']);
                unset($segment['sqlSegment']);
                if (isset($segment['suggestedValuesCallback']) && !is_string($segment['suggestedValuesCallback'])) {
                    unset($segment['suggestedValuesCallback']);
                }
            }
        }
        usort($segments, array($this, 'sortSegments'));
        return $segments;
    }

Usage Example

Example #1
0
File: API.php Project: piwik/piwik
 public function getSegmentsMetadata($idSites = array(), $_hideImplementationData = true)
 {
     if (empty($idSites)) {
         Piwik::checkUserHasSomeViewAccess();
     } else {
         Piwik::checkUserHasViewAccess($idSites);
     }
     $isNotAnonymous = !Piwik::isUserIsAnonymous();
     $sites = is_array($idSites) ? implode('.', $idSites) : (int) $idSites;
     $cache = Cache::getTransientCache();
     $cachKey = 'API.getSegmentsMetadata' . $sites . '_' . (int) $_hideImplementationData . '_' . (int) $isNotAnonymous;
     $cachKey = CacheId::pluginAware($cachKey);
     if ($cache->contains($cachKey)) {
         return $cache->fetch($cachKey);
     }
     $metadata = new SegmentMetadata();
     $segments = $metadata->getSegmentsMetadata($idSites, $_hideImplementationData, $isNotAnonymous);
     $cache->save($cachKey, $segments);
     return $segments;
 }