Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/core/API/DataTableManipulator.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/API/DataTableManipulator.php')
-rw-r--r--core/API/DataTableManipulator.php281
1 files changed, 135 insertions, 146 deletions
diff --git a/core/API/DataTableManipulator.php b/core/API/DataTableManipulator.php
index b7f1f79a2e..dee8d80316 100644
--- a/core/API/DataTableManipulator.php
+++ b/core/API/DataTableManipulator.php
@@ -1,10 +1,10 @@
<?php
/**
* Piwik - Open source web analytics
- *
+ *
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
- *
+ *
* @category Piwik
* @package Piwik
*/
@@ -12,7 +12,7 @@
/**
* Base class for manipulating data tables.
* It provides generic mechanisms like iteration and loading subtables.
- *
+ *
* The manipulators are used in Piwik_API_ResponseBuilder and are triggered by
* API parameters. They are not filters because they don't work on the pre-
* fetched nested data tables. Instead, they load subtables using this base
@@ -20,156 +20,145 @@
* of using expanded=1. Another difference between manipulators and filters
* is that filters keep the overall structure of the table intact while
* manipulators can change the entire thing.
- *
+ *
* @package Piwik
* @subpackage Piwik_API
*/
abstract class Piwik_API_DataTableManipulator
{
- protected $apiModule;
- protected $apiMethod;
- protected $request;
-
- private $apiMethodForSubtable;
-
- /**
- * Constructor
- *
- * @param bool $apiModule
- * @param bool $apiMethod
- * @param array $request
- */
- public function __construct($apiModule=false, $apiMethod=false, $request=array()) {
- $this->apiModule = $apiModule;
- $this->apiMethod = $apiMethod;
- $this->request = $request;
- }
-
- /**
- * This method can be used by subclasses to iterate over data tables that might be
- * 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
- * @throws Exception
- * @return Piwik_DataTable_Array|Piwik_DataTable
- */
- protected function manipulate($dataTable)
- {
- if ($dataTable instanceof Piwik_DataTable_Array)
- {
- return $this->manipulateDataTableArray($dataTable);
- }
- else if ($dataTable instanceof Piwik_DataTable)
- {
- return $this->manipulateDataTable($dataTable);
- }
- else
- {
- return $dataTable;
- }
- }
-
- /**
- * Manipulates child DataTables of a DataTable_Array. See @manipulate for more info.
- */
- protected function manipulateDataTableArray( $dataTable )
- {
- $result = $dataTable->getEmptyClone();
- foreach ($dataTable->getArray() as $tableLabel => $childTable)
- {
- $newTable = $this->manipulate($childTable);
- $result->addTable($newTable, $tableLabel);
- }
- return $result;
- }
-
- /**
- * Manipulates a single Piwik_DataTable instance. Derived classes must define
- * this function.
- */
- protected abstract function manipulateDataTable( $dataTable );
-
- /**
- * Load the subtable for a row.
- * Returns null if none is found.
- *
- * @param Piwik_Datatable_Row $row
- * @throws Exception
- * @return Piwik_DataTable
- */
- protected function loadSubtable($dataTable, $row) {
- if (!($this->apiModule && $this->apiMethod && count($this->request))) {
- return null;
- }
-
- $request = $this->request;
-
+ protected $apiModule;
+ protected $apiMethod;
+ protected $request;
+
+ private $apiMethodForSubtable;
+
+ /**
+ * Constructor
+ *
+ * @param bool $apiModule
+ * @param bool $apiMethod
+ * @param array $request
+ */
+ public function __construct($apiModule = false, $apiMethod = false, $request = array())
+ {
+ $this->apiModule = $apiModule;
+ $this->apiMethod = $apiMethod;
+ $this->request = $request;
+ }
+
+ /**
+ * This method can be used by subclasses to iterate over data tables that might be
+ * 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
+ * @throws Exception
+ * @return Piwik_DataTable_Array|Piwik_DataTable
+ */
+ protected function manipulate($dataTable)
+ {
+ if ($dataTable instanceof Piwik_DataTable_Array) {
+ return $this->manipulateDataTableArray($dataTable);
+ } else if ($dataTable instanceof Piwik_DataTable) {
+ return $this->manipulateDataTable($dataTable);
+ } else {
+ return $dataTable;
+ }
+ }
+
+ /**
+ * Manipulates child DataTables of a DataTable_Array. See @manipulate for more info.
+ */
+ protected function manipulateDataTableArray($dataTable)
+ {
+ $result = $dataTable->getEmptyClone();
+ foreach ($dataTable->getArray() as $tableLabel => $childTable) {
+ $newTable = $this->manipulate($childTable);
+ $result->addTable($newTable, $tableLabel);
+ }
+ return $result;
+ }
+
+ /**
+ * Manipulates a single Piwik_DataTable instance. Derived classes must define
+ * this function.
+ */
+ protected abstract function manipulateDataTable($dataTable);
+
+ /**
+ * Load the subtable for a row.
+ * Returns null if none is found.
+ *
+ * @param Piwik_Datatable_Row $row
+ * @throws Exception
+ * @return Piwik_DataTable
+ */
+ protected function loadSubtable($dataTable, $row)
+ {
+ if (!($this->apiModule && $this->apiMethod && count($this->request))) {
+ return null;
+ }
+
+ $request = $this->request;
+
$idSubTable = $row->getIdSubDataTable();
- if ($idSubTable === null)
- {
- return null;
- }
-
- $request['idSubtable'] = $idSubTable;
- if ($dataTable)
- {
- $request['date'] = $dataTable->metadata['period']->getDateStart()->toString();
- }
-
- $class = 'Piwik_'.$this->apiModule.'_API';
+ if ($idSubTable === null) {
+ return null;
+ }
+
+ $request['idSubtable'] = $idSubTable;
+ if ($dataTable) {
+ $request['date'] = $dataTable->metadata['period']->getDateStart()->toString();
+ }
+
+ $class = 'Piwik_' . $this->apiModule . '_API';
$method = $this->getApiMethodForSubtable();
-
+
$this->manipulateSubtableRequest($request);
$request['serialize'] = 0;
- $request['expanded'] = 0;
-
- // don't want to run recursive filters on the subtables as they are loaded,
- // otherwise the result will be empty in places (or everywhere). instead we
- // run it on the flattened table.
- unset($request['filter_pattern_recursive']);
-
- $dataTable = Piwik_API_Proxy::getInstance()->call($class, $method, $request);
- $response = new Piwik_API_ResponseBuilder($format = 'original', $request);
- $dataTable = $response->getResponse($dataTable);
- if (method_exists($dataTable, 'applyQueuedFilters'))
- {
- $dataTable->applyQueuedFilters();
- }
-
- return $dataTable;
- }
-
- /**
- * In this method, subclasses can clean up the request array for loading subtables
- * in order to make Piwik_API_ResponseBuilder behave correctly (e.g. not trigger the
- * manipulator again).
- *
- * @param $request
- * @return
- */
- protected abstract function manipulateSubtableRequest(&$request);
-
- /**
- * Extract the API method for loading subtables from the meta data
- *
- * @return string
- */
- private function getApiMethodForSubtable()
- {
- if (!$this->apiMethodForSubtable)
- {
- $meta = Piwik_API_API::getInstance()->getMetadata('all', $this->apiModule, $this->apiMethod);
- if (isset($meta[0]['actionToLoadSubTables']))
- {
- $this->apiMethodForSubtable = $meta[0]['actionToLoadSubTables'];
- }
- else
- {
- $this->apiMethodForSubtable = $this->apiMethod;
- }
- }
- return $this->apiMethodForSubtable;
- }
-
+ $request['expanded'] = 0;
+
+ // don't want to run recursive filters on the subtables as they are loaded,
+ // otherwise the result will be empty in places (or everywhere). instead we
+ // run it on the flattened table.
+ unset($request['filter_pattern_recursive']);
+
+ $dataTable = Piwik_API_Proxy::getInstance()->call($class, $method, $request);
+ $response = new Piwik_API_ResponseBuilder($format = 'original', $request);
+ $dataTable = $response->getResponse($dataTable);
+ if (method_exists($dataTable, 'applyQueuedFilters')) {
+ $dataTable->applyQueuedFilters();
+ }
+
+ return $dataTable;
+ }
+
+ /**
+ * In this method, subclasses can clean up the request array for loading subtables
+ * in order to make Piwik_API_ResponseBuilder behave correctly (e.g. not trigger the
+ * manipulator again).
+ *
+ * @param $request
+ * @return
+ */
+ protected abstract function manipulateSubtableRequest(&$request);
+
+ /**
+ * Extract the API method for loading subtables from the meta data
+ *
+ * @return string
+ */
+ private function getApiMethodForSubtable()
+ {
+ if (!$this->apiMethodForSubtable) {
+ $meta = Piwik_API_API::getInstance()->getMetadata('all', $this->apiModule, $this->apiMethod);
+ if (isset($meta[0]['actionToLoadSubTables'])) {
+ $this->apiMethodForSubtable = $meta[0]['actionToLoadSubTables'];
+ } else {
+ $this->apiMethodForSubtable = $this->apiMethod;
+ }
+ }
+ return $this->apiMethodForSubtable;
+ }
+
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-22 03:52:00 +0300