Piwik\ArchiveProcessor\

Parameters

Contains the analytics parameters for the reports that are currently being archived.

Methods

The class defines the following methods:

• setArchiveOnlyReport() — If we want to archive only a single report, we can request that via this method.
• getArchiveOnlyReport() — Gets the report we want to archive specifically, or null if none was specified.
• getPeriod() — Returns the period we are computing statistics for.
• getSite() — Returns the site we are computing statistics for.
• getSegment() — The Segment used to limit the set of visits that are being aggregated.

setArchiveOnlyReport()

If we want to archive only a single report, we can request that via this method.

It is up to each plugin's archiver to respect the setting.

Signature

• It accepts the following parameter(s):

  • $archiveOnlyReport (string|string[]) —

• It does not return anything or a mixed result.

getArchiveOnlyReport()

Gets the report we want to archive specifically, or null if none was specified.

Signature

• Returns: string|null —

getPeriod()

Returns the period we are computing statistics for.

Signature

• It returns a Period value.

getSite()

Returns the site we are computing statistics for.

Signature

• It returns a Site value.

getSegment()

The Segment used to limit the set of visits that are being aggregated.

Signature

• It returns a Segment value.