Converting to namespace: Archive

1 files changed, 81 insertions, 84 deletions

diff --git a/core/Archive.php b/core/Archive.php
index 3e661b7a9e..993390b46d 100644
--- a/core/Archive.php
+++ b/core/Archive.php
@@ -8,6 +8,7 @@
  * @category Piwik
  * @package Piwik
  */
+namespace Piwik;
 use Piwik\Piwik;
 
 /**
@@ -17,10 +18,10 @@ use Piwik\Piwik;
  * - If you query w/ a range period, you can only query for ONE at a time.
  * - If you query w/ a non-range period, you can query for multiple periods, but they must
  *   all be of the same type (ie, day, week, month, year).
- * 
+ *
  * Example:
  * <pre>
- *        $archive = Piwik_Archive::build($idSite = 1, $period = 'week', '2008-03-08');
+ *        $archive = Archive::build($idSite = 1, $period = 'week', '2008-03-08');
  *        $dataTable = $archive->getDataTable('Provider_hostnameExt');
  *        $dataTable->queueFilter('ReplaceColumnNames');
  *        return $dataTable;
@@ -28,19 +29,19 @@ use Piwik\Piwik;
  *
  * Example bis:
  * <pre>
- *        $archive = Piwik_Archive::build($idSite = 3, $period = 'day', $date = 'today');
+ *        $archive = Archive::build($idSite = 3, $period = 'day', $date = 'today');
  *        $nbVisits = $archive->getNumeric('nb_visits');
  *        return $nbVisits;
  * </pre>
  *
  * If the requested statistics are not yet processed, Archive uses ArchiveProcessor to archive the statistics.
- * 
- * TODO: create ticket for this: when building archives, should use each site's timezone (ONLY FOR 'now'). 
- * 
+ *
+ * TODO: create ticket for this: when building archives, should use each site's timezone (ONLY FOR 'now').
+ *
  * @package Piwik
- * @subpackage Piwik_Archive
+ * @subpackage Archive
  */
-class Piwik_Archive
+class Archive
 {
     const REQUEST_ALL_WEBSITES_FLAG = 'all';
     const ARCHIVE_ALL_PLUGINS_FLAG = 'all';
@@ -49,7 +50,7 @@ class Piwik_Archive
     /**
      * List of archive IDs for the site, periods and segment we are querying with.
      * Archive IDs are indexed by done flag and period, ie:
-     * 
+     *
      * array(
      *     'done.Referers' => array(
      *         '2010-01-01' => 1,
@@ -60,32 +61,32 @@ class Piwik_Archive
      *         '2010-01-02' => 4,
      *     ),
      * )
-     * 
+     *
      * or,
-     * 
+     *
      * array(
      *     'done.all' => array(
      *         '2010-01-01' => 1,
      *         '2010-01-02' => 2
      *     )
      * )
-     * 
+     *
      * @var array
      */
     private $idarchives = array();
-    
+
     /**
      * If set to true, the result of all get functions (ie, getNumeric, getBlob, etc.)
      * will be indexed by the site ID, even if we're only querying data for one site.
-     * 
+     *
      * @var bool
      */
     private $forceIndexedBySite;
-    
+
     /**
      * If set to true, the result of all get functions (ie, getNumeric, getBlob, etc.)
      * will be indexed by the period, even if we're only querying data for one period.
-     * 
+     *
      * @var bool
      */
     private $forceIndexedByDate;
@@ -94,14 +95,14 @@ class Piwik_Archive
      * @var Piwik_Archive_Parameters
      */
     private $params;
-    
+
     /**
      * @param Piwik_Archive_Parameters $params
      * @param bool $forceIndexedBySite Whether to force index the result of a query by site ID.
      * @param bool $forceIndexedByDate Whether to force index the result of a query by period.
      */
     protected function __construct(Piwik_Archive_Parameters $params, $forceIndexedBySite = false,
-                                  $forceIndexedByDate = false)
+                                   $forceIndexedByDate = false)
     {
         $this->params = $params;
         $this->forceIndexedBySite = $forceIndexedBySite;
@@ -117,7 +118,7 @@ class Piwik_Archive
      *                                   or date range (ie, 'YYYY-MM-DD,YYYY-MM-DD').
      * @param bool|string $segment Segment definition - defaults to false for backward compatibility.
      * @param bool|string $_restrictSitesToLogin Used only when running as a scheduled task.
-     * @return Piwik_Archive
+     * @return \Piwik\Archive
      */
     public static function build($idSites, $period, $strDate, $segment = false, $_restrictSitesToLogin = false)
     {
@@ -134,7 +135,7 @@ class Piwik_Archive
         $segment = new Piwik_Segment($segment, $websiteIds);
         $idSiteIsAll = $idSites == self::REQUEST_ALL_WEBSITES_FLAG;
         $isMultipleDate = Piwik_Period::isMultiplePeriod($strDate, $period);
-        return Piwik_Archive::factory($segment, $allPeriods, $websiteIds, $idSiteIsAll, $isMultipleDate);
+        return Archive::factory($segment, $allPeriods, $websiteIds, $idSiteIsAll, $isMultipleDate);
     }
 
     public static function factory(Piwik_Segment $segment, array $periods, $idSites, $idSiteIsAll = false, $isMultipleDate = false)
@@ -153,12 +154,11 @@ class Piwik_Archive
         $params->setPeriods($periods);
         $params->setSegment($segment);
 
-        return new Piwik_Archive($params, $forceIndexedBySite, $forceIndexedByDate);
+        return new Archive($params, $forceIndexedBySite, $forceIndexedByDate);
     }
 
