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

PHP Класс Piwik\Archive

You can use **Archive** instances to get data that was archived for one or more sites, for one or more periods and one optional segment. If archive data is not found, this class will initiate the archiving process. 1 **Archive** instances must be created using the {@link build()} factory method; they cannot be constructed. You can search for metrics (such as nb_visits) using the {@link getNumeric()} and {@link getDataTableFromNumeric()} methods. You can search for reports using the {@link getBlob()}, {@link getDataTable()} and {@link getDataTableExpanded()} methods. If you're creating an API that returns report data, you may want to use the {@link createDataTableFromArchive()} helper function. ### Learn more Learn more about _archiving_ here. ### Limitations - You cannot get data for multiple range periods in a single query. - You cannot get data for periods of different types in a single query. ### Examples **_Querying metrics for an API method_** one site and one period $archive = Archive::build($idSite = 1, $period = 'week', $date = '2013-03-08'); return $archive->getDataTableFromNumeric(array('nb_visits', 'nb_actions')); all sites and multiple dates $archive = Archive::build($idSite = 'all', $period = 'month', $date = '2013-01-02,2013-03-08'); return $archive->getDataTableFromNumeric(array('nb_visits', 'nb_actions')); **_Querying and using metrics immediately_** one site and one period $archive = Archive::build($idSite = 1, $period = 'week', $date = '2013-03-08'); $data = $archive->getNumeric(array('nb_visits', 'nb_actions')); $visits = $data['nb_visits']; $actions = $data['nb_actions']; ... do something w/ metric data ... multiple sites and multiple dates $archive = Archive::build($idSite = '1,2,3', $period = 'month', $date = '2013-01-02,2013-03-08'); $data = $archive->getNumeric('nb_visits'); $janSite1Visits = $data['1']['2013-01-01,2013-01-31']['nb_visits']; $febSite1Visits = $data['1']['2013-02-01,2013-02-28']['nb_visits']; ... etc. **_Querying for reports_** $archive = Archive::build($idSite = 1, $period = 'week', $date = '2013-03-08'); $dataTable = $archive->getDataTable('MyPlugin_MyReport'); ... manipulate $dataTable ... return $dataTable; **_Querying a report for an API method_** public function getMyReport($idSite, $period, $date, $segment = false, $expanded = false) { $dataTable = Archive::createDataTableFromArchive('MyPlugin_MyReport', $idSite, $period, $date, $segment, $expanded); return $dataTable; } **_Querying data for multiple range periods_** get data for first range $archive = Archive::build($idSite = 1, $period = 'range', $date = '2013-03-08,2013-03-12'); $dataTable = $archive->getDataTableFromNumeric(array('nb_visits', 'nb_actions')); get data for second range $archive = Archive::build($idSite = 1, $period = 'range', $date = '2013-03-15,2013-03-20'); $dataTable = $archive->getDataTableFromNumeric(array('nb_visits', 'nb_actions')); [1]: The archiving process will not be launched if browser archiving is disabled and the current request came from a browser. Показать файл Открыть проект Примеры использования класса

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

Метод	Описание
build ( string | integer | array $idSites, string $period, Date | string $strDate, boolean | false | string $segment = false, boolean | false | string $_restrictSitesToLogin = false ) : static	Returns a new Archive instance that will query archive data for the given set of sites and periods, using an optional Segment.
clearStaticCache ( )
createDataTableFromArchive ( string $recordName, integer | string | array $idSite, string $period, string $date, string $segment, boolean $expanded = false, boolean $flat = false, integer | null $idSubtable = null, integer | null $depth = null ) : DataTable | Piwik\DataTable\Map	Helper function that creates an Archive instance and queries for report data using query parameter data. API methods can use this method to reduce code redundancy.
factory ( Segment $segment, array $periods, array $idSites, boolean $idSiteIsAll = false, boolean $isMultipleDate = false ) : Archive	Returns a new Archive instance that will query archive data for the given set of sites and periods, using an optional segment.
getDataTable ( string $name, integer | string | null $idSubtable = null ) : DataTable | Piwik\DataTable\Map	Queries and returns one or more reports as DataTable instances.
getDataTableExpanded ( string $name, integer | string | null $idSubtable = null, integer | null $depth = null, boolean $addMetadataSubtableId = true ) : DataTable | Piwik\DataTable\Map	Queries and returns one report with all of its subtables loaded.
getDataTableFromNumeric ( string | array $names ) : DataTable | Piwik\DataTable\Map	Queries and returns metric data in a DataTable instance.
getDataTableFromNumericAndMergeChildren ( $names ) : DataTable | Piwik\DataTable\Map	Similar to {@link getDataTableFromNumeric()} but merges all children on the created DataTable.
getNumeric ( string | array $names ) : false | integer | array	Queries and returns metric data in an array.
getParams ( ) : Piwik\Archive\Parameters	Returns an object describing the set of sites, the set of periods and the segment this Archive will query data for.

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

Метод	Описание
__construct ( Piwik\Archive\Parameters $params, boolean $forceIndexedBySite = false, boolean $forceIndexedByDate = false )
get ( array | string $archiveNames, $archiveDataType, null | integer $idSubtable = null ) : Piwik\Archive\DataCollection	Queries archive tables for data and returns the result.

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

Метод	Описание
cacheArchiveIdsAfterLaunching ( array $archiveGroups, array $plugins )	Gets the IDs of the archives we're querying for and stores them in $this->archives.
cacheArchiveIdsWithoutLaunching ( array $plugins )	Gets the IDs of the archives we're querying for and stores them in $this->archives.
formatNumericValue ( $value )
getArchiveGroupOfPlugin ( $plugin )	Returns the archiving group identifier given a plugin.
getArchiveIds ( string $archiveNames ) : array	Returns archive IDs for the sites, periods and archive names that are being queried. This function will use the idarchive cache if it has the right data, query archive tables for IDs w/o launching archiving, or launch archiving and get the idarchive from ArchiveProcessor instances.
getDoneStringForPlugin ( string $plugin, $idSites ) : string	Returns the done string flag for a plugin using this instance's segment & periods.
getIdArchivesByMonth ( $doneFlags )
getPeriodLabel ( )
getPluginForReport ( string $report ) : string	Returns the name of the plugin that archives a given report.
getRequestedPlugins ( array $archiveNames ) : array	Returns the list of plugins that archive the given reports.
getResultIndices ( ) : array	Returns an array describing what metadata to use when indexing a query result.
getSiteIdsThatAreRequestedInThisArchiveButWereNotInvalidatedYet ( )
initializeArchiveIdCache ( string $doneFlag )	Initializes the archive ID cache ($this->idarchives) for a particular 'done' flag.
invalidatedReportsIfNeeded ( )
prepareArchive ( array $archiveGroups, Site $site, piwik\Period $period )

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