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/ResponseBuilder.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/API/ResponseBuilder.php')
-rw-r--r--core/API/ResponseBuilder.php927
1 files changed, 442 insertions, 485 deletions
diff --git a/core/API/ResponseBuilder.php b/core/API/ResponseBuilder.php
index 07df53ce7e..6830e34c0e 100644
--- a/core/API/ResponseBuilder.php
+++ b/core/API/ResponseBuilder.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
*/
@@ -15,495 +15,452 @@
*/
class Piwik_API_ResponseBuilder
{
- private $request = null;
- private $outputFormat = null;
-
+ private $request = null;
+ private $outputFormat = null;
+
private $apiModule = false;
private $apiMethod = false;
- /**
- * @param string $outputFormat
- * @param array $request
- */
- public function __construct($outputFormat, $request = array())
- {
- $this->request = $request;
- $this->outputFormat = $outputFormat;
- }
-
- /**
- * This method processes the data resulting from the API call.
- *
- * - If the data resulted from the API call is a Piwik_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
- * - we apply the filters that have been previously queued on the DataTable
- * @see Piwik_DataTable::queueFilter()
- * - we apply the renderer that generate the DataTable in a given format (XML, PHP, HTML, JSON, etc.)
- * the format can be changed using the 'format' parameter in the request.
- * Example: format=xml
- *
- * - If there is nothing returned (void) we display a standard success message
- *
- * - If there is a PHP array returned, we try to convert it to a dataTable
- * It is then possible to convert this datatable to any requested format (xml/etc)
- *
- * - If a bool is returned we convert to a string (true is displayed as 'true' false as 'false')
- *
- * - If an integer / float is returned, we simply return it
- *
- * @param mixed $value The initial returned value, before post process. If set to null, success response is returned.
- * @param bool|string $apiModule The API module that was called
- * @param bool|string $apiMethod The API method that was called
- * @return mixed Usually a string, but can still be a PHP data structure if the format requested is 'original'
- */
- public function getResponse($value = null, $apiModule = false, $apiMethod = false)
- {
+ /**
+ * @param string $outputFormat
+ * @param array $request
+ */
+ public function __construct($outputFormat, $request = array())
+ {
+ $this->request = $request;
+ $this->outputFormat = $outputFormat;
+ }
+
+ /**
+ * This method processes the data resulting from the API call.
+ *
+ * - If the data resulted from the API call is a Piwik_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
+ * - we apply the filters that have been previously queued on the DataTable
+ * @see Piwik_DataTable::queueFilter()
+ * - we apply the renderer that generate the DataTable in a given format (XML, PHP, HTML, JSON, etc.)
+ * the format can be changed using the 'format' parameter in the request.
+ * Example: format=xml
+ *
+ * - If there is nothing returned (void) we display a standard success message
+ *
+ * - If there is a PHP array returned, we try to convert it to a dataTable
+ * It is then possible to convert this datatable to any requested format (xml/etc)
+ *
+ * - If a bool is returned we convert to a string (true is displayed as 'true' false as 'false')
+ *
+ * - If an integer / float is returned, we simply return it
+ *
+ * @param mixed $value The initial returned value, before post process. If set to null, success response is returned.
+ * @param bool|string $apiModule The API module that was called
+ * @param bool|string $apiMethod The API method that was called
+ * @return mixed Usually a string, but can still be a PHP data structure if the format requested is 'original'
+ */
+ public function getResponse($value = null, $apiModule = false, $apiMethod = false)
+ {
$this->apiModule = $apiModule;
$this->apiMethod = $apiMethod;
-
- // when null or void is returned from the api call, we handle it as a successful operation
- if(!isset($value))
- {
- return $this->handleSuccess();
- }
-
- // 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)
- {
- return $this->handleDataTable($value);
- }
-
- // Case an array is returned from the API call, we convert it to the requested format
- // - if calling from inside the application (format = original)
- // => the data stays unchanged (ie. a standard php array or whatever data structure)
- // - if any other format is requested, we have to convert this data structure (which we assume
- // to be an array) to a DataTable in order to apply the requested DataTable_Renderer (for example XML)
- if(is_array($value))
- {
- return $this->handleArray($value);
- }
-
- // original data structure requested, we return without process
- if( $this->outputFormat == 'original' )
- {
- return $value;
- }
-
- if( is_object($value)
- || is_resource($value))
- {
- return $this->getResponseException(new Exception('The API cannot handle this data structure.'));
- }
-
- // bool // integer // float // serialized object
- return $this->handleScalar($value);
- }
-
- /**
- * Returns an error $message in the requested $format
- *
- * @param Exception $e
- * @throws Exception
- * @return string
- */
- public function getResponseException(Exception $e)
- {
- $format = strtolower($this->outputFormat);
-
- if( $format == 'original' )
- {
- throw $e;
- }
-
- try {
- $renderer = Piwik_DataTable_Renderer::factory($format);
- } catch (Exception $exceptionRenderer) {
- return "Error: " . $e->getMessage() . " and: " . $exceptionRenderer->getMessage();
- }
-
- $renderer->setException($e);
-
- if($format == 'php')
- {
- $renderer->setSerialize($this->caseRendererPHPSerialize());
- }
-
- return $renderer->renderException();
- }
-
- /**
- * Returns true if the user requested to serialize the output data (&serialize=1 in the request)
- *
- * @param mixed $defaultSerializeValue Default value in case the user hasn't specified a value
- * @return bool
- */
- protected function caseRendererPHPSerialize($defaultSerializeValue = 1)
- {
- $serialize = Piwik_Common::getRequestVar('serialize', $defaultSerializeValue, 'int', $this->request);
- if($serialize)
- {
- return true;
- }
- return false;
- }
-
- /**
- * Apply the specified renderer to the DataTable
- *
- * @param Piwik_DataTable|array $dataTable
- * @return string
- */
- protected function getRenderedDataTable($dataTable)
- {
- $format = strtolower($this->outputFormat);
-
- // if asked for original dataStructure
- if($format == 'original')
- {
- // by default "original" data is not serialized
- if($this->caseRendererPHPSerialize( $defaultSerialize = 0))
- {
- $dataTable = serialize($dataTable);
- }
- return $dataTable;
- }
-
- $method = Piwik_Common::getRequestVar('method', '', 'string', $this->request);
-
- $renderer = Piwik_DataTable_Renderer::factory($format);
- $renderer->setTable($dataTable);
- $renderer->setRenderSubTables(Piwik_Common::getRequestVar('expanded', false, 'int', $this->request));
- $renderer->setHideIdSubDatableFromResponse(Piwik_Common::getRequestVar('hideIdSubDatable', false, 'int', $this->request));
-
- if($format == 'php')
- {
- $renderer->setSerialize($this->caseRendererPHPSerialize());
- $renderer->setPrettyDisplay(Piwik_Common::getRequestVar('prettyDisplay', false, 'int', $this->request));
- }
- else if($format == 'html')
- {
- $renderer->setTableId($this->request['method']);
- }
- else if($format == 'csv' || $format == 'tsv')
- {
- $renderer->setConvertToUnicode(Piwik_Common::getRequestVar('convertToUnicode', true, 'int', $this->request));
- }
-
- // prepare translation of column names
- if ($format == 'html' || $format == 'csv' || $format == 'tsv' || $format = 'rss')
- {
- $renderer->setApiMethod($method);
- $renderer->setIdSite(Piwik_Common::getRequestVar('idSite', false, 'int', $this->request));
- $renderer->setTranslateColumnNames(Piwik_Common::getRequestVar('translateColumnNames', false, 'int', $this->request));
- }
-
- return $renderer->render();
- }
-
- /**
- * Returns a success $message in the requested $format
- *
- * @param string $message
- * @return string
- */
- protected function handleSuccess( $message = 'ok' )
- {
- // return a success message only if no content has already been buffered, useful when APIs return raw text or html content to the browser
- if(!ob_get_contents())
- {
- switch($this->outputFormat)
- {
- case 'xml':
- @header("Content-Type: text/xml;charset=utf-8");
- $return =
- "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n" .
- "<result>\n".
- "\t<success message=\"".$message."\" />\n".
- "</result>";
- break;
- case 'json':
- @header( "Content-Type: application/json" );
- $return = '{"result":"success", "message":"'.$message.'"}';
- break;
- case 'php':
- $return = array('result' => 'success', 'message' => $message);
- if($this->caseRendererPHPSerialize())
- {
- $return = serialize($return);
- }
- break;
-
- case 'csv':
- @header("Content-Type: application/vnd.ms-excel");
- @header("Content-Disposition: attachment; filename=piwik-report-export.csv");
- $return = "message\n".$message;
- break;
-
- default:
- $return = 'Success:'.$message;
- break;
- }
- return $return;
- }
- }
-
- /**
- * Converts the given scalar to an data table
- *
- * @param mixed $scalar
- * @return string
- */
- protected function handleScalar($scalar)
- {
- $dataTable = new Piwik_DataTable_Simple();
- $dataTable->addRowsFromArray( array($scalar) );
- return $this->getRenderedDataTable($dataTable);
- }
-
- /**
- * Handles the given data table
- *
- * @param Piwik_DataTable $datatable
- * @return string
- */
- protected function handleDataTable($datatable)
- {
- // if requested, flatten nested tables
- if (Piwik_Common::getRequestVar('flat', '0', 'string', $this->request) == '1')
- {
- $flattener = new Piwik_API_DataTableManipulator_Flattener($this->apiModule, $this->apiMethod, $this->request);
- if (Piwik_Common::getRequestVar('include_aggregate_rows', '0', 'string', $this->request) == '1')
- {
- $flattener->includeAggregateRows();
- }
- $datatable = $flattener->flatten($datatable);
- }
-
- // if the flag disable_generic_filters is defined we skip the generic filters
- if(0 == Piwik_Common::getRequestVar('disable_generic_filters', '0', 'string', $this->request))
- {
- $genericFilter = new Piwik_API_DataTableGenericFilter($this->request);
- $genericFilter->filter($datatable);
- }
-
- // we automatically safe decode all datatable labels (against xss)
- $datatable->queueFilter('SafeDecodeLabel');
-
- // if the flag disable_queued_filters is defined we skip the filters that were queued
- if(Piwik_Common::getRequestVar('disable_queued_filters', 'false', 'string', $this->request) == 'false')
- {
- $datatable->applyQueuedFilters();
- }
-
- // use the ColumnDelete filter if hideColumns/showColumns is provided (must be done
- // after queued filters are run so processed metrics can be removed, too)
- $hideColumns = Piwik_Common::getRequestVar('hideColumns', '', 'string', $this->request);
- $showColumns = Piwik_Common::getRequestVar('showColumns', '', 'string', $this->request);
- if ($hideColumns !== '' || $showColumns !== '')
- {
- $datatable->filter('ColumnDelete', array($hideColumns, $showColumns));
- }
-
- // apply label filter: only return rows matching the label parameter (more than one if more than one label)
- $label = $this->getLabelQueryParam();
- if (!empty($label))
- {
- $label = Piwik_Common::unsanitizeInputValues($label);
- $addEmptyRows = Piwik_Common::getRequestVar('labelFilterAddEmptyRows', 0, 'int', $this->request) == 1;
-
- $filter = new Piwik_API_DataTableManipulator_LabelFilter($this->apiModule, $this->apiMethod, $this->request);
- $datatable = $filter->filter($label, $datatable, $addEmptyRows);
- }
- return $this->getRenderedDataTable($datatable);
- }
-
- /**
- * Converts the given simple array to a data table
- *
- * @param array $array
- * @return string
- */
- protected function handleArray($array)
- {
- if($this->outputFormat == 'original')
- {
- // we handle the serialization. Because some php array have a very special structure that
- // couldn't be converted with the automatic DataTable->addRowsFromSimpleArray
- // the user may want to request the original PHP data structure serialized by the API
- // in case he has to setup serialize=1 in the URL
- if($this->caseRendererPHPSerialize( $defaultSerialize = 0))
- {
- return serialize($array);
- }
- return $array;
- }
- $multiDimensional = $this->handleMultiDimensionalArray($array);
- if($multiDimensional !== false)
- {
- return $multiDimensional;
- }
-
- return $this->getRenderedDataTable($array);
- }
-
- /**
- * Is this a multi dimensional array?
- * Multi dim arrays are not supported by the Datatable renderer.
- * We manually render these.
- *
- * array(
- * array(
- * 1,
- * 2 => array( 1,
- * 2
- * )
- * ),
- * array( 2,
- * 3
- * )
- * );
- *
- * @param array $array
- * @return string|bool false if it isn't a multidim array
- */
- protected function handleMultiDimensionalArray($array)
- {
- $first = reset($array);
- foreach($array as $first)
- {
- if(is_array($first))
- {
- foreach($first as $key => $value)
- {
- // Yes, this is a multi dim array
- if(is_array($value))
- {
- switch($this->outputFormat)
- {
- case 'json':
- @header( "Content-Type: application/json" );
- return self::convertMultiDimensionalArrayToJson($array);
- break;
-
- case 'php':
- if($this->caseRendererPHPSerialize( $defaultSerialize = 0))
- {
- return serialize($array);
- }
- return $array;
-
- case 'xml':
- @header("Content-Type: text/xml;charset=utf-8");
- return $this->getRenderedDataTable($array);
- default:
- break;
- }
- }
- }
- }
- }
- return false;
- }
-
- /**
- * Render a multidimensional array to Json
- * Handle Piwik_DataTable|Piwik_DataTable_Array elements in the first dimension only, following case does not work:
- * array(
- * array(
- * Piwik_DataTable,
- * 2 => array(
- * 1,
- * 2
- * ),
- * ),
- * );
- *
- * @param array $array can contain scalar, arrays, Piwik_DataTable and Piwik_DataTable_Array
- * @return string
- */
- public static function convertMultiDimensionalArrayToJson($array)
- {
- $isAssociative = Piwik::isAssociativeArray($array);
-
- if($isAssociative)
- {
- $json = "{";
- }
- else
- {
- $json = "[";
- }
-
- foreach ($array as $key=>$value)
- {
- if($isAssociative)
- {
- $json .= "\"".$key."\":";
- }
-
- switch(true)
- {
- // Case dimension is a PHP array
- case (is_array($value)):
-
- $json .= Piwik_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):
-
- $XMLRenderer = new Piwik_DataTable_Renderer_Json();
- $XMLRenderer->setTable($value);
- $renderedReport = $XMLRenderer->render();
- $json .= $renderedReport;
- break;
-
- // Case scalar
- default:
-
- $json .= Piwik_Common::json_encode($value);
- break;
- }
-
- $json .= ",";
- }
-
- // Remove trailing ","
- $json = substr ($json, 0, strlen($json) - 1);
-
- if($isAssociative)
- {
- $json .= "}";
- }
- else
- {
- $json .= "]";
- }
- return $json;
- }
-
- /**
- * Returns the value for the label query parameter which can be either a string
- * (ie, label=...) or array (ie, label[]=...).
- *
- * @return array
- */
- private function getLabelQueryParam()
- {
+
+ // when null or void is returned from the api call, we handle it as a successful operation
+ if (!isset($value)) {
+ return $this->handleSuccess();
+ }
+
+ // 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
+ ) {
+ return $this->handleDataTable($value);
+ }
+
+ // Case an array is returned from the API call, we convert it to the requested format
+ // - if calling from inside the application (format = original)
+ // => the data stays unchanged (ie. a standard php array or whatever data structure)
+ // - if any other format is requested, we have to convert this data structure (which we assume
+ // to be an array) to a DataTable in order to apply the requested DataTable_Renderer (for example XML)
+ if (is_array($value)) {
+ return $this->handleArray($value);
+ }
+
+ // original data structure requested, we return without process
+ if ($this->outputFormat == 'original') {
+ return $value;
+ }
+
+ if (is_object($value)
+ || is_resource($value)
+ ) {
+ return $this->getResponseException(new Exception('The API cannot handle this data structure.'));
+ }
+
+ // bool // integer // float // serialized object
+ return $this->handleScalar($value);
+ }
+
+ /**
+ * Returns an error $message in the requested $format
+ *
+ * @param Exception $e
+ * @throws Exception
+ * @return string
+ */
+ public function getResponseException(Exception $e)
+ {
+ $format = strtolower($this->outputFormat);
+
+ if ($format == 'original') {
+ throw $e;
+ }
+
+ try {
+ $renderer = Piwik_DataTable_Renderer::factory($format);
+ } catch (Exception $exceptionRenderer) {
+ return "Error: " . $e->getMessage() . " and: " . $exceptionRenderer->getMessage();
+ }
+
+ $renderer->setException($e);
+
+ if ($format == 'php') {
+ $renderer->setSerialize($this->caseRendererPHPSerialize());
+ }
+
+ return $renderer->renderException();
+ }
+
+ /**
+ * Returns true if the user requested to serialize the output data (&serialize=1 in the request)
+ *
+ * @param mixed $defaultSerializeValue Default value in case the user hasn't specified a value
+ * @return bool
+ */
+ protected function caseRendererPHPSerialize($defaultSerializeValue = 1)
+ {
+ $serialize = Piwik_Common::getRequestVar('serialize', $defaultSerializeValue, 'int', $this->request);
+ if ($serialize) {
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Apply the specified renderer to the DataTable
+ *
+ * @param Piwik_DataTable|array $dataTable
+ * @return string
+ */
+ protected function getRenderedDataTable($dataTable)
+ {
+ $format = strtolower($this->outputFormat);
+
+ // if asked for original dataStructure
+ if ($format == 'original') {
+ // by default "original" data is not serialized
+ if ($this->caseRendererPHPSerialize($defaultSerialize = 0)) {
+ $dataTable = serialize($dataTable);
+ }
+ return $dataTable;
+ }
+
+ $method = Piwik_Common::getRequestVar('method', '', 'string', $this->request);
+
+ $renderer = Piwik_DataTable_Renderer::factory($format);
+ $renderer->setTable($dataTable);
+ $renderer->setRenderSubTables(Piwik_Common::getRequestVar('expanded', false, 'int', $this->request));
+ $renderer->setHideIdSubDatableFromResponse(Piwik_Common::getRequestVar('hideIdSubDatable', false, 'int', $this->request));
+
+ if ($format == 'php') {
+ $renderer->setSerialize($this->caseRendererPHPSerialize());
+ $renderer->setPrettyDisplay(Piwik_Common::getRequestVar('prettyDisplay', false, 'int', $this->request));
+ } else if ($format == 'html') {
+ $renderer->setTableId($this->request['method']);
+ } else if ($format == 'csv' || $format == 'tsv') {
+ $renderer->setConvertToUnicode(Piwik_Common::getRequestVar('convertToUnicode', true, 'int', $this->request));
+ }
+
+ // prepare translation of column names
+ if ($format == 'html' || $format == 'csv' || $format == 'tsv' || $format = 'rss') {
+ $renderer->setApiMethod($method);
+ $renderer->setIdSite(Piwik_Common::getRequestVar('idSite', false, 'int', $this->request));
+ $renderer->setTranslateColumnNames(Piwik_Common::getRequestVar('translateColumnNames', false, 'int', $this->request));
+ }
+
+ return $renderer->render();
+ }
+
+ /**
+ * Returns a success $message in the requested $format
+ *
+ * @param string $message
+ * @return string
+ */
+ protected function handleSuccess($message = 'ok')
+ {
+ // return a success message only if no content has already been buffered, useful when APIs return raw text or html content to the browser
+ if (!ob_get_contents()) {
+ switch ($this->outputFormat) {
+ case 'xml':
+ @header("Content-Type: text/xml;charset=utf-8");
+ $return =
+ "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n" .
+ "<result>\n" .
+ "\t<success message=\"" . $message . "\" />\n" .
+ "</result>";
+ break;
+ case 'json':
+ @header("Content-Type: application/json");
+ $return = '{"result":"success", "message":"' . $message . '"}';
+ break;
+ case 'php':
+ $return = array('result' => 'success', 'message' => $message);
+ if ($this->caseRendererPHPSerialize()) {
+ $return = serialize($return);
+ }
+ break;
+
+ case 'csv':
+ @header("Content-Type: application/vnd.ms-excel");
+ @header("Content-Disposition: attachment; filename=piwik-report-export.csv");
+ $return = "message\n" . $message;
+ break;
+
+ default:
+ $return = 'Success:' . $message;
+ break;
+ }
+ return $return;
+ }
+ }
+
+ /**
+ * Converts the given scalar to an data table
+ *
+ * @param mixed $scalar
+ * @return string
+ */
+ protected function handleScalar($scalar)
+ {
+ $dataTable = new Piwik_DataTable_Simple();
+ $dataTable->addRowsFromArray(array($scalar));
+ return $this->getRenderedDataTable($dataTable);
+ }
+
+ /**
+ * Handles the given data table
+ *
+ * @param Piwik_DataTable $datatable
+ * @return string
+ */
+ protected function handleDataTable($datatable)
+ {
+ // if requested, flatten nested tables
+ if (Piwik_Common::getRequestVar('flat', '0', 'string', $this->request) == '1') {
+ $flattener = new Piwik_API_DataTableManipulator_Flattener($this->apiModule, $this->apiMethod, $this->request);
+ if (Piwik_Common::getRequestVar('include_aggregate_rows', '0', 'string', $this->request) == '1') {
+ $flattener->includeAggregateRows();
+ }
+ $datatable = $flattener->flatten($datatable);
+ }
+
+ // if the flag disable_generic_filters is defined we skip the generic filters
+ if (0 == Piwik_Common::getRequestVar('disable_generic_filters', '0', 'string', $this->request)) {
+ $genericFilter = new Piwik_API_DataTableGenericFilter($this->request);
+ $genericFilter->filter($datatable);
+ }
+
+ // we automatically safe decode all datatable labels (against xss)
+ $datatable->queueFilter('SafeDecodeLabel');
+
+ // if the flag disable_queued_filters is defined we skip the filters that were queued
+ if (Piwik_Common::getRequestVar('disable_queued_filters', 'false', 'string', $this->request) == 'false') {
+ $datatable->applyQueuedFilters();
+ }
+
+ // use the ColumnDelete filter if hideColumns/showColumns is provided (must be done
+ // after queued filters are run so processed metrics can be removed, too)
+ $hideColumns = Piwik_Common::getRequestVar('hideColumns', '', 'string', $this->request);
+ $showColumns = Piwik_Common::getRequestVar('showColumns', '', 'string', $this->request);
+ if ($hideColumns !== '' || $showColumns !== '') {
+ $datatable->filter('ColumnDelete', array($hideColumns, $showColumns));
+ }
+
+ // apply label filter: only return rows matching the label parameter (more than one if more than one label)
+ $label = $this->getLabelQueryParam();
+ if (!empty($label)) {
+ $label = Piwik_Common::unsanitizeInputValues($label);
+ $addEmptyRows = Piwik_Common::getRequestVar('labelFilterAddEmptyRows', 0, 'int', $this->request) == 1;
+
+ $filter = new Piwik_API_DataTableManipulator_LabelFilter($this->apiModule, $this->apiMethod, $this->request);
+ $datatable = $filter->filter($label, $datatable, $addEmptyRows);
+ }
+ return $this->getRenderedDataTable($datatable);
+ }
+
+ /**
+ * Converts the given simple array to a data table
+ *
+ * @param array $array
+ * @return string
+ */
+ protected function handleArray($array)
+ {
+ if ($this->outputFormat == 'original') {
+ // we handle the serialization. Because some php array have a very special structure that
+ // couldn't be converted with the automatic DataTable->addRowsFromSimpleArray
+ // the user may want to request the original PHP data structure serialized by the API
+ // in case he has to setup serialize=1 in the URL
+ if ($this->caseRendererPHPSerialize($defaultSerialize = 0)) {
+ return serialize($array);
+ }
+ return $array;
+ }
+ $multiDimensional = $this->handleMultiDimensionalArray($array);
+ if ($multiDimensional !== false) {
+ return $multiDimensional;
+ }
+
+ return $this->getRenderedDataTable($array);
+ }
+
+ /**
+ * Is this a multi dimensional array?
+ * Multi dim arrays are not supported by the Datatable renderer.
+ * We manually render these.
+ *
+ * array(
+ * array(
+ * 1,
+ * 2 => array( 1,
+ * 2
+ * )
+ * ),
+ * array( 2,
+ * 3
+ * )
+ * );
+ *
+ * @param array $array
+ * @return string|bool false if it isn't a multidim array
+ */
+ protected function handleMultiDimensionalArray($array)
+ {
+ $first = reset($array);
+ foreach ($array as $first) {
+ if (is_array($first)) {
+ foreach ($first as $key => $value) {
+ // Yes, this is a multi dim array
+ if (is_array($value)) {
+ switch ($this->outputFormat) {
+ case 'json':
+ @header("Content-Type: application/json");
+ return self::convertMultiDimensionalArrayToJson($array);
+ break;
+
+ case 'php':
+ if ($this->caseRendererPHPSerialize($defaultSerialize = 0)) {
+ return serialize($array);
+ }
+ return $array;
+
+ case 'xml':
+ @header("Content-Type: text/xml;charset=utf-8");
+ return $this->getRenderedDataTable($array);
+ default:
+ break;
+ }
+ }
+ }
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Render a multidimensional array to Json
+ * Handle Piwik_DataTable|Piwik_DataTable_Array elements in the first dimension only, following case does not work:
+ * array(
+ * array(
+ * Piwik_DataTable,
+ * 2 => array(
+ * 1,
+ * 2
+ * ),
+ * ),
+ * );
+ *
+ * @param array $array can contain scalar, arrays, Piwik_DataTable and Piwik_DataTable_Array
+ * @return string
+ */
+ public static function convertMultiDimensionalArrayToJson($array)
+ {
+ $isAssociative = Piwik::isAssociativeArray($array);
+
+ if ($isAssociative) {
+ $json = "{";
+ } else {
+ $json = "[";
+ }
+
+ foreach ($array as $key => $value) {
+ if ($isAssociative) {
+ $json .= "\"" . $key . "\":";
+ }
+
+ switch (true) {
+ // Case dimension is a PHP array
+ case (is_array($value)):
+
+ $json .= Piwik_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):
+
+ $XMLRenderer = new Piwik_DataTable_Renderer_Json();
+ $XMLRenderer->setTable($value);
+ $renderedReport = $XMLRenderer->render();
+ $json .= $renderedReport;
+ break;
+
+ // Case scalar
+ default:
+
+ $json .= Piwik_Common::json_encode($value);
+ break;
+ }
+
+ $json .= ",";
+ }
+
+ // Remove trailing ","
+ $json = substr($json, 0, strlen($json) - 1);
+
+ if ($isAssociative) {
+ $json .= "}";
+ } else {
+ $json .= "]";
+ }
+ return $json;
+ }
+
+ /**
+ * Returns the value for the label query parameter which can be either a string
+ * (ie, label=...) or array (ie, label[]=...).
+ *
+ * @return array
+ */
+ private function getLabelQueryParam()
+ {
$label = Piwik_Common::getRequestVar('label', array(), 'array', $this->request);
- if (empty($label))
- {
- $label = Piwik_Common::getRequestVar('label', '', 'string', $this->request);
- if (!empty($label))
- {
- $label = array($label);
- }
+ if (empty($label)) {
+ $label = Piwik_Common::getRequestVar('label', '', 'string', $this->request);
+ if (!empty($label)) {
+ $label = array($label);
+ }
}
return $label;
- }
+ }
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-06 11:04:58 +0300