-    
     /**
-     * Returns the value of the element $name from the current archive 
+     * Returns the value of the element $name from the current archive
      * The value to be returned is a numeric value and is stored in the archive_numeric_* tables
      *
      * @param string|array $names One or more archive names, eg, 'nb_visits', 'Referers_distinctKeywords',
@@ -170,10 +170,10 @@ class Piwik_Archive
     public function getNumeric($names)
     {
         $data = $this->get($names, 'numeric');
-        
+
         $resultIndices = $this->getResultIndices();
         $result = $data->getArray($resultIndices);
-        
+
         // if only one metric is returned, just return it as a numeric value
         if (empty($resultIndices)
             && count($result) <= 1
@@ -181,7 +181,7 @@ class Piwik_Archive
         ) {
             $result = (float)reset($result); // convert to float in case $result is empty
         }
-        
+
         return $result;
     }
 
@@ -203,12 +203,12 @@ class Piwik_Archive
         $data = $this->get($names, 'blob', $idSubtable);
         return $data->getArray($this->getResultIndices());
     }
-    
+
     /**
      * Returns the numeric values of the elements in $names as a DataTable.
-     * 
+     *
      * Note: Every DataTable instance returned will have at most one row in it.
-     * 
+     *
      * @param string|array $names One or more archive names, eg, 'nb_visits', 'Referers_distinctKeywords',
      *                            etc.
      * @return Piwik_DataTable|false False if no value with the given names. Based on the number
@@ -223,12 +223,12 @@ class Piwik_Archive
 
     /**
      * This method will build a dataTable from the blob value $name in the current archive.
-     * 
+     *
      * For example $name = 'Referers_searchEngineByKeyword' will return a
      * Piwik_DataTable containing all the keywords. If a $idSubtable is given, the method
      * will return the subTable of $name. If 'all' is supplied for $idSubtable every subtable
      * will be returned.
-     * 
+     *
      * @param string $name The name of the record to get.
      * @param int|string|null $idSubtable The subtable ID (if any) or 'all' if requesting every datatable.
      * @return Piwik_DataTable|false
@@ -238,7 +238,7 @@ class Piwik_Archive
         $data = $this->get($name, 'blob', $idSubtable);
         return $data->getDataTable($this->getResultIndices());
     }
-    
+
     /**
      * Same as getDataTable() except that it will also load in memory all the subtables
      * for the DataTable $name. You can then access the subtables by using the
@@ -258,7 +258,7 @@ class Piwik_Archive
 
     /**
      * Returns the list of plugins that archive the given reports.
-     * 
+     *
      * @param array $archiveNames
      * @return array
      */
