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

Sort.php « Filter « DataTable « core - github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 014362b45d386278e60dabec95b62cb676c27b44 (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<?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
 */
use Piwik\Metrics;

/**
 * Sort the DataTable based on the value of column $columnToSort ordered by $order.
 * Possible to specify a natural sorting (see php.net/natsort for details)
 *
 * @package Piwik
 * @subpackage Piwik_DataTable
 */
class Piwik_DataTable_Filter_Sort extends Piwik_DataTable_Filter
{
    protected $columnToSort;
    protected $order;

    /**
     * @param Piwik_DataTable $table
     * @param string $columnToSort   name of the column to sort by
     * @param string $order          order (asc|desc)
     * @param bool $naturalSort    use natural sort?
     * @param bool $recursiveSort  sort recursively?
     */
    public function __construct($table, $columnToSort, $order = 'desc', $naturalSort = true, $recursiveSort = false)
    {
        parent::__construct($table);
        if ($recursiveSort) {
            $table->enableRecursiveSort();
        }
        $this->columnToSort = $columnToSort;
        $this->naturalSort = $naturalSort;
        $this->setOrder($order);
    }

    /**
     * Updates the order
     *
     * @param string $order  asc|desc
     */
    public function setOrder($order)
    {
        if ($order == 'asc') {
            $this->order = 'asc';
            $this->sign = 1;
        } else {
            $this->order = 'desc';
            $this->sign = -1;
        }
    }

    /**
     * Sorting method used for sorting numbers
     *
     * @param number $a
     * @param number $b
     * @return int
     */
    public function sort($a, $b)
    {
        return !isset($a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
            && !isset($b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])

            ? 0
            : (
            !isset($a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
                ? 1
                : (
            !isset($b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
                ? -1
                : (($a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort] != $b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort]
                || !isset($a->c[Piwik_DataTable_Row::COLUMNS]['label']))
                ? ($this->sign * (
                $a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort]
                    < $b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort]
                    ? -1
                    : 1)
                )
                : -1 * $this->sign * strnatcasecmp(
                    $a->c[Piwik_DataTable_Row::COLUMNS]['label'],
                    $b->c[Piwik_DataTable_Row::COLUMNS]['label'])
            )
            )
            );
    }

    /**
     * Sorting method used for sorting values natural
     *
     * @param mixed $a
     * @param mixed $b
     * @return int
     */
    function naturalSort($a, $b)
    {
        return !isset($a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
            && !isset($b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
            ? 0
            : (!isset($a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
                ? 1
                : (!isset($b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
                    ? -1
                    : $this->sign * strnatcasecmp(
                        $a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort],
                        $b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort]
                    )
                )
            );
    }

    /**
     * Sorting method used for sorting values
     *
     * @param mixed $a
     * @param mixed $b
     * @return int
     */
    function sortString($a, $b)
    {
        return !isset($a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
            && !isset($b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
            ? 0
            : (!isset($a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
                ? 1
                : (!isset($b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort])
                    ? -1
                    : $this->sign *
                        strcasecmp($a->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort],
                            $b->c[Piwik_DataTable_Row::COLUMNS][$this->columnToSort]
                        )
                )
            );
    }

    /**
     * Sets the column to be used for sorting
     *
     * @param Piwik_DataTable_Row $row
     * @return int
     */
    protected function selectColumnToSort($row)
    {
        $value = $row->getColumn($this->columnToSort);
        if ($value !== false) {
            return $this->columnToSort;
        }

        $columnIdToName = Metrics::getMappingFromIdToName();
        // sorting by "nb_visits" but the index is Metrics::INDEX_NB_VISITS in the table
        if (isset($columnIdToName[$this->columnToSort])) {
            $column = $columnIdToName[$this->columnToSort];
            $value = $row->getColumn($column);

            if ($value !== false) {
                return $column;
            }
        }

        // eg. was previously sorted by revenue_per_visit, but this table
        // doesn't have this column; defaults with nb_visits
        $column = Metrics::INDEX_NB_VISITS;
        $value = $row->getColumn($column);
        if ($value !== false) {
            return $column;
        }

        // even though this column is not set properly in the table,
        // we select it for the sort, so that the table's internal state is set properly
        return $this->columnToSort;
    }

    /**
     * Sorts the given data table by defined column and sorting method
     *
     * @param Piwik_DataTable $table
     * @return mixed
     */
    public function filter($table)
    {
        if ($table instanceof Piwik_DataTable_Simple) {
            return;
        }
        if (empty($this->columnToSort)) {
            return;
        }
        $rows = $table->getRows();
        if (count($rows) == 0) {
            return;
        }
        $row = current($rows);
        if ($row === false) {
            return;
        }
        $this->columnToSort = $this->selectColumnToSort($row);

        $value = $row->getColumn($this->columnToSort);
        if (is_numeric($value)) {
            $methodToUse = "sort";
        } else {
            if ($this->naturalSort) {
                $methodToUse = "naturalSort";
            } else {
                $methodToUse = "sortString";
            }
        }
        $table->sort(array($this, $methodToUse), $this->columnToSort);
    }
}