PHP Класс Piwik\ArchiveProcessor\Rules

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$archivingDisabledByTests Flag that will forcefully disable the archiving process (used in tests only)

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

Метод Описание
getDoneFlagArchiveContainsAllPlugins ( Segment $segment )
getDoneFlagArchiveContainsOnePlugin ( Segment $segment, $plugin )
getDoneFlags ( array $plugins, Segment $segment ) : array Return done flags used to tell how the archiving process for a specific archive was completed,
getDoneStringFlagFor ( array $idSites, Segment $segment, string $periodLabel, string $plugin ) : string Returns the name of the archive field used to tell the status of an archive, (ie, whether the archive was created successfully or not).
getMinTimeProcessedForTemporaryArchive ( Date $dateStart, Piwik\Period $period, Segment $segment, Site $site )
getSelectableDoneFlagValues ( ) : string Returns done flag values allowed to be selected
getTodayArchiveTimeToLive ( )
getTodayArchiveTimeToLiveDefault ( )
isArchivingDisabledFor ( array $idSites, Segment $segment, $periodLabel )
isBrowserArchivingAvailableForSegments ( )
isBrowserTriggerEnabled ( )
isRequestAuthorizedToArchive ( )
isSegmentPreProcessed ( array $idSites, Segment $segment ) : boolean
setBrowserTriggerArchiving ( $enabled )
setTodayArchiveTimeToLive ( $timeToLiveSeconds )
shouldProcessReportsAllPlugins ( array $idSites, Segment $segment, $periodLabel )
shouldSkipUniqueVisitorsCalculationForMultipleSites ( ) : boolean Returns true if the archiving process should skip the calculation of unique visitors across several sites. The [General] enable_processing_unique_visitors_multiple_sites INI config option controls the value of this variable.

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

Метод Описание
getSegmentsToProcess ( $idSites ) : array

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

getDoneFlagArchiveContainsAllPlugins() публичный статический Метод

public static getDoneFlagArchiveContainsAllPlugins ( Segment $segment )
$segment Piwik\Segment

getDoneFlagArchiveContainsOnePlugin() публичный статический Метод

public static getDoneFlagArchiveContainsOnePlugin ( Segment $segment, $plugin )
$segment Piwik\Segment

getDoneFlags() публичный статический Метод

Return done flags used to tell how the archiving process for a specific archive was completed,
public static getDoneFlags ( array $plugins, Segment $segment ) : array
$plugins array
$segment Piwik\Segment
Результат array

getDoneStringFlagFor() публичный статический Метод

Returns the name of the archive field used to tell the status of an archive, (ie, whether the archive was created successfully or not).
public static getDoneStringFlagFor ( array $idSites, Segment $segment, string $periodLabel, string $plugin ) : string
$idSites array
$segment Piwik\Segment
$periodLabel string
$plugin string
Результат string

getMinTimeProcessedForTemporaryArchive() публичный статический Метод

public static getMinTimeProcessedForTemporaryArchive ( Date $dateStart, Piwik\Period $period, Segment $segment, Site $site )
$dateStart Piwik\Date
$period Piwik\Period
$segment Piwik\Segment
$site Piwik\Site

getSelectableDoneFlagValues() публичный статический Метод

Returns done flag values allowed to be selected
public static getSelectableDoneFlagValues ( ) : string
Результат string

getTodayArchiveTimeToLive() публичный статический Метод

public static getTodayArchiveTimeToLive ( )

getTodayArchiveTimeToLiveDefault() публичный статический Метод

isArchivingDisabledFor() публичный статический Метод

public static isArchivingDisabledFor ( array $idSites, Segment $segment, $periodLabel )
$idSites array
$segment Piwik\Segment

isBrowserArchivingAvailableForSegments() публичный статический Метод

isBrowserTriggerEnabled() публичный статический Метод

public static isBrowserTriggerEnabled ( )

isRequestAuthorizedToArchive() публичный статический Метод

public static isRequestAuthorizedToArchive ( )

isSegmentPreProcessed() публичный статический Метод

public static isSegmentPreProcessed ( array $idSites, Segment $segment ) : boolean
$idSites array
$segment Piwik\Segment
Результат boolean

setBrowserTriggerArchiving() публичный статический Метод

public static setBrowserTriggerArchiving ( $enabled )

setTodayArchiveTimeToLive() публичный статический Метод

public static setTodayArchiveTimeToLive ( $timeToLiveSeconds )

shouldProcessReportsAllPlugins() публичный статический Метод

public static shouldProcessReportsAllPlugins ( array $idSites, Segment $segment, $periodLabel )
$idSites array
$segment Piwik\Segment

shouldSkipUniqueVisitorsCalculationForMultipleSites() публичный статический Метод

Returns true if the archiving process should skip the calculation of unique visitors across several sites. The [General] enable_processing_unique_visitors_multiple_sites INI config option controls the value of this variable.

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

$archivingDisabledByTests публичное статическое свойство

Flag that will forcefully disable the archiving process (used in tests only)
public static $archivingDisabledByTests