@@ -271,7 +271,6 @@ class Piwik_Archive
         return array_unique($result);
     }
 
-
     /**
      * Helper - Loads a DataTable from the Archive.
      * Optionally loads the table recursively,
@@ -289,7 +288,7 @@ class Piwik_Archive
     public static function getDataTableFromArchive($name, $idSite, $period, $date, $segment, $expanded, $idSubtable = null)
     {
         Piwik::checkUserHasViewAccess($idSite);
-        $archive = Piwik_Archive::build($idSite, $period, $date, $segment);
+        $archive = Archive::build($idSite, $period, $date, $segment);
         if ($idSubtable === false) {
             $idSubtable = null;
         }
@@ -322,7 +321,7 @@ class Piwik_Archive
         if (!is_array($archiveNames)) {
             $archiveNames = array($archiveNames);
         }
-        
+
         // apply idSubtable
         if ($idSubtable !== null
             && $idSubtable != self::ID_SUBTABLE_LOAD_ALL_SUBTABLES
@@ -331,10 +330,10 @@ class Piwik_Archive
                 $name = $this->appendIdsubtable($name, $idSubtable);
             }
         }
-        
+
         $result = new Piwik_Archive_DataCollection(
             $archiveNames, $archiveDataType, $this->params->getIdSites(), $this->params->getPeriods(), $defaultRow = null);
-        
+
         $archiveIds = $this->getArchiveIds($archiveNames);
         if (empty($archiveIds)) {
             return $result;
@@ -345,8 +344,8 @@ class Piwik_Archive
         foreach ($archiveData as $row) {
             // values are grouped by idsite (site ID), date1-date2 (date range), then name (field name)
             $idSite = $row['idsite'];
-            $periodStr = $row['date1'].",".$row['date2'];
-            
+            $periodStr = $row['date1'] . "," . $row['date2'];
+
             if ($archiveDataType == 'numeric') {
                 $value = $this->formatNumericValue($row['value']);
             } else {
@@ -354,13 +353,13 @@ class Piwik_Archive
                 $result->addMetadata($idSite, $periodStr, 'ts_archived', $row['ts_archived']);
             }
             //FIXMEA
-            $resultRow = &$result->get($idSite, $periodStr);
+            $resultRow = & $result->get($idSite, $periodStr);
             $resultRow[$row['name']] = $value;
         }
-        
+
         return $result;
     }
-    
+
     /**
      * 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,
@@ -370,22 +369,22 @@ class Piwik_Archive
     private function getArchiveIds($archiveNames)
     {
         $plugins = $this->getRequestedPlugins($archiveNames);
-        
+
         // figure out which archives haven't been processed (if an archive has been processed,
         // then we have the archive IDs in $this->idarchives)
         $doneFlags = array();
         $archiveGroups = array();
         foreach ($plugins as $plugin) {
             $doneFlag = $this->getDoneStringForPlugin($plugin);
-            
+
             $doneFlags[$doneFlag] = true;
             if (!isset($this->idarchives[$doneFlag])) {
                 $archiveGroups[] = $this->getArchiveGroupOfPlugin($plugin);
             }
         }
-        
+
         $archiveGroups = array_unique($archiveGroups);
-        
+
         // cache id archives for plugins we haven't processed yet
         if (!empty($archiveGroups)) {
             if (!Piwik_ArchiveProcessor_Rules::isArchivingDisabledFor($this->params->getSegment(), $this->getPeriodLabel())) {
@@ -394,21 +393,21 @@ class Piwik_Archive
                 $this->cacheArchiveIdsWithoutLaunching($plugins);
             }
         }
-        
+
         // order idarchives by the table month they belong to
         $idArchivesByMonth = array();
         foreach (array_keys($doneFlags) as $doneFlag) {
             if (empty($this->idarchives[$doneFlag])) {
                 continue;
             }
-            
+
             foreach ($this->idarchives[$doneFlag] as $dateRange => $idarchives) {
                 foreach ($idarchives as $id) {
                     $idArchivesByMonth[$dateRange][] = $id;
                 }
             }
         }
-        
+
         return $idArchivesByMonth;
     }
 
@@ -422,26 +421,26 @@ class Piwik_Archive
 
     /**
      * Gets the IDs of the archives we're querying for and stores them in $this->archives.
-     * This function will launch the archiving process for each period/site/plugin if 
+     * This function will launch the archiving process for each period/site/plugin if
      * metrics/reports have not been calculated/archived already.
-     * 
+     *
      * @param array $archiveGroups @see getArchiveGroupOfReport
      * @param array $plugins List of plugin names to archive.
      */
     private function cacheArchiveIdsAfterLaunching($archiveGroups, $plugins)
     {
         $today = Piwik_Date::today();
-        
+
         /* @var Piwik_Period $period */
         foreach ($this->params->getPeriods() as $period) {
             $periodStr = $period->getRangeString();
-            
+
             $twoDaysBeforePeriod = $period->getDateStart()->subDay(2);
             $twoDaysAfterPeriod = $period->getDateEnd()->addDay(2);
-            
+
             foreach ($this->params->getIdSites() as $idSite) {
                 $site = new Piwik_Site($idSite);
-                
+
                 // if the END of the period is BEFORE the website creation date
                 // we already know there are no stats for this period
                 // we add one day to make sure we don't miss the day of the website creation
@@ -450,7 +449,7 @@ class Piwik_Archive
                     Piwik::log("Archive $archiveDesc skipped, archive is before the website was created.");
                     continue;
                 }
-        
+
                 // if the starting date is in the future we know there is no visit
                 if ($twoDaysBeforePeriod->isLater($today)) {
                     $archiveDesc = $this->getArchiveDescriptor($idSite, $period);
@@ -458,8 +457,7 @@ class Piwik_Archive
                     continue;
                 }
 
-
-                if($period->getLabel() == 'day') {
+                if ($period->getLabel() == 'day') {
                     $processing = new Piwik_ArchiveProcessor_Day($period, $site, $this->params->getSegment());
                 } else {
                     $processing = new Piwik_ArchiveProcessor_Period($period, $site, $this->params->getSegment());
@@ -477,7 +475,7 @@ class Piwik_Archive
                     $idArchive = $processing->preProcessArchive($plugin);
 
                     $visits = $processing->getNumberOfVisits();
-                    if($visits > 0) {
+                    if ($visits > 0) {
                         $this->idarchives[$doneFlag][$periodStr][] = $idArchive;
                     }
                 }
@@ -489,7 +487,7 @@ class Piwik_Archive
      * Gets the IDs of the archives we're querying for and stores them in $this->archives.
      * This function will not launch the archiving process (and is thus much, much faster
      * than cacheArchiveIdsAfterLaunching).
-     * 
+     *
      * @param array $plugins List of plugin names from which data is being requested.
      */
     private function cacheArchiveIdsWithoutLaunching($plugins)
@@ -502,7 +500,7 @@ class Piwik_Archive
             $doneFlag = $this->getDoneStringForPlugin($plugin);
             $this->initializeArchiveIdCache($doneFlag);
         }
-        
+
         foreach ($idarchivesByReport as $doneFlag => $idarchivesByDate) {
             foreach ($idarchivesByDate as $dateRange => $idarchives) {
                 foreach ($idarchives as $idarchive) {
@@ -511,7 +509,7 @@ class Piwik_Archive
             }
         }
     }
-    
+
     /**
      * Returns the done string flag for a plugin using this instance's segment & periods.
      * @param string $plugin
@@ -527,29 +525,29 @@ class Piwik_Archive
         $periods = $this->params->getPeriods();
         return reset($periods)->getLabel();
     }
-    
+
     /**
      * Returns an array describing what metadata to use when indexing a query result.
      * For use with Piwik_Archive_DataCollection.
-     * 
+     *
      * @return array
      */
     private function getResultIndices()
     {
         $indices = array();
-        
+
         if (count($this->params->getIdSites()) > 1
             || $this->forceIndexedBySite
         ) {
             $indices['site'] = 'idSite';
         }
-        
+
         if (count($this->params->getPeriods()) > 1
             || $this->forceIndexedByDate
         ) {
             $indices['period'] = 'date';
         }
-        
+
         return $indices;
     }
 
@@ -568,12 +566,12 @@ class Piwik_Archive
         // we cast the result as float because returns false when no visitors
         return round((float)$value, 2);
     }
-    
+
     private function getArchiveDescriptor($idSite, $period)
     {
         return "site $idSite, {$period->getLabel()} ({$period->getPrettyString()})";
     }
-    
+
     private function uncompress($data)
     {
         return @gzuncompress($data);
@@ -581,12 +579,12 @@ class Piwik_Archive
 
     /**
      * Initializes the archive ID cache ($this->idarchives) for a particular 'done' flag.
-     * 
+     *
      * It is necessary that each archive ID caching function call this method for each
      * unique 'done' flag it encounters, since the getArchiveIds function determines
      * whether archiving should be launched based on whether $this->idarchives has a
      * an entry for a specific 'done' flag.
-     * 
+     *
      * If this function is not called, then periods with no visits will not add
      * entries to the cache. If the archive is used again, SQL will be executed to
      * try and find the archive IDs even though we know there are none.
@@ -597,15 +595,15 @@ class Piwik_Archive
             $this->idarchives[$doneFlag] = array();
         }
     }
-    
+
     /**
      * Returns the archiving group identifier given a plugin.
-     * 
-     * More than one plugin can be called at once when archiving. In such a case 
-     * we don't want to launch archiving three times for three plugins if doing 
+     *
+     * More than one plugin can be called at once when archiving. In such a case
+     * we don't want to launch archiving three times for three plugins if doing
      * it once is enough, so getArchiveIds makes sure to get the archive group of
      * all reports.
-     * 
+     *
      * If the period isn't a range, then all plugins' archiving code is executed.
      * If the period is a range, then archiving code is executed individually for
      * each plugin.
@@ -615,7 +613,7 @@ class Piwik_Archive
         if ($this->getPeriodLabel() != 'range') {
             return self::ARCHIVE_ALL_PLUGINS_FLAG;
         }
-        
+
         return $plugin;
     }
 
@@ -631,20 +629,19 @@ class Piwik_Archive
         // Core metrics are always processed in Core, for the requested date/period/segment
         if (in_array($report, Piwik_Metrics::getVisitsMetricNames())) {
             $report = 'VisitsSummary_CoreMetrics';
-        }
-        // Goal_* metrics are processed by the Goals plugin (HACK)
-        else if(strpos($report, 'Goal_') === 0) {
+        } // Goal_* metrics are processed by the Goals plugin (HACK)
+        else if (strpos($report, 'Goal_') === 0) {
             $report = 'Goals_Metrics';
         }
-        
+
         $plugin = substr($report, 0, strpos($report, '_'));
         if (empty($plugin)
             || !Piwik_PluginsManager::getInstance()->isPluginActivated($plugin)
         ) {
             $pluginStr = empty($plugin) ? '' : "($plugin)";
             throw new Exception("Error: The report '$report' was requested but it is not available "
-                               . "at this stage. You may also disable the related plugin $pluginStr "
-                               . "to avoid this error.");
+                . "at this stage. You may also disable the related plugin $pluginStr "
+                . "to avoid this error.");
         }
         return $plugin;
     }