xref: /plugin/struct/meta/AggregationCloud.php (revision 8b4531cf58936fb41ace28ce103ad4d040aaa7ff) 
1<?php
2
3namespace dokuwiki\plugin\struct\meta;
4
5class AggregationCloud {
6
7    /**
8     * @var string the page id of the page this is rendered to
9     */
10    protected $id;
11
12    /**
13     * @var string the Type of renderer used
14     */
15    protected $mode;
16
17    /**
18     * @var \Doku_Renderer the DokuWiki renderer used to create the output
19     */
20    protected $renderer;
21
22    /**
23     * @var SearchConfig the configured search - gives access to columns etc.
24     */
25    protected $searchConfig;
26
27    /**
28     * @var Column[] the list of columns to be displayed
29     */
30    protected $columns;
31
32    /**
33     * @var  Value[][] the search result
34     */
35    protected $result;
36
37    /**
38     * @var int number of all results
39     */
40    protected $resultCount;
41
42    /**
43     * Initialize the Aggregation renderer and executes the search
44     *
45     * You need to call @see render() on the resulting object.
46     *
47     * @param string $id
48     * @param string $mode
49     * @param \Doku_Renderer $renderer
50     * @param SearchConfig $searchConfig
51     */
52    public function __construct($id, $mode, \Doku_Renderer $renderer, SearchCloud $searchConfig) {
53        $this->id = $id;
54        $this->mode = $mode;
55        $this->renderer = $renderer;
56        $this->searchConfig = $searchConfig;
57        $this->data = $searchConfig->getConf();
58        $this->columns = $searchConfig->getColumns();
59        $this->result = $this->searchConfig->execute();
60        $this->resultCount = $this->searchConfig->getCount();
61
62        $this->max = $this->result[0]['count'];
63        $this->min = end($this->result)['count'];
64    }
65
66    /**
67     * Create the table on the renderer
68     */
69    public function render() {
70
71        $this->sortResults();
72
73        $this->startScope();
74        $this->renderer->doc .= '<ul>';
75        foreach ($this->result as $result) {
76            $this->renderTag($result);
77        }
78        $this->renderer->doc .= '</ul>';
79        $this->finishScope();
80        return;
81    }
82
83    /**
84     * Adds additional info to document and renderer in XHTML mode
85     *
86     * @see finishScope()
87     */
88    protected function startScope() {
89        // wrapping div
90        if($this->mode != 'xhtml') return;
91        $this->renderer->doc .= "<div class=\"structcloud\">";
92    }
93
94    /**
95     * Closes the table and anything opened in startScope()
96     *
97     * @see startScope()
98     */
99    protected function finishScope() {
100        // wrapping div
101        if($this->mode != 'xhtml') return;
102        $this->renderer->doc .= '</div>';
103    }
104
105    /**
106     * Render a tag of the cloud
107     *
108     * @param ['tag' => Value, 'count' => int] $result
109     */
110    protected function renderTag($result) {
111        /**
112         * @var Value $value
113         */
114        $value = $result['tag'];
115        $count = $result['count'];
116        $weight = $this->getWeight($count, $this->min, $this->max);
117        $type = 'struct_' . strtolower($value->getColumn()->getType()->getClass());
118        if ($value->isEmpty()) {
119            return;
120        }
121
122        $tagValue = $value->getDisplayValue();
123        if (empty($tagValue)) {
124            $tagValue = $value->getRawValue();
125        }
126        if (is_array($tagValue)) {
127            $tagValue = $tagValue[0];
128        }
129        $schema = $this->data['schemas'][0][0];
130        $col = $value->getColumn()->getLabel();
131        $this->renderer->doc .= '<li><div class="li">';
132        $this->renderer->doc .= "<div style='font-size:$weight%' data-count='$count' class='cloudtag $type'>";
133
134        $this->renderer->internallink("?flt[$schema.$col*~]=" . urlencode($tagValue),$tagValue);
135        $this->renderer->doc .= '</div>';
136        $this->renderer->doc .= '</div></li>';
137    }
138
139    /**
140     * This interpolates the weight between 70 and 150 based on $min, $max and $current
141     *
142     * @param int $current
143     * @param int $min
144     * @param int $max
145     * @return float|int
146     */
147    protected function getWeight($current, $min, $max) {
148        if ($min == $max) {
149            return 100;
150        }
151        return ($current - $min)/($max - $min) * 80 + 70;
152    }
153
154    /**
155     * Sort the list of results
156     */
157    protected function sortResults() {
158        foreach ($this->result as &$result) {
159            if ($result['tag']->getColumn()->getType()->getClass() == 'Color') {
160                $result['sort'] = $this->getHue($result['tag']->getRawValue());
161            } else {
162                $result['sort'] = $result['tag']->getDisplayValue();
163            }
164        }
165        usort($this->result, function ($a, $b) {
166            if ($a['sort'] < $b['sort']) {
167                return -1;
168            }
169            if ($a['sort'] > $b['sort']) {
170                return 1;
171            }
172            return 0;
173        });
174    }
175
176    /**
177     * Calculate the hue of a color to use it for sorting so we can sort similar colors together.
178     *
179     * @param string $color the color as #RRGGBB
180     * @return float|int
181     */
182    protected function getHue($color) {
183        if (!preg_match('/^#[0-9A-F]{6}$/i', $color)) {
184            return 0;
185        }
186
187        $red   = hexdec(substr($color, 1, 2));
188        $green = hexdec(substr($color, 3, 2));
189        $blue  = hexdec(substr($color, 5, 2));
190
191        $min = min([$red, $green, $blue]);
192        $max = max([$red, $green, $blue]);
193
194        if ($max == $red) {
195            $hue = ($green-$blue)/($max-$min);
196        }
197        if ($max == $green) {
198            $hue = 2 + ($blue-$red)/($max-$min);
199        }
200        if ($max == $blue) {
201            $hue = 4 + ($red-$green)/($max-$min);
202        }
203        $hue = $hue * 60;
204        if ($hue < 0) {
205            $hue += 360;
206        }
207        return $hue;
208    }
209}
210