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

SimpleTable.php « ExampleVisualization « plugins - github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: e38debf9c155f30c3bc5ae677dcf52dc8718990b (plain)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<?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_Plugins
 * @package ExampleVisualization
 */

namespace Piwik\Plugins\ExampleVisualization;

use Piwik\DataTable;
use Piwik\ViewDataTable\Visualization;
use Piwik\Visualization\Config;
use Piwik\Visualization\Request;

/**
 * SimpleTable Visualization.
 */
class SimpleTable extends Visualization
{
    const TEMPLATE_FILE     = '@ExampleVisualization/simpleTable.twig';
    const FOOTER_ICON_TITLE = 'Simple Table';
    const FOOTER_ICON       = 'plugins/ExampleVisualization/images/table.png';

    /**
     * You do not have to implement the init method. It is just an example how to assign view variables.
     */
    public function init()
    {
        $this->vizTitle = 'MyAwesomeTitle';
    }

    public function configureVisualization(Config $properties)
    {
        // Configure how your visualization should look like, for instance you can disable search
        // $properties->show_search = false
    }

    public function beforeLoadDataTable(Request $request, Config $properties)
    {
        // Here you can change the request that is sent to the API, for instance
        // $requestProperties->filter_sort_order = 'desc';
    }

    public function beforeGenericFiltersAreAppliedToLoadedDataTable($dataTable, Config $properties, Request $request)
    {
        // this hook is executed before generic filters like "filter_limit" and "filter_offset" are applied
        // Usage:
        // $dateTable->filter($nameOrClosure);
    }

    public function afterGenericFiltersAreAppliedToLoadedDataTable($dataTable, Config $properties, Request $request)
    {
        // this hook is executed after generic filters like "filter_limit" and "filter_offset" are applied
        // Usage:
        // $dateTable->filter($nameOrClosure, $parameters);
    }

    /**
     * @param DataTable|DataTable\Map      $dataTable
     * @param \Piwik\Visualization\Config  $properties
     * @param \Piwik\Visualization\Request $request
     */
    public function afterAllFilteresAreApplied($dataTable, Config $properties, Request $request)
    {
        // this hook is executed after the data table is loaded and after all filteres are applied.
        // format your data here that you want to pass to the view
        // $this->myCustomViewVariable = $dataTable->getRows();
    }
}