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
|
<?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
*/
namespace Piwik\Plugins\CoreVisualizations\Visualizations;
use Piwik\Common;
use Piwik\View;
use Piwik\DataTable;
use Piwik\DataTableVisualization;
/**
* Generates a tag cloud from a given data array.
* The generated tag cloud can be in PHP format, or in HTML.
*
* Inspired from Derek Harvey (www.derekharvey.co.uk)
*
* @package Piwik
* @subpackage Piwik_Visualization
*/
class Cloud extends DataTableVisualization
{
const ID = 'cloud';
/** Used by integration tests to make sure output is consistent. */
public static $debugDisableShuffle = false;
protected $wordsArray = array();
public $truncatingLimit = 50;
public static function getDefaultPropertyValues()
{
return array(
'show_offset_information' => false,
'show_exclude_low_population' => false,
'display_logo_instead_of_label' => false,
);
}
/**
* Assign word to array
* @param string $word
* @param int $value
* @return string
*/
public function addWord($word, $value = 1)
{
if (isset($this->wordsArray[$word])) {
$this->wordsArray[$word] += $value;
} else {
$this->wordsArray[$word] = $value;
}
}
/**
* Renders this visualization.
*
* @param DataTable $dataTable
* @param array $properties
* @return string
*/
public function render($dataTable, $properties)
{
$view = new View("@CoreVisualizations/_dataTableViz_tagCloud.twig");
$view->properties = $properties;
$columnToDisplay = $properties['columns_to_display'][1];
$labelMetadata = array();
foreach ($dataTable->getRows() as $row) {
$logo = false;
if ($properties['display_logo_instead_of_label']) {
$logo = $row->getMetadata('logo');
}
$label = $row->getColumn('label');
$labelMetadata[$label] = array(
'logo' => $logo,
'url' => $row->getMetadata('url'),
);
$this->addWord($label, $row->getColumn($columnToDisplay));
}
$cloudValues = $this->getCloudValues();
foreach ($cloudValues as &$value) {
$value['logoWidth'] = round(max(16, $value['percent']));
}
$view->labelMetadata = $labelMetadata;
$view->cloudValues = $cloudValues;
return $view->render();
}
private function getCloudValues()
{
$this->shuffleCloud();
$return = array();
if (empty($this->wordsArray)) {
return array();
}
$maxValue = max($this->wordsArray);
foreach ($this->wordsArray as $word => $popularity) {
$wordTruncated = $word;
if (Common::mb_strlen($word) > $this->truncatingLimit) {
$wordTruncated = Common::mb_substr($word, 0, $this->truncatingLimit - 3) . '...';
}
// case hideFutureHoursWhenToday=1 shows hours with no visits
if ($maxValue == 0) {
$percent = 0;
} else {
$percent = ($popularity / $maxValue) * 100;
}
// CSS style value
$sizeRange = $this->getClassFromPercent($percent);
$return[$word] = array(
'word' => $word,
'wordTruncated' => $wordTruncated,
'value' => $popularity,
'size' => $sizeRange,
'percent' => $percent,
);
}
return $return;
}
/**
* Shuffle associated names in array
*/
protected function shuffleCloud()
{
if (self::$debugDisableShuffle) {
return;
}
$keys = array_keys($this->wordsArray);
shuffle($keys);
if (count($keys) && is_array($keys)) {
$tmpArray = $this->wordsArray;
$this->wordsArray = array();
foreach ($keys as $key => $value)
$this->wordsArray[$value] = $tmpArray[$value];
}
}
/**
* Get the class range using a percentage
*
* @param $percent
*
* @return int class
*/
protected function getClassFromPercent($percent)
{
$mapping = array(95, 70, 50, 30, 15, 5, 0);
foreach ($mapping as $key => $value) {
if ($percent >= $value) {
return $key;
}
}
}
}
|
