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/DataTable/Renderer/Php.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/DataTable/Renderer/Php.php')
-rw-r--r--core/DataTable/Renderer/Php.php494
1 files changed, 233 insertions, 261 deletions
diff --git a/core/DataTable/Renderer/Php.php b/core/DataTable/Renderer/Php.php
index f0570ae3f6..9c671c1201 100644
--- a/core/DataTable/Renderer/Php.php
+++ b/core/DataTable/Renderer/Php.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
*/
@@ -14,283 +14,255 @@
* You can specify in the constructor if you want the serialized version.
* Please note that by default it will produce a flat version of the array.
* See the method flatRender() for details. @see flatRender();
- *
+ *
* Works with recursive DataTable (when a row can be associated with a subDataTable).
- *
+ *
* @package Piwik
* @subpackage Piwik_DataTable
*/
class Piwik_DataTable_Renderer_Php extends Piwik_DataTable_Renderer
{
- protected $prettyDisplay = false;
- protected $serialize = true;
+ protected $prettyDisplay = false;
+ protected $serialize = true;
- /**
- * Enables/Disables serialize
- *
- * @param bool $bool
- */
- public function setSerialize( $bool )
- {
- $this->serialize = (bool)$bool;
- }
+ /**
+ * Enables/Disables serialize
+ *
+ * @param bool $bool
+ */
+ public function setSerialize($bool)
+ {
+ $this->serialize = (bool)$bool;
+ }
- /**
- * Enables/Disables pretty display
- *
- * @param bool $bool
- */
- public function setPrettyDisplay($bool)
- {
- $this->prettyDisplay = (bool)$bool;
- }
+ /**
+ * Enables/Disables pretty display
+ *
+ * @param bool $bool
+ */
+ public function setPrettyDisplay($bool)
+ {
+ $this->prettyDisplay = (bool)$bool;
+ }
- /**
- * Converts current data table to string
- *
- * @return string
- */
- public function __toString()
- {
- $data = $this->render();
- if(!is_string($data))
- {
- $data = serialize($data);
- }
- return $data;
- }
+ /**
+ * Converts current data table to string
+ *
+ * @return string
+ */
+ public function __toString()
+ {
+ $data = $this->render();
+ if (!is_string($data)) {
+ $data = serialize($data);
+ }
+ return $data;
+ }
- /**
- * Computes the dataTable output and returns the string/binary
- *
- * @param null|Piwik_DataTable_Array|Piwik_DataTable_Simple $dataTable
- * @return string
- */
- public function render( $dataTable = null )
- {
- $this->renderHeader();
+ /**
+ * Computes the dataTable output and returns the string/binary
+ *
+ * @param null|Piwik_DataTable_Array|Piwik_DataTable_Simple $dataTable
+ * @return string
+ */
+ public function render($dataTable = null)
+ {
+ $this->renderHeader();
- if(is_null($dataTable))
- {
- $dataTable = $this->table;
- }
- $toReturn = $this->flatRender( $dataTable );
-
- if( $this->prettyDisplay )
- {
- if(!is_array($toReturn))
- {
- $toReturn = unserialize($toReturn);
- }
- $toReturn = "<pre>" . var_export($toReturn, true ) . "</pre>";
- }
- return $toReturn;
- }
+ if (is_null($dataTable)) {
+ $dataTable = $this->table;
+ }
+ $toReturn = $this->flatRender($dataTable);
- /**
- * Computes the exception output and returns the string/binary
- *
- * @return string
- */
- function renderException()
- {
- $this->renderHeader();
+ if ($this->prettyDisplay) {
+ if (!is_array($toReturn)) {
+ $toReturn = unserialize($toReturn);
+ }
+ $toReturn = "<pre>" . var_export($toReturn, true) . "</pre>";
+ }
+ return $toReturn;
+ }
- $exceptionMessage = $this->getExceptionMessage();
-
- $return = array('result' => 'error', 'message' => $exceptionMessage);
-
- if($this->serialize)
- {
- $return = serialize($return);
- }
-
- return $return;
- }
+ /**
+ * Computes the exception output and returns the string/binary
+ *
+ * @return string
+ */
+ function renderException()
+ {
+ $this->renderHeader();
- /**
- * Produces a flat php array from the DataTable, putting "columns" and "metadata" on the same level.
- *
- * For example, when a originalRender() would be
- * array( 'columns' => array( 'col1_name' => value1, 'col2_name' => value2 ),
- * 'metadata' => array( 'metadata1_name' => value_metadata) )
- *
- * a flatRender() is
- * array( 'col1_name' => value1,
- * 'col2_name' => value2,
- * 'metadata1_name' => value_metadata )
- *
- * @param null|Piwik_DataTable_Array|Piwik_DataTable_Simple $dataTable
- * @return array Php array representing the 'flat' version of the datatable
- */
- public function flatRender( $dataTable = null )
- {
- if(is_null($dataTable))
- {
- $dataTable = $this->table;
- }
-
- if (is_array($dataTable))
- {
- $flatArray = $dataTable;
- if (self::shouldWrapArrayBeforeRendering($flatArray))
- {
- $flatArray = array($flatArray);
- }
- }
- else if ($dataTable instanceof Piwik_DataTable_Array)
- {
- $flatArray = array();
- foreach($dataTable->getArray() as $keyName => $table)
- {
- $serializeSave = $this->serialize;
- $this->serialize = false;
- $flatArray[$keyName] = $this->flatRender($table);
- $this->serialize = $serializeSave;
- }
- }
- else if($dataTable instanceof Piwik_DataTable_Simple)
- {
- $flatArray = $this->renderSimpleTable($dataTable);
-
- // if we return only one numeric value then we print out the result in a simple <result> tag
- // keep it simple!
- if(count($flatArray) == 1)
- {
- $flatArray = current($flatArray);
- }
-
- }
- // A normal DataTable needs to be handled specifically
- else
- {
- $array = $this->renderTable($dataTable);
- $flatArray = $this->flattenArray($array);
- }
-
- if($this->serialize)
- {
- $flatArray = serialize($flatArray);
- }
-
- return $flatArray;
- }
+ $exceptionMessage = $this->getExceptionMessage();
- /**
- *
- * @param array $array
- * @return array
- */
- protected function flattenArray($array)
- {
- $flatArray = array();
- foreach($array as $row)
- {
- $newRow = $row['columns'] + $row['metadata'];
- if(isset($row['idsubdatatable'])
- && $this->hideIdSubDatatable === false)
- {
- $newRow += array('idsubdatatable' => $row['idsubdatatable']);
- }
- if(isset($row['subtable']))
- {
- $newRow += array('subtable' => $this->flattenArray($row['subtable']) );
- }
- $flatArray[] = $newRow;
- }
- return $flatArray;
- }
+ $return = array('result' => 'error', 'message' => $exceptionMessage);
- /**
- * Converts the current data table to an array
- *
- * @return array
- * @throws Exception
- */
- public function originalRender()
- {
- Piwik::checkObjectTypeIs($this->table, array('Piwik_DataTable_Simple', 'Piwik_DataTable'));
-
- if($this->table instanceof Piwik_DataTable_Simple)
- {
- $array = $this->renderSimpleTable($this->table);
- }
- elseif($this->table instanceof Piwik_DataTable)
- {
- $array = $this->renderTable($this->table);
- }
-
- if($this->serialize)
- {
- $array = serialize($array);
- }
- return $array;
- }
+ if ($this->serialize) {
+ $return = serialize($return);
+ }
- /**
- * Converts the given data table to an array
- *
- * @param Piwik_DataTable $table
- * @return array
- */
- protected function renderTable($table)
- {
- $array = array();
+ return $return;
+ }
- foreach($table->getRows() as $id => $row)
- {
- $newRow = array(
- 'columns' => $row->getColumns(),
- 'metadata' => $row->getMetadata(),
- 'idsubdatatable' => $row->getIdSubDataTable(),
- );
-
- if ($id == Piwik_DataTable::ID_SUMMARY_ROW)
- {
- $newRow['issummaryrow'] = true;
- }
-
- if($this->isRenderSubtables()
- && $row->isSubtableLoaded() )
- {
- $subTable = $this->renderTable( Piwik_DataTable_Manager::getInstance()->getTable($row->getIdSubDataTable()));
- $newRow['subtable'] = $subTable;
- if($this->hideIdSubDatatable === false
- && isset($newRow['metadata']['idsubdatatable_in_db']))
- {
- $newRow['columns']['idsubdatatable'] = $newRow['metadata']['idsubdatatable_in_db'];
- }
- unset($newRow['metadata']['idsubdatatable_in_db']);
- }
- if($this->hideIdSubDatatable !== false)
- {
- unset($newRow['idsubdatatable']);
- }
-
- $array[] = $newRow;
- }
- return $array;
- }
+ /**
+ * Produces a flat php array from the DataTable, putting "columns" and "metadata" on the same level.
+ *
+ * For example, when a originalRender() would be
+ * array( 'columns' => array( 'col1_name' => value1, 'col2_name' => value2 ),
+ * 'metadata' => array( 'metadata1_name' => value_metadata) )
+ *
+ * a flatRender() is
+ * array( 'col1_name' => value1,
+ * 'col2_name' => value2,
+ * 'metadata1_name' => value_metadata )
+ *
+ * @param null|Piwik_DataTable_Array|Piwik_DataTable_Simple $dataTable
+ * @return array Php array representing the 'flat' version of the datatable
+ */
+ public function flatRender($dataTable = null)
+ {
+ if (is_null($dataTable)) {
+ $dataTable = $this->table;
+ }
- /**
- * Converts the simple data table to an array
- *
- * @param Piwik_DataTable_Simple $table
- * @return array
- */
- protected function renderSimpleTable($table)
- {
- $array = array();
+ if (is_array($dataTable)) {
+ $flatArray = $dataTable;
+ if (self::shouldWrapArrayBeforeRendering($flatArray)) {
+ $flatArray = array($flatArray);
+ }
+ } else if ($dataTable instanceof Piwik_DataTable_Array) {
+ $flatArray = array();
+ foreach ($dataTable->getArray() as $keyName => $table) {
+ $serializeSave = $this->serialize;
+ $this->serialize = false;
+ $flatArray[$keyName] = $this->flatRender($table);
+ $this->serialize = $serializeSave;
+ }
+ } else if ($dataTable instanceof Piwik_DataTable_Simple) {
+ $flatArray = $this->renderSimpleTable($dataTable);
- $row = $table->getFirstRow();
- if($row === false)
- {
- return $array;
- }
- foreach($row->getColumns() as $columnName => $columnValue)
- {
- $array[$columnName] = $columnValue;
- }
- return $array;
- }
+ // if we return only one numeric value then we print out the result in a simple <result> tag
+ // keep it simple!
+ if (count($flatArray) == 1) {
+ $flatArray = current($flatArray);
+ }
+
+ } // A normal DataTable needs to be handled specifically
+ else {
+ $array = $this->renderTable($dataTable);
+ $flatArray = $this->flattenArray($array);
+ }
+
+ if ($this->serialize) {
+ $flatArray = serialize($flatArray);
+ }
+
+ return $flatArray;
+ }
+
+ /**
+ *
+ * @param array $array
+ * @return array
+ */
+ protected function flattenArray($array)
+ {
+ $flatArray = array();
+ foreach ($array as $row) {
+ $newRow = $row['columns'] + $row['metadata'];
+ if (isset($row['idsubdatatable'])
+ && $this->hideIdSubDatatable === false
+ ) {
+ $newRow += array('idsubdatatable' => $row['idsubdatatable']);
+ }
+ if (isset($row['subtable'])) {
+ $newRow += array('subtable' => $this->flattenArray($row['subtable']));
+ }
+ $flatArray[] = $newRow;
+ }
+ return $flatArray;
+ }
+
+ /**
+ * Converts the current data table to an array
+ *
+ * @return array
+ * @throws Exception
+ */
+ public function originalRender()
+ {
+ Piwik::checkObjectTypeIs($this->table, array('Piwik_DataTable_Simple', 'Piwik_DataTable'));
+
+ if ($this->table instanceof Piwik_DataTable_Simple) {
+ $array = $this->renderSimpleTable($this->table);
+ } elseif ($this->table instanceof Piwik_DataTable) {
+ $array = $this->renderTable($this->table);
+ }
+
+ if ($this->serialize) {
+ $array = serialize($array);
+ }
+ return $array;
+ }
+
+ /**
+ * Converts the given data table to an array
+ *
+ * @param Piwik_DataTable $table
+ * @return array
+ */
+ protected function renderTable($table)
+ {
+ $array = array();
+
+ foreach ($table->getRows() as $id => $row) {
+ $newRow = array(
+ 'columns' => $row->getColumns(),
+ 'metadata' => $row->getMetadata(),
+ 'idsubdatatable' => $row->getIdSubDataTable(),
+ );
+
+ if ($id == Piwik_DataTable::ID_SUMMARY_ROW) {
+ $newRow['issummaryrow'] = true;
+ }
+
+ if ($this->isRenderSubtables()
+ && $row->isSubtableLoaded()
+ ) {
+ $subTable = $this->renderTable(Piwik_DataTable_Manager::getInstance()->getTable($row->getIdSubDataTable()));
+ $newRow['subtable'] = $subTable;
+ if ($this->hideIdSubDatatable === false
+ && isset($newRow['metadata']['idsubdatatable_in_db'])
+ ) {
+ $newRow['columns']['idsubdatatable'] = $newRow['metadata']['idsubdatatable_in_db'];
+ }
+ unset($newRow['metadata']['idsubdatatable_in_db']);
+ }
+ if ($this->hideIdSubDatatable !== false) {
+ unset($newRow['idsubdatatable']);
+ }
+
+ $array[] = $newRow;
+ }
+ return $array;
+ }
+
+ /**
+ * Converts the simple data table to an array
+ *
+ * @param Piwik_DataTable_Simple $table
+ * @return array
+ */
+ protected function renderSimpleTable($table)
+ {
+ $array = array();
+
+ $row = $table->getFirstRow();
+ if ($row === false) {
+ return $array;
+ }
+ foreach ($row->getColumns() as $columnName => $columnValue) {
+ $array[$columnName] = $columnValue;
+ }
+ return $array;
+ }
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-22 04:59:06 +0300