• Главная
• Piwik
• Segment

PHP Класс Piwik\Segment

A segment is a condition used to filter visits. They can, for example, select visits that have a specific browser or come from a specific country, or both. Individual segment dimensions (such as browserCode and countryCode) are defined by plugins. Read about the {@hook API.getSegmentDimensionMetadata} event to learn more. Plugins that aggregate data stored in Piwik can support segments by using this class when generating aggregation SQL queries. ### Examples **Basic usage** $idSites = array(1,2,3); $segmentStr = "browserCode==ff;countryCode==CA"; $segment = new Segment($segmentStr, $idSites); $query = $segment->getSelectQuery( $select = "table.col1, table2.col2", $from = array("table", "table2"), $where = "table.col3 = ?", $bind = array(5), $orderBy = "table.col1 DESC", $groupBy = "table2.col2" ); Db::fetchAll($query['sql'], $query['bind']); **Creating a _null_ segment** $idSites = array(1,2,3); $segment = new Segment('', $idSites); $segment->getSelectQuery will return a query that selects all visits Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$availableSegments
$idSites	array
$segmentExpression	Piwik\Segment\SegmentExpression
$string	string

Открытые методы

Метод	Описание
__construct ( string $segmentCondition, array $idSites )	Constructor.
__toString ( ) : string	Returns the segment string.
getHash ( ) : string	Returns a hash of the segment condition, or the empty string if the segment condition is empty.
getSelectQuery ( string $select, array $from, false | string $where = false, array | string $bind = [], false | string $orderBy = false, false | string $groupBy = false, integer $limit, integer $offset ) : string	Extend an SQL query that aggregates data over one of the 'log_' tables with segment expressions.
getString ( ) : string	Returns the segment condition.
isEmpty ( )	Returns true if the segment is empty, false if otherwise.
willBeArchived ( ) : boolean	Detects whether the Piwik instance is configured to be able to archive this segment. It checks whether the segment will be either archived via browser or cli archiving. It does not check if the segment has been archived. If you want to know whether the segment has been archived, the actual report data needs to be requested.

Защищенные методы

Метод	Описание
getCleanedExpression ( $expression )
initializeSegment ( $string, $idSites )

Приватные методы

Метод	Описание
getAvailableSegments ( )
getExpressionsWithUnionsResolved ( $expressions )
getSegmentByName ( $name )

Описание методов

Описание свойств