Removes deprecated method Archive::getDataTableFromArchive

CHANGELOG.md

@@ -14,6 +14,7 @@ Read more about migrating a plugin from Piwik 2.X to Piwik 3 in [our Migration g
 * The menu classes `Piwik\Menu\MenuReporting` and `Piwik\Menu\MenuMain` have been removed
 * The class `Piwik\Plugin\Widgets` has been removed and replaced by `Piwik\Widget\Widget`. For each widget one class is needed from now on. You can generate a widget via `./console generate:widget`.
 * The class `Piwik\WidgetList` class has been moved to `Piwik\Widget\WidgetsList`.
+* The method `Piwik\Archive::getDataTableFromArchive()` has been removed, use `Piwik\Archive::createDataTableFromArchive` instead.
 * The method `Piwik\Plugin\Menu::configureReportingMenu` has been removed. To add something to the reporting menu you need to create widgets
 * The method `Report::configureWidget()`, `Report::getWidgetTitle()` and `Report::configureReportingMenu()` have been removed, use the new method `Report::configureWidgets()` instead.
 * The method `Report::getCategory()` has been moved to `Report::getCategoryId()` and does no longer return the translated category but the translation key of the category.
@@ -22,7 +23,7 @@ Read more about migrating a plugin from Piwik 2.X to Piwik 3 in [our Migration g
 * The properties `Report::$widgetTitle`, `Report::$widgetParams` and `Report::$menuTitle` were removed, use the method `Report::configureWidgets()` to create widgets instead
 * In the HTTP API methods `Dashboard.getDefaultDashboard` and `Dashboard.getUserDashboards` we do no longer remove not existing widgets as it is up to the client which widgets actually exist
 * The method `Piwik\Plugin\Controller::getEvolutionHtml` has been removed without a replacement as it should be no longer needed. The evolution is generated by ViewDataTables directly
-* The `core:plugin` console command has been removed in favor of the new `plugin:list`, `plugin:activate` and `plugin:deactivate` commands as anounced in Piwik 2.11
+* The `core:plugin` console command has been removed in favor of the new `plugin:list`, `plugin:activate` and `plugin:deactivate` commands as announced in Piwik 2.11
 * The visibility of private properties and methods in `Piwik\Plugins\Login\Controller` were changed to `protected`
 * Controller actions are now case sensitive. This means the URL and events have to use the same case as the name of the action defined in a controller. 
 * When calling the HTTP Reporting API, a default filter limit of 100 is now always applied. The default filter limit used to be not applied to API calls that do not return reports, such as when requesting sites, users or goals information.

core/Archive.php

@@ -32,7 +32,7 @@
  * 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 getDataTableFromArchive()} helper function.
+ * {@link createDataTableFromArchive()} helper function.
  *
  * ### Learn more
  *
@@ -85,8 +85,7 @@
  *
  *     public function getMyReport($idSite, $period, $date, $segment = false, $expanded = false)
  *     {
- *         $dataTable = Archive::getDataTableFromArchive('MyPlugin_MyReport', $idSite, $period, $date, $segment, $expanded);
- *         $dataTable->queueFilter('ReplaceColumnNames');
+ *         $dataTable = Archive::createDataTableFromArchive('MyPlugin_MyReport', $idSite, $period, $date, $segment, $expanded);
  *         return $dataTable;
  *     }
  *
@@ -438,64 +437,37 @@ public function getParams()
      * 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.
      *
-     * @param string $name The name of the report to return.
+     * @param string $recordName The name of the report to return.
      * @param int|string|array $idSite @see {@link build()}
      * @param string $period @see {@link build()}
      * @param string $date @see {@link build()}
      * @param string $segment @see {@link build()}
      * @param bool $expanded If true, loads all subtables. See {@link getDataTableExpanded()}
+     * @param bool $flat If true, loads all subtables and disabled all recursive filters.
      * @param int|null $idSubtable See {@link getDataTableExpanded()}
      * @param int|null $depth See {@link getDataTableExpanded()}
-     * @throws \Exception
-     * @return DataTable|DataTable\Map See {@link getDataTable()} and
-     *                                 {@link getDataTableExpanded()} for more
-     *                                 information
-     * @deprecated Since Piwik 2.12.0 Use Archive::createDataTableFromArchive() instead
+     * @return DataTable|DataTable\Map
      */
-    public static function getDataTableFromArchive($name, $idSite, $period, $date, $segment, $expanded,
-                                                   $idSubtable = null, $depth = null)
+    public static function createDataTableFromArchive($recordName, $idSite, $period, $date, $segment, $expanded = false, $flat = false, $idSubtable = null, $depth = null)
     {
         Piwik::checkUserHasViewAccess($idSite);
 
+        if ($flat && !$idSubtable) {
+            $expanded = true;
+        }
+
         $archive = Archive::build($idSite, $period, $date, $segment, $_restrictSitesToLogin = false);
         if ($idSubtable === false) {
             $idSubtable = null;
         }
 
         if ($expanded) {
-            $dataTable = $archive->getDataTableExpanded($name, $idSubtable, $depth);
+            $dataTable = $archive->getDataTableExpanded($recordName, $idSubtable, $depth);
         } else {
-            $dataTable = $archive->getDataTable($name, $idSubtable);
+            $dataTable = $archive->getDataTable($recordName, $idSubtable);
         }
 
         $dataTable->queueFilter('ReplaceSummaryRowLabel');
-
-        return $dataTable;
-    }
-
-    /**
-     * 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.
-     *
-     * @param string $recordName The name of the report to return.
-     * @param int|string|array $idSite @see {@link build()}
-     * @param string $period @see {@link build()}
-     * @param string $date @see {@link build()}
-     * @param string $segment @see {@link build()}
-     * @param bool $expanded If true, loads all subtables. See {@link getDataTableExpanded()}
-     * @param bool $flat If true, loads all subtables and disabled all recursive filters.
-     * @param int|null $idSubtable See {@link getDataTableExpanded()}
-     * @param int|null $depth See {@link getDataTableExpanded()}
-     * @return DataTable|DataTable\Map
-     */
-    public static function createDataTableFromArchive($recordName, $idSite, $period, $date, $segment, $expanded = false, $flat = false, $idSubtable = null, $depth = null)
-    {
-        if ($flat && !$idSubtable) {
-            $expanded = true;
-        }
-
-        $dataTable = self::getDataTableFromArchive($recordName, $idSite, $period, $date, $segment, $expanded, $idSubtable, $depth);
-
         $dataTable->queueFilter('ReplaceColumnNames');
 
         if ($expanded) {

core/DataTable.php

@@ -155,9 +155,8 @@
  *
  *     public function getMyReport($idSite, $period, $date, $segment = false, $expanded = false)
  *     {
- *         $dataTable = Archive::getDataTableFromArchive('MyPlugin_MyReport', $idSite, $period, $date, $segment, $expanded);
+ *         $dataTable = Archive::createDataTableFromArchive('MyPlugin_MyReport', $idSite, $period, $date, $segment, $expanded);
  *         $dataTable->filter('Sort', array(Metrics::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded));
- *         $dataTable->queueFilter('ReplaceColumnNames');
  *         $dataTable->queueFilter('ColumnCallbackAddMetadata', array('label', 'url', __NAMESPACE__ . '\getUrlFromLabelForMyReport'));
  *         return $dataTable;
  *     }

core/DataTable/Filter/ReplaceColumnNames.php

@@ -30,7 +30,7 @@
  *     // filter use in a plugin's API method
  *     public function getMyReport($idSite, $period, $date, $segment = false, $expanded = false)
  *     {
- *         $dataTable = Archive::getDataTableFromArchive('MyPlugin_MyReport', $idSite, $period, $date, $segment, $expanded);
+ *         $dataTable = Archive::createDataTableFromArchive('MyPlugin_MyReport', $idSite, $period, $date, $segment, $expanded);
  *         $dataTable->queueFilter('ReplaceColumnNames');
  *         return $dataTable;
  *     }

plugins/Contents/API.php

@@ -36,7 +36,7 @@ private function getDataTable($name, $idSite, $period, $date, $segment, $expande
     {
         Piwik::checkUserHasViewAccess($idSite);
         $recordName = Dimensions::getRecordNameForAction($name);
-        $dataTable  = Archive::getDataTableFromArchive($recordName, $idSite, $period, $date, $segment, $expanded, $idSubtable);
+        $dataTable  = Archive::createDataTableFromArchive($recordName, $idSite, $period, $date, $segment, $expanded, $flat=false, $idSubtable);
 
         if (empty($idSubtable)) {
             $dataTable->filter('AddSegmentValue', array(function ($label) {

plugins/Referrers/API.php

@@ -42,8 +42,7 @@ class API extends \Piwik\Plugin\API
      */
     protected function getDataTable($name, $idSite, $period, $date, $segment, $expanded = false, $idSubtable = null)
     {
-        $dataTable = Archive::getDataTableFromArchive($name, $idSite, $period, $date, $segment, $expanded, $idSubtable);
-        $dataTable->queueFilter('ReplaceColumnNames');
+        $dataTable = Archive::createDataTableFromArchive($name, $idSite, $period, $date, $segment, $expanded, $flat=false, $idSubtable);
         return $dataTable;
     }