core/DataTable/Simple.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

<?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
 */

/**
 * The DataTable_Simple is used to provide an easy way to create simple DataGrid.
 * A DataTable_Simple actually is a DataTable with 2 columns: 'label' and 'value'.
 *
 * It is usually best to return a DataTable_Simple instead of
 * a PHP array (or other custom data structure) in API methods:
 * - the generic filters can be applied automatically (offset, limit, pattern search, sort, etc.)
 * - the renderer can be applied (XML, PHP, HTML, etc.)
 * So you don't have to write specific renderer for your data, it is already available in all the formats supported natively by Piwik.
 *
 * @package Piwik
 * @subpackage Piwik_DataTable
 */
class Piwik_DataTable_Simple extends Piwik_DataTable
{
    /**
     * Loads (append) in the DataTable the array information
     *
     * @param array $array  Array containing the rows information
     *                       array(
     *                             'Label row 1' => Value row 1,
     *                             'Label row 2' => Value row 2,
     *                       )
     */
    public function addRowsFromArray($array)
    {
        $this->addRowsFromSimpleArray(array($array));
    }

    /**
     * Updates the given column with the given value
     *
     * @param string $columnName
     * @param mixed $value
     */
    public function setColumn($columnName, $value)
    {
        $this->getLastRow()->setColumn($columnName, $value);
    }
}