diff options
| author | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-23 09:57:55 +0400 |
|---|---|---|
| committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-23 09:57:55 +0400 |
| commit | e53a2c7578bff70715cbfb69938b6a65a4e46636 (patch) | |
| tree | 9a51f402fa20109fd6677f6aa283feea4655d5d9 /core/ArchiveProcessor.php | |
| parent | 828b1e0a09f8220c04a750a9b9d680cb606fdbbc (diff) | |
Change some @param array phpdoc tags to be @param Object[], fill in DataTableMap::deleteRow and start documenting ArchiveProcessor.
Diffstat (limited to 'core/ArchiveProcessor.php')
| -rw-r--r-- | core/ArchiveProcessor.php | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/core/ArchiveProcessor.php b/core/ArchiveProcessor.php index 1ff1fd6e9b..c594d03cfe 100644 --- a/core/ArchiveProcessor.php +++ b/core/ArchiveProcessor.php @@ -20,8 +20,19 @@ use Piwik\Db; use Piwik\Period; /** - * The ArchiveProcessor class is used by the Archive object to make sure the given Archive is processed and available in the DB. + * Used to insert numeric and blob archive data. * + * During the Archiving process a descendant of this class is used by plugins + * to cache aggregated analytics statistics. + * + * ArchiveProcessors are passed to plugins via the [ArchiveProcessor.Day.compute](#) + * and [ArchiveProcessor.Period.compute](#) events. Plugins should then the object + * to aggregate data and cache that data. + * + * ### Examples + * + * TODO + * * @package Piwik * @subpackage ArchiveProcessor */ |