PHP Class Piwik\ArchiveProcessor\Rules

Show file Open project: piwik/piwik Class Usage Examples

Public Properties

Property Type Description
$archivingDisabledByTests Flag that will forcefully disable the archiving process (used in tests only)

Public Methods

Method Description
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.

Private Methods

Method Description
getSegmentsToProcess ( $idSites ) : array

Method Details

getDoneFlagArchiveContainsAllPlugins() public static method

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

getDoneFlagArchiveContainsOnePlugin() public static method

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

getDoneFlags() public static method

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
return array

getDoneStringFlagFor() public static method

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
return string

getMinTimeProcessedForTemporaryArchive() public static method

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() public static method

Returns done flag values allowed to be selected
public static getSelectableDoneFlagValues ( ) : string
return string

getTodayArchiveTimeToLive() public static method

public static getTodayArchiveTimeToLive ( )

getTodayArchiveTimeToLiveDefault() public static method

isArchivingDisabledFor() public static method

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

isBrowserArchivingAvailableForSegments() public static method

isBrowserTriggerEnabled() public static method

public static isBrowserTriggerEnabled ( )

isRequestAuthorizedToArchive() public static method

public static isRequestAuthorizedToArchive ( )

isSegmentPreProcessed() public static method

public static isSegmentPreProcessed ( array $idSites, Segment $segment ) : boolean
$idSites array
$segment Piwik\Segment
return boolean

setBrowserTriggerArchiving() public static method

public static setBrowserTriggerArchiving ( $enabled )

setTodayArchiveTimeToLive() public static method

public static setTodayArchiveTimeToLive ( $timeToLiveSeconds )

shouldProcessReportsAllPlugins() public static method

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

shouldSkipUniqueVisitorsCalculationForMultipleSites() public static method

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.

Property Details

$archivingDisabledByTests public static property

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