xref: /plugin/struct/meta/AggregationCloud.php (revision 34f483db1909585e6a5d5e29b3b904424f3660d1) 
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 cloud on the renderer
68     */
69    public function render() {
70
71        $this->sortResults();
72
73        $this->startScope();
74        $this->startList();
75        foreach ($this->result as $result) {
76            $this->renderTag($result);
77        }
78        $this->finishList();
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        if ($value->isEmpty()) {
117            return;
118        }
119
120        $type = strtolower($value->getColumn()->getType()->getClass());
121        $weight = $this->getWeight($count, $this->min, $this->max);
122
123        if (!empty($this->data['target'])) {
124            $target = $this->data['target'];
125        } else {
126            global $INFO;
127            $target = $INFO['id'];
128        }
129
130        $tagValue = $value->getDisplayValue();
131        if (is_array($tagValue)) {
132            $tagValue = $tagValue[0];
133        }
134        $key = $value->getColumn()->getFullQualifiedLabel() . '=';
135        $filter = SearchConfigParameters::$PARAM_FILTER . '[' . urlencode($key) . ']=' . urlencode($tagValue);
136
137        $this->renderer->listitem_open(1);
138        $this->renderer->listcontent_open();
139
140        if($this->mode == 'xhtml') {
141            $this->renderer->doc .= "<div style='font-size:$weight%' data-count='$count' class='cloudtag struct_$type'>";
142        }
143
144        $value->renderAsTagCloudLink($this->renderer, $this->mode, $target, $filter, $weight);
145
146        if($this->mode == 'xhtml') {
147            $this->renderer->doc .= '</div>';
148        }
149
150        $this->renderer->listcontent_close();
151        $this->renderer->listitem_close();
152    }
153
154    /**
155     * This interpolates the weight between 70 and 150 based on $min, $max and $current
156     *
157     * @param int $current
158     * @param int $min
159     * @param int $max
160     * @return int
161     */
162    protected function getWeight($current, $min, $max) {
163        if ($min == $max) {
164            return 100;
165        }
166        return round(($current - $min)/($max - $min) * 80 + 70);
167    }
168
169    /**
170     * Sort the list of results
171     */
172    protected function sortResults() {
173        usort($this->result, function ($a, $b) {
174            $asort = $a['tag']->getColumn()->getType()->getSortString($a['tag']);
175            $bsort = $b['tag']->getColumn()->getType()->getSortString($b['tag']);
176            if ($asort < $bsort) {
177                return -1;
178            }
179            if ($asort > $bsort) {
180                return 1;
181            }
182            return 0;
183        });
184    }
185
186    protected function startList() {
187        $this->renderer->listu_open();
188    }
189
190    protected function finishList() {
191        $this->renderer->listu_close();
192    }
193}
194