diff options
Diffstat (limited to 'core/API')
| -rw-r--r-- | core/API/DataTableGenericFilter.php | 12 | ||||
| -rw-r--r-- | core/API/DataTableManipulator.php | 22 | ||||
| -rw-r--r-- | core/API/DataTableManipulator/Flattener.php | 16 | ||||
| -rw-r--r-- | core/API/DataTableManipulator/LabelFilter.php | 12 | ||||
| -rw-r--r-- | core/API/DocumentationGenerator.php | 2 | ||||
| -rw-r--r-- | core/API/Request.php | 5 | ||||
| -rw-r--r-- | core/API/ResponseBuilder.php | 32 |
7 files changed, 57 insertions, 44 deletions
diff --git a/core/API/DataTableGenericFilter.php b/core/API/DataTableGenericFilter.php index 22f691c505..fec5bb7e94 100644 --- a/core/API/DataTableGenericFilter.php +++ b/core/API/DataTableGenericFilter.php @@ -9,6 +9,8 @@ * @package Piwik */ use Piwik\Common; +use Piwik\DataTable; +use Piwik\DataTable\Filter\AddColumnsProcessedMetricsGoal; /** * @package Piwik @@ -31,7 +33,7 @@ class Piwik_API_DataTableGenericFilter /** * Filters the given data table * - * @param Piwik_DataTable $table + * @param DataTable $table */ public function filter($table) { @@ -39,7 +41,7 @@ class Piwik_API_DataTableGenericFilter } /** - * Returns an array containing the information of the generic Piwik_DataTable_Filter + * Returns an array containing the information of the generic Filter * to be applied automatically to the data resulting from the API calls. * * Order to apply the filters: @@ -71,7 +73,7 @@ class Piwik_API_DataTableGenericFilter ), 'AddColumnsProcessedMetricsGoal' => array( 'filter_update_columns_when_show_all_goals' => array('integer'), - 'idGoal' => array('string', Piwik_DataTable_Filter_AddColumnsProcessedMetricsGoal::GOALS_OVERVIEW), + 'idGoal' => array('string', AddColumnsProcessedMetricsGoal::GOALS_OVERVIEW), ), 'Sort' => array( 'filter_sort_column' => array('string'), @@ -95,12 +97,12 @@ class Piwik_API_DataTableGenericFilter * Apply generic filters to the DataTable object resulting from the API Call. * Disable this feature by setting the parameter disable_generic_filters to 1 in the API call request. * - * @param Piwik_DataTable $datatable + * @param DataTable $datatable * @return bool */ protected function applyGenericFilters($datatable) { - if ($datatable instanceof Piwik_DataTable_Array) { + if ($datatable instanceof DataTable\Map) { $tables = $datatable->getArray(); $filterWasApplied = false; foreach ($tables as $table) { diff --git a/core/API/DataTableManipulator.php b/core/API/DataTableManipulator.php index a8d88fda43..03541cf4ff 100644 --- a/core/API/DataTableManipulator.php +++ b/core/API/DataTableManipulator.php @@ -8,7 +8,9 @@ * @category Piwik * @package Piwik */ -use Piwik\Period_Range; +use Piwik\DataTable\Row; +use Piwik\Period\Range; +use Piwik\DataTable; /** * Base class for manipulating data tables. @@ -52,15 +54,15 @@ abstract class Piwik_API_DataTableManipulator * data table arrays. It calls back the template method self::doManipulate for each table. * This way, data table arrays can be handled in a transparent fashion. * - * @param Piwik_DataTable_Array|Piwik_DataTable $dataTable + * @param DataTable\Map|DataTable $dataTable * @throws Exception - * @return Piwik_DataTable_Array|Piwik_DataTable + * @return DataTable\Map|DataTable */ protected function manipulate($dataTable) { - if ($dataTable instanceof Piwik_DataTable_Array) { + if ($dataTable instanceof DataTable\Map) { return $this->manipulateDataTableArray($dataTable); - } else if ($dataTable instanceof Piwik_DataTable) { + } else if ($dataTable instanceof DataTable) { return $this->manipulateDataTable($dataTable); } else { return $dataTable; @@ -81,7 +83,7 @@ abstract class Piwik_API_DataTableManipulator } /** - * Manipulates a single Piwik_DataTable instance. Derived classes must define + * Manipulates a single DataTable instance. Derived classes must define * this function. */ protected abstract function manipulateDataTable($dataTable); @@ -90,10 +92,10 @@ abstract class Piwik_API_DataTableManipulator * Load the subtable for a row. * Returns null if none is found. * - * @param Piwik_DataTable $dataTable - * @param Piwik_DataTable_Row $row + * @param DataTable $dataTable + * @param Row $row * - * @return Piwik_DataTable + * @return DataTable */ protected function loadSubtable($dataTable, $row) { @@ -111,7 +113,7 @@ abstract class Piwik_API_DataTableManipulator $request['idSubtable'] = $idSubTable; if ($dataTable) { $period = $dataTable->metadata['period']; - if ($period instanceof Period_Range) { + if ($period instanceof Range) { $request['date'] = $period->getDateStart().','.$period->getDateEnd(); } else { $request['date'] = $period->getDateStart()->toString(); diff --git a/core/API/DataTableManipulator/Flattener.php b/core/API/DataTableManipulator/Flattener.php index 4f700ac854..6ccae47fdd 100644 --- a/core/API/DataTableManipulator/Flattener.php +++ b/core/API/DataTableManipulator/Flattener.php @@ -8,6 +8,8 @@ * @category Piwik * @package Piwik */ +use Piwik\DataTable; +use Piwik\DataTable\Row; /** * This class is responsible for flattening data tables. @@ -40,8 +42,8 @@ class Piwik_API_DataTableManipulator_Flattener extends Piwik_API_DataTableManipu public $recursiveLabelSeparator = ' - '; /** - * @param Piwik_DataTable $dataTable - * @return Piwik_DataTable|Piwik_DataTable_Array + * @param DataTable $dataTable + * @return DataTable|DataTable\Map */ public function flatten($dataTable) { @@ -56,8 +58,8 @@ class Piwik_API_DataTableManipulator_Flattener extends Piwik_API_DataTableManipu * Template method called from self::manipulate. * Flatten each data table. * - * @param Piwik_DataTable $dataTable - * @return Piwik_DataTable + * @param DataTable $dataTable + * @return DataTable */ protected function manipulateDataTable($dataTable) { @@ -73,12 +75,12 @@ class Piwik_API_DataTableManipulator_Flattener extends Piwik_API_DataTableManipu } /** - * @param Piwik_DataTable_Row $row - * @param Piwik_DataTable $dataTable + * @param Row $row + * @param DataTable $dataTable * @param string $labelPrefix * @param bool $parentLogo */ - private function flattenRow(Piwik_DataTable_Row $row, Piwik_DataTable $dataTable, + private function flattenRow(Row $row, DataTable $dataTable, $labelPrefix = '', $parentLogo = false) { $label = $row->getColumn('label'); diff --git a/core/API/DataTableManipulator/LabelFilter.php b/core/API/DataTableManipulator/LabelFilter.php index 550dbde69b..56ccd4366e 100644 --- a/core/API/DataTableManipulator/LabelFilter.php +++ b/core/API/DataTableManipulator/LabelFilter.php @@ -9,6 +9,8 @@ * @package Piwik */ use Piwik\Common; +use Piwik\DataTable; +use Piwik\DataTable\Row; /** * This class is responsible for handling the label parameter that can be @@ -38,10 +40,10 @@ class Piwik_API_DataTableManipulator_LabelFilter extends Piwik_API_DataTableMani * are not needed. * * @param string $labels the labels to search for - * @param Piwik_DataTable $dataTable the data table to be filtered + * @param DataTable $dataTable the data table to be filtered * @param bool $addLabelIndex Whether to add label_index metadata describing which * label a row corresponds to. - * @return Piwik_DataTable + * @return DataTable */ public function filter($labels, $dataTable, $addLabelIndex = false) { @@ -58,8 +60,8 @@ class Piwik_API_DataTableManipulator_LabelFilter extends Piwik_API_DataTableMani * Method for the recursive descend * * @param array $labelParts - * @param Piwik_DataTable $dataTable - * @return Piwik_DataTable_Row|false + * @param DataTable $dataTable + * @return Row|false */ private function doFilterRecursiveDescend($labelParts, $dataTable) { @@ -137,7 +139,7 @@ class Piwik_API_DataTableManipulator_LabelFilter extends Piwik_API_DataTableMani } /** - * Filter a Piwik_DataTable instance. See @filter for more info. + * Filter a DataTable instance. See @filter for more info. */ protected function manipulateDataTable($dataTable) { diff --git a/core/API/DocumentationGenerator.php b/core/API/DocumentationGenerator.php index 19150ce1da..e928409dfa 100644 --- a/core/API/DocumentationGenerator.php +++ b/core/API/DocumentationGenerator.php @@ -25,7 +25,7 @@ class Piwik_API_DocumentationGenerator */ public function __construct() { - $plugins = PluginsManager::getInstance()->getLoadedPluginsName(); + $plugins = \Piwik\PluginsManager::getInstance()->getLoadedPluginsName(); foreach ($plugins as $plugin) { $plugin = Common::unprefixClass($plugin); try { diff --git a/core/API/Request.php b/core/API/Request.php index 4af8db7500..7a7569e59c 100644 --- a/core/API/Request.php +++ b/core/API/Request.php @@ -11,6 +11,7 @@ use Piwik\Piwik; use Piwik\Common; use Piwik\Access; +use Piwik\DataTable; /** * An API request is the object used to make a call to the API and get the result. @@ -121,7 +122,7 @@ class Piwik_API_Request * It then calls the API Proxy which will call the requested method. * * @throws Piwik_FrontController_PluginDeactivatedException - * @return Piwik_DataTable|mixed The data resulting from the API call + * @return DataTable|mixed The data resulting from the API call */ public function process() { @@ -137,7 +138,7 @@ class Piwik_API_Request list($module, $method) = $this->extractModuleAndMethod($moduleMethod); - if (!PluginsManager::getInstance()->isPluginActivated($module)) { + if (!\Piwik\PluginsManager::getInstance()->isPluginActivated($module)) { throw new Piwik_FrontController_PluginDeactivatedException($module); } $moduleClass = "Piwik_" . $module . "_API"; diff --git a/core/API/ResponseBuilder.php b/core/API/ResponseBuilder.php index 8040721329..c9bc6eec91 100644 --- a/core/API/ResponseBuilder.php +++ b/core/API/ResponseBuilder.php @@ -8,8 +8,12 @@ * @category Piwik * @package Piwik */ +use Piwik\DataTable\Renderer\Json; +use Piwik\DataTable\Simple; +use Piwik\DataTable\Renderer; use Piwik\Piwik; use Piwik\Common; +use Piwik\DataTable; /** * @package Piwik @@ -38,7 +42,7 @@ class Piwik_API_ResponseBuilder /** * This method processes the data resulting from the API call. * - * - If the data resulted from the API call is a Piwik_DataTable then + * - If the data resulted from the API call is a DataTable then * - we apply the standard filters if the parameters have been found * in the URL. For example to offset,limit the Table you can add the following parameters to any API * call that returns a DataTable: filter_limit=10&filter_offset=20 @@ -75,8 +79,8 @@ class Piwik_API_ResponseBuilder // If the returned value is an object DataTable we // apply the set of generic filters if asked in the URL // and we render the DataTable according to the format specified in the URL - if ($value instanceof Piwik_DataTable - || $value instanceof Piwik_DataTable_Array + if ($value instanceof DataTable + || $value instanceof DataTable\Map ) { return $this->handleDataTable($value); } @@ -121,7 +125,7 @@ class Piwik_API_ResponseBuilder } try { - $renderer = Piwik_DataTable_Renderer::factory($format); + $renderer = Renderer::factory($format); } catch (Exception $exceptionRenderer) { return "Error: " . $e->getMessage() . " and: " . $exceptionRenderer->getMessage(); } @@ -174,7 +178,7 @@ class Piwik_API_ResponseBuilder /** * Apply the specified renderer to the DataTable * - * @param Piwik_DataTable|array $dataTable + * @param DataTable|array $dataTable * @return string */ protected function getRenderedDataTable($dataTable) @@ -192,7 +196,7 @@ class Piwik_API_ResponseBuilder $method = Common::getRequestVar('method', '', 'string', $this->request); - $renderer = Piwik_DataTable_Renderer::factory($format); + $renderer = Renderer::factory($format); $renderer->setTable($dataTable); $renderer->setRenderSubTables(Common::getRequestVar('expanded', false, 'int', $this->request)); $renderer->setHideIdSubDatableFromResponse(Common::getRequestVar('hideIdSubDatable', false, 'int', $this->request)); @@ -268,7 +272,7 @@ class Piwik_API_ResponseBuilder */ protected function handleScalar($scalar) { - $dataTable = new Piwik_DataTable_Simple(); + $dataTable = new Simple(); $dataTable->addRowsFromArray(array($scalar)); return $this->getRenderedDataTable($dataTable); } @@ -276,7 +280,7 @@ class Piwik_API_ResponseBuilder /** * Handles the given data table * - * @param Piwik_DataTable $datatable + * @param DataTable $datatable * @return string */ protected function handleDataTable($datatable) @@ -404,10 +408,10 @@ class Piwik_API_ResponseBuilder /** * Render a multidimensional array to Json - * Handle Piwik_DataTable|Piwik_DataTable_Array elements in the first dimension only, following case does not work: + * Handle DataTable|Set elements in the first dimension only, following case does not work: * array( * array( - * Piwik_DataTable, + * DataTable, * 2 => array( * 1, * 2 @@ -415,7 +419,7 @@ class Piwik_API_ResponseBuilder * ), * ); * - * @param array $array can contain scalar, arrays, Piwik_DataTable and Piwik_DataTable_Array + * @param array $array can contain scalar, arrays, DataTable and Set * @return string */ public static function convertMultiDimensionalArrayToJson($array) @@ -440,10 +444,10 @@ class Piwik_API_ResponseBuilder $json .= Common::json_encode($value); break; - // Case dimension is a Piwik_DataTable_Array or a Piwik_DataTable - case ($value instanceof Piwik_DataTable_Array || $value instanceof Piwik_DataTable): + // Case dimension is a Set or a DataTable + case ($value instanceof DataTable\Map || $value instanceof DataTable): - $XMLRenderer = new Piwik_DataTable_Renderer_Json(); + $XMLRenderer = new Json(); $XMLRenderer->setTable($value); $renderedReport = $XMLRenderer->render(); $json .= $renderedReport; |