3 declare(strict_types
=1);
5 namespace Shaarli\Front\Controller\Visitor
;
8 use Slim\Http\Response
;
13 * Slim controller used to render the tag cloud and tag list pages.
15 class TagCloudController
extends ShaarliVisitorController
17 protected const TYPE_CLOUD
= 'cloud';
18 protected const TYPE_LIST
= 'list';
21 * Display the tag cloud through the template engine.
22 * This controller a few filters:
23 * - Visibility stored in the session for logged in users
24 * - `searchtags` query parameter: will return tags associated with filter in at least one bookmark
26 public function cloud(Request
$request, Response
$response): Response
28 return $this->processRequest(static::TYPE_CLOUD
, $request, $response);
32 * Display the tag list through the template engine.
33 * This controller a few filters:
34 * - Visibility stored in the session for logged in users
35 * - `searchtags` query parameter: will return tags associated with filter in at least one bookmark
36 * - `sort` query parameters:
37 * + `usage` (default): most used tags first
38 * + `alpha`: alphabetical order
40 public function list(Request
$request, Response
$response): Response
42 return $this->processRequest(static::TYPE_LIST
, $request, $response);
46 * Process the request for both tag cloud and tag list endpoints.
48 protected function processRequest(string $type, Request
$request, Response
$response): Response
50 if ($this->container
->loginManager
->isLoggedIn() === true) {
51 $visibility = $this->container
->sessionManager
->getSessionParameter('visibility');
54 $sort = $request->getQueryParam('sort');
55 $searchTags = $request->getQueryParam('searchtags');
56 $filteringTags = $searchTags !== null ? explode(' ', $searchTags) : [];
58 $tags = $this->container
->bookmarkService
->bookmarksCountPerTag($filteringTags, $visibility ?? null);
60 if (static::TYPE_CLOUD
=== $type || 'alpha' === $sort) {
61 // TODO: the sorting should be handled by bookmarkService instead of the controller
62 alphabetical_sort($tags, false, true);
65 if (static::TYPE_CLOUD
=== $type) {
66 $tags = $this->formatTagsForCloud($tags);
69 $searchTags = implode(' ', escape($filteringTags));
71 'search_tags' => $searchTags,
74 $data = $this->executeHooks('tag' . $type, $data);
75 foreach ($data as $key => $value) {
76 $this->assignView($key, $value);
79 $searchTags = !empty($searchTags) ? $searchTags .' - ' : '';
82 $searchTags . t('Tag '. $type) .' - '. $this->container
->conf
->get('general.title', 'Shaarli')
85 return $response->write($this->render('tag.'. $type));
89 * Format the tags array for the tag cloud template.
91 * @param array<string, int> $tags List of tags as key with count as value
93 * @return mixed[] List of tags as key, with count and expected font size in a subarray
95 protected function formatTagsForCloud(array $tags): array
97 // We sort tags alphabetically, then choose a font size according to count.
98 // First, find max value.
99 $maxCount = count($tags) > 0 ? max($tags) : 0;
100 $logMaxCount = $maxCount > 1 ? log($maxCount, 30) : 1;
102 foreach ($tags as $key => $value) {
103 // Tag font size scaling:
104 // default 15 and 30 logarithm bases affect scaling,
105 // 2.2 and 0.8 are arbitrary font sizes in em.
106 $size = log($value, 15) / $logMaxCount * 2.2 +
0.8;
109 'size' => number_format($size, 2, '.', ''),
117 * @param mixed[] $data Template data
119 * @return mixed[] Template data after active plugins hook execution.
121 protected function executeHooks(string $template, array $data): array
123 $this->container
->pluginManager
->executeHooks(
124 'render_'. $template,
126 ['loggedin' => $this->container
->loginManager
->isLoggedIn()]