LayoutHelper::dashboardModuleLink() - Code Metrics - Inspection of "Folders tree compact view" - bedita/manager - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1275)

by Dante

created 2025-06-03 08:27 UTC

LayoutHelper::dashboardModuleLink() A

↳ Parent: LayoutHelper

Complexity

Conditions	5
Paths	9

Size

Total Lines	17
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	13
c	1
b	0
f	0
nc	9
nop	2
dl	0
loc	17
rs	9.5222

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2018 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */
namespace App\View\Helper;

use App\Utility\CacheTools;
use App\Utility\Translate;
use Cake\Cache\Cache;
use Cake\Core\Configure;
use Cake\Utility\Hash;
use Cake\View\Helper;

/**
 * Helper for site layout
 *
 * @property \App\View\Helper\EditorsHelper $Editors
 * @property \Cake\View\Helper\HtmlHelper $Html
 * @property \App\View\Helper\LinkHelper $Link
 * @property \App\View\Helper\PermsHelper $Perms
 * @property \App\View\Helper\PropertyHelper $Property
 * @property \App\View\Helper\SystemHelper $System
 * @property \Cake\View\Helper\UrlHelper $Url
 */
class LayoutHelper extends Helper
{
    /**
     * List of helpers used by this helper
     *
     * @var array
     */
    public $helpers = ['Editors', 'Html', 'Link', 'Perms', 'Property', 'System', 'Url'];

    /**
     * Is Dashboard
     *
     * @return bool True if visible for view
     */
    public function isDashboard(): bool
    {
        return in_array($this->_View->getName(), ['Dashboard']);
    }

    /**
     * Is Login
     *
     * @return bool True if visible for view
     */
    public function isLogin(): bool
    {
        return in_array($this->_View->getName(), ['Login']);
    }

    /**
     * Properties for various publication status
     *
     * @param array $object The object
     * @return string pubstatus
     */
    public function publishStatus(array $object = []): string
    {
        if (empty($object)) {
            return '';
        }

        $end = (string)Hash::get($object, 'attributes.publish_end');
        $start = (string)Hash::get($object, 'attributes.publish_start');

        if (!empty($end) && strtotime($end) <= time()) {
            return 'expired';
        }
        if (!empty($start) && strtotime($start) > time()) {
            return 'future';
        }
        if (!empty((string)Hash::get($object, 'meta.locked'))) {
            return 'locked';
        }
        if ((string)Hash::get($object, 'attributes.status') === 'draft') {
            return 'draft';
        }

        return '';
    }

    /**
     * Messages visibility
     *
     * @return bool True if visible for view
     */
    public function messages(): bool
    {
        return $this->_View->getName() != 'Login';
    }

    /**
     * Return title with object title and current module name
     *
     * @return string title with object title and current module name separated by '|'
     */
    public function title(): string
    {
        $module = (array)$this->getView()->get('currentModule');
        $name = (string)Hash::get($module, 'name');
        $object = (array)$this->getView()->get('object');
        $title = (string)Hash::get($object, 'attributes.title');
        $title = strip_tags($title);

        return empty($title) ? $name : sprintf('%s | %s', $title, $name);
    }

    /**
     * Return dashboard module link
     *
     * @param string $name The module name
     * @param array $module The module data
     * @return string
     */
    public function dashboardModuleLink(string $name, array $module): string
    {
        if (in_array($name, ['trash', 'users'])) {
            return '';
        }
        $label = $name === 'objects' ? __('All objects') : Hash::get($module, 'label', $name);
        $route = (array)Hash::get($module, 'route');
        $param = empty($route) ? ['_name' => 'modules:list', 'object_type' => $name, 'plugin' => null] : $route;
        $count = !$this->showCounter($name) ? '' : $this->moduleCount($name);

        return sprintf(
            '<a href="%s" class="%s"><span>%s</span>%s%s</a>',
            $this->Url->build($param),
            sprintf('dashboard-item has-background-module-%s %s', $name, Hash::get($module, 'class', '')),
            $this->tr($label),
            $this->moduleIcon($name, $module),
            $count
        );
    }

    /**
     * Show counter for module
     *
     * @param string $name The module name
     * @return bool
     */
    public function showCounter(string $name): bool
    {
        $counters = Configure::read('UI.modules.counters', ['trash']);

        return is_array($counters) ? in_array($name, $counters) : $counters === 'all';
    }

    /**
     * Return module count span.
     *
     * @param string $name The module name
     * @param string|null $moduleClass The module class
     * @return string
     */
    public function moduleCount(string $name, ?string $moduleClass = null): string
    {
        $count = CacheTools::getModuleCount($name);

        return sprintf('<span class="module-count">%s</span>', $count);
    }

    /**
     * Return module icon.
     *
     * @param string $name The module name
     * @param array $module The module data
     * @return string
     */
    public function moduleIcon(string $name, array $module): string
    {
        if (Hash::get($module, 'hints.multiple_types') && !Hash::get($module, 'class')) {
            return '<app-icon icon="carbon:grid" :style="{ width: \'28px\', height: \'28px\' }"></app-icon>';
        }
        $icon = (string)Configure::read(sprintf('Modules.%s.icon', $name));
        if (!empty($icon)) {
            return sprintf('<app-icon icon="%s" :style="{ width: \'28px\', height: \'28px\' }"></app-icon>', $icon);
        }
        $map = [
            'audio' => 'carbon:document-audio',
            'categories' => 'carbon:collapse-categories',
            'documents' => 'carbon:document',
            'events' => 'carbon:event',
            'files' => 'carbon:document-blank',
            'folders' => 'carbon:tree-view',
            'images' => 'carbon:image',
            'links' => 'carbon:link',
            'locations' => 'carbon:location',
            'news' => 'carbon:calendar',
            'profiles' => 'carbon:person',
            'publications' => 'carbon:wikis',
            'tags' => 'carbon:tag',
            'users' => 'carbon:user',
            'videos' => 'carbon:video',
        ];
        if (!in_array($name, array_keys($map))) {
            return '';
        }

        return sprintf('<app-icon icon="%s" :style="{ width: \'28px\', height: \'28px\' }"></app-icon>', $map[$name]);
    }

    /**
     * Return module css class(es).
     * If object is locked by parents, return base class plus 'locked' class.
     * If object is locked by concurrent editors, return 'concurrent-editors' class plus publish status class.
     * If object is not locked, return base class plus publish status class.
     * Publish status class is 'expired', 'future', 'locked' or 'draft'.
     *
     * @return string
     */
    public function moduleClass(): string
    {
        $moduleClasses = ['app-module-box'];
        $object = (array)$this->getView()->get('object');
        if (!empty($object) && $this->Perms->isLockedByParents((string)Hash::get($object, 'id'))) {
            $moduleClasses[] = 'locked';

            return trim(implode(' ', $moduleClasses));
        }
        $editors = $this->Editors->list();
        if (count($editors) > 1) {
            $moduleClasses = ['app-module-box-concurrent-editors'];
        }
        $moduleClasses[] = $this->publishStatus($object);

        return trim(implode(' ', $moduleClasses));
    }

    /**
     * Module main link
     *
     * @return string The link
     */
    public function moduleLink(): string
    {
        $currentModule = (array)$this->getView()->get('currentModule');
        if (!empty($currentModule) && !empty($currentModule['name'])) {
            $name = $currentModule['name'];
            $label = Hash::get($currentModule, 'label', $name);
            $counters = Configure::read('UI.modules.counters', ['trash']);
            $showCounter = is_array($counters) ? in_array($name, $counters) : $counters === 'all';
            $count = !$showCounter ? '' : $this->moduleCount($name);

            return sprintf(
                '<a href="%s" class="%s"><span class="mr-05">%s</span>%s%s</a>',
                $this->Url->build(['_name' => 'modules:list', 'object_type' => $name]),
                sprintf('module-item has-background-module-%s', $name),
                $this->tr($label),
                $this->moduleIcon($name, $currentModule),
                $count
            );
        }

        // if no `currentModule` has been set a `moduleLink` must be set in controller otherwise current link is displayed
        return $this->Html->link(
            $this->tr($this->getView()->getName()),
            (array)$this->getView()->get('moduleLink'),
            ['class' => $this->commandLinkClass()]
        );
    }

    /**
     * Return module index default view type
     *
     * @return string
     */
    public function moduleIndexDefaultViewType(): string
    {
        $module = (array)$this->getView()->get('currentModule');
        $name = (string)Hash::get($module, 'name');

        return $name === 'folders' ? 'tree' : 'list';
    }

    /**
     * Return module index view type
     *
     * @return string
     */
    public function moduleIndexViewType(): string
    {
        $query = (array)$this->getView()->getRequest()->getQueryParams();

        return (string)Hash::get($query, 'view_type', $this->moduleIndexDefaultViewType());
    }

    /**
     * Return module index view types
     *
     * @return array
     */
    public function moduleIndexViewTypes(): array
    {
        $defaultType = $this->moduleIndexDefaultViewType();

        return $defaultType === 'tree' ? ['tree', 'tree-compact', 'list'] : ['list'];
    }

    /**
     * Append view type buttons to the sidebar
     *
     * @return void
     */
    public function appendViewTypeButtons(): void
    {
        $indexViewTypes = $this->moduleIndexViewTypes();
        if (count($indexViewTypes) > 1) {
            $indexViewType = $this->moduleIndexViewType();
            foreach ($indexViewTypes as $t) {
                if ($t !== $indexViewType) {
                    $append = false;
                    $icon = '';
                    $label = '';
                    switch ($t) {
                        case 'tree':
                            $icon = 'carbon:tree-view';
                            $label = __('Tree view');
                            $append = true;
                            break;
                        case 'tree-compact':
                            $icon = 'carbon:tree-view';
                            $label = __('Tree compact');
                            $meta = $this->getView()->get('meta');
                            $count = (int)Hash::get($meta, 'pagination.count');
                            $append = $count <= Configure::read('UI.tree_compact_view_limit', 100);
                            break;
                        case 'list':
                            $icon = 'carbon:list';
                            $label = __('List view');
                            $append = true;
                            break;
                    }
                    if ($append) {
                        $url = $this->Url->build(
                            [
                                '_name' => 'modules:list',
                                'object_type' => $this->getView()->get('objectType'),
                            ],
                        );
                        $url = sprintf('%s?view_type=%s', $url, $t);
                        $anchor = sprintf(
                            '<a href="%s" class="button button-outlined button-outlined-module-%s"><app-icon icon="%s"></app-icon><span class="ml-05">%s</span></a>',
                            $url,
                            $this->getView()->get('currentModule.name'),
                            $icon,
                            __($label)
                        );
                        $this->getView()->append('app-module-buttons', $anchor);
                    }
                }
            }
        }
    }

    /**
     * Return style class for command link
     *
     * @return string
     */
    protected function commandLinkClass(): string
    {
        $moduleClasses = [
            'UserProfile' => 'has-background-black icon-user',
            'Import' => 'has-background-black icon-download-alt',
            'ObjectTypes' => 'has-background-black',
            'Relations' => 'has-background-black',
            'PropertyTypes' => 'has-background-black',
            'Categories' => 'has-background-black',
            'Appearance' => 'has-background-black',
            'Applications' => 'has-background-black',
            'AsyncJobs' => 'has-background-black',
            'Config' => 'has-background-black',
            'Endpoints' => 'has-background-black',
            'Roles' => 'has-background-black',
            'RolesModules' => 'has-background-black',
            'EndpointPermissions' => 'has-background-black',
            'Tags' => 'has-background-module-tags',
            'ObjectsHistory' => 'has-background-black',
            'SystemInfo' => 'has-background-black',
            'UserAccesses' => 'has-background-black',
            'Statistics' => 'has-background-black',
            'AuthProviders' => 'has-background-black',
            'ExternalAuth' => 'has-background-black',
        ];

        return (string)Hash::get($moduleClasses, $this->_View->getName(), 'commands-menu__module');
    }

    /**
     * Get translated val by input string, using plugins (if any) translations.
     *
     * @param string $input The input string
     * @return string|null
     */
    public function tr(string $input): ?string
    {
        return Translate::get($input);
    }

    /**
     * Return configuration items to create JSON BEDITA object
     *
     * @return array
     */
    public function metaConfig(): array
    {
        return [
            'base' => $this->Link->baseUrl(),
            'currentModule' => $this->getView()->get('currentModule', ['name' => 'home']),
            'template' => $this->getView()->getTemplate(),
            'modules' => array_keys($this->getView()->get('modules', [])),
            'plugins' => \App\Plugin::loadedAppPlugins(),
            'uploadable' => $this->getView()->get('uploadable', []),
            'locale' => \Cake\I18n\I18n::getLocale(),
            'csrfToken' => $this->getCsrfToken(),
            'maxFileSize' => $this->System->getMaxFileSize(),
            'canReadUsers' => $this->Perms->canRead('users'),
            'canSave' => $this->Perms->canSave(),
            'cloneConfig' => (array)Configure::read('Clone'),
            'placeholdersConfig' => $this->System->placeholdersConfig(),
            'uploadConfig' => $this->System->uploadConfig(),
            'relationsSchema' => $this->getView()->get('relationsSchema', []),
            'richeditorConfig' => (array)Configure::read('Richeditor'),
            'richeditorByPropertyConfig' => (array)Configure::read('UI.richeditor', []),
            'indexLists' => (array)$this->indexLists(),
            'fastCreateFields' => (array)$this->Property->fastCreateFieldsMap(),
        ];
    }

    /**
     * Get csrf token, searching in: request params, data, attributes and cookies
     *
     * @return string|null
     */
    public function getCsrfToken(): ?string
    {
        if (!empty($this->getView()->getRequest()->getParam('_csrfToken'))) {
            return (string)$this->getView()->getRequest()->getParam('_csrfToken');
        }
        if (!empty($this->getView()->getRequest()->getData('_csrfToken'))) {
            return (string)$this->getView()->getRequest()->getData('_csrfToken');
        }
        if (!empty($this->getView()->getRequest()->getAttribute('csrfToken'))) {
            return (string)$this->getView()->getRequest()->getAttribute('csrfToken');
        }
        if (!empty($this->getView()->getRequest()->getCookie('csrfToken'))) {
            return (string)$this->getView()->getRequest()->getCookie('csrfToken');
        }

        return null;
    }

    /**
     * Trash link by type.
     *
     * @param string|null $type The object type, if any.
     * @return string
     */
    public function trashLink(?string $type): string
    {
        if (empty($type) || $type === 'trash' || $type === 'translations') {
            return '';
        }

        $modules = (array)$this->_View->get('modules');
        if (!Hash::check($modules, sprintf('%s.hints.object_type', $type))) {
            return '';
        }

        $classes = sprintf('button icon icon-only-icon has-text-module-%s', $type);
        $title = $this->tr($type) . __(' in Trashcan');
        $filter = ['type' => [$type]];

        return $this->Html->link(
            sprintf('<span class="is-sr-only">%s</span><app-icon icon="carbon:trash-can"></app-icon>', __('Trash')),
            ['_name' => 'trash:list', '?' => compact('filter')],
            ['class' => $classes, 'title' => $title, 'escape' => false]
        );
    }

    /**
     * Return properties group for given property
     *
     * @param string $needle The property to search
     * @return ?string
     */
    public function propertyGroup(string $needle): ?string
    {
        $properties = (array)$this->getView()->get('properties');
        foreach ($properties as $group => $props) {
            $keys = array_keys($props);
            if (in_array($needle, $keys)) {
                return $group;
            }
        }

        return null;
    }

    /**
     * Return list of properties to display in `index` view per modules
     *
     * @return array
     */
    public function indexLists(): array
    {
        if (!Configure::check('API.apiBaseUrl')) {
            return [];
        }
        $cacheKey = CacheTools::cacheKey('properties.indexLists');
        $indexLists = Cache::read($cacheKey, 'default');
        if (!empty($indexLists)) {
            return $indexLists;
        }
        Configure::load('properties');
        $properties = (array)Configure::read('Properties');
        $defaultProperties = (array)Configure::read('DefaultProperties');
        $keys = array_keys($properties);
        $keysDefault = array_keys($defaultProperties);
        $keys = array_unique(array_merge($keys, $keysDefault));
        $indexLists = [];
        foreach ($keys as $objectType) {
            $il = (array)Hash::get($properties, sprintf('%s.index', $objectType));
            $il = empty($il) ? (array)Hash::get($defaultProperties, sprintf('%s.index', $objectType)) : $il;
            $indexLists[$objectType] = $il;
        }
        Cache::write($cacheKey, $indexLists);

        return $indexLists;
    }
}


1			<?php
2			/**
3			* BEdita, API-first content management framework
4			* Copyright 2018 ChannelWeb Srl, Chialab Srl
5			*
6			* This file is part of BEdita: you can redistribute it and/or modify
7			* it under the terms of the GNU Lesser General Public License as published
8			* by the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
12			*/
13			namespace App\View\Helper;
14
15			use App\Utility\CacheTools;
16			use App\Utility\Translate;
17			use Cake\Cache\Cache;
18			use Cake\Core\Configure;
19			use Cake\Utility\Hash;
20			use Cake\View\Helper;
21
22			/**
23			* Helper for site layout
24			*
25			* @property \App\View\Helper\EditorsHelper $Editors
26			* @property \Cake\View\Helper\HtmlHelper $Html
27			* @property \App\View\Helper\LinkHelper $Link
28			* @property \App\View\Helper\PermsHelper $Perms
29			* @property \App\View\Helper\PropertyHelper $Property
30			* @property \App\View\Helper\SystemHelper $System
31			* @property \Cake\View\Helper\UrlHelper $Url
32			*/
33			class LayoutHelper extends Helper
34			{
35			/**
36			* List of helpers used by this helper
37			*
38			* @var array
39			*/
40			public $helpers = ['Editors', 'Html', 'Link', 'Perms', 'Property', 'System', 'Url'];
41
42			/**
43			* Is Dashboard
44			*
45			* @return bool True if visible for view
46			*/
47			public function isDashboard(): bool
48			{
49			return in_array($this->_View->getName(), ['Dashboard']);
50			}
51
52			/**
53			* Is Login
54			*
55			* @return bool True if visible for view
56			*/
57			public function isLogin(): bool
58			{
59			return in_array($this->_View->getName(), ['Login']);
60			}
61
62			/**
63			* Properties for various publication status
64			*
65			* @param array $object The object
66			* @return string pubstatus
67			*/
68			public function publishStatus(array $object = []): string
69			{
70			if (empty($object)) {
71			return '';
72			}
73
74			$end = (string)Hash::get($object, 'attributes.publish_end');
75			$start = (string)Hash::get($object, 'attributes.publish_start');
76
77			if (!empty($end) && strtotime($end) <= time()) {
78			return 'expired';
79			}
80			if (!empty($start) && strtotime($start) > time()) {
81			return 'future';
82			}
83			if (!empty((string)Hash::get($object, 'meta.locked'))) {
84			return 'locked';
85			}
86			if ((string)Hash::get($object, 'attributes.status') === 'draft') {
87			return 'draft';
88			}
89
90			return '';
91			}
92
93			/**
94			* Messages visibility
95			*
96			* @return bool True if visible for view
97			*/
98			public function messages(): bool
99			{
100			return $this->_View->getName() != 'Login';
101			}
102
103			/**
104			* Return title with object title and current module name
105			*
106			* @return string title with object title and current module name separated by '\|'
107			*/
108			public function title(): string
109			{
110			$module = (array)$this->getView()->get('currentModule');
111			$name = (string)Hash::get($module, 'name');
112			$object = (array)$this->getView()->get('object');
113			$title = (string)Hash::get($object, 'attributes.title');
114			$title = strip_tags($title);
115
116			return empty($title) ? $name : sprintf('%s \| %s', $title, $name);
117			}
118
119			/**
120			* Return dashboard module link
121			*
122			* @param string $name The module name
123			* @param array $module The module data
124			* @return string
125			*/
126			public function dashboardModuleLink(string $name, array $module): string
127			{
128			if (in_array($name, ['trash', 'users'])) {
129			return '';
130			}
131			$label = $name === 'objects' ? __('All objects') : Hash::get($module, 'label', $name);
132			$route = (array)Hash::get($module, 'route');
133			$param = empty($route) ? ['_name' => 'modules:list', 'object_type' => $name, 'plugin' => null] : $route;
134			$count = !$this->showCounter($name) ? '' : $this->moduleCount($name);
135
136			return sprintf(
137			'<a href="%s" class="%s"><span>%s</span>%s%s</a>',
138			$this->Url->build($param),
139			sprintf('dashboard-item has-background-module-%s %s', $name, Hash::get($module, 'class', '')),
140			$this->tr($label),
141			$this->moduleIcon($name, $module),
142			$count
143			);
144			}
145
146			/**
147			* Show counter for module
148			*
149			* @param string $name The module name
150			* @return bool
151			*/
152			public function showCounter(string $name): bool
153			{
154			$counters = Configure::read('UI.modules.counters', ['trash']);
155
156			return is_array($counters) ? in_array($name, $counters) : $counters === 'all';
157			}
158
159			/**
160			* Return module count span.
161			*
162			* @param string $name The module name
163			* @param string\|null $moduleClass The module class
164			* @return string
165			*/
166			public function moduleCount(string $name, ?string $moduleClass = null): string
167			{
168			$count = CacheTools::getModuleCount($name);
169
170			return sprintf('<span class="module-count">%s</span>', $count);
171			}
172
173			/**
174			* Return module icon.
175			*
176			* @param string $name The module name
177			* @param array $module The module data
178			* @return string
179			*/
180			public function moduleIcon(string $name, array $module): string
181			{
182			if (Hash::get($module, 'hints.multiple_types') && !Hash::get($module, 'class')) {
183			return '<app-icon icon="carbon:grid" :style="{ width: \'28px\', height: \'28px\' }"></app-icon>';
184			}
185			$icon = (string)Configure::read(sprintf('Modules.%s.icon', $name));
186			if (!empty($icon)) {
187			return sprintf('<app-icon icon="%s" :style="{ width: \'28px\', height: \'28px\' }"></app-icon>', $icon);
188			}
189			$map = [
190			'audio' => 'carbon:document-audio',
191			'categories' => 'carbon:collapse-categories',
192			'documents' => 'carbon:document',
193			'events' => 'carbon:event',
194			'files' => 'carbon:document-blank',
195			'folders' => 'carbon:tree-view',
196			'images' => 'carbon:image',
197			'links' => 'carbon:link',
198			'locations' => 'carbon:location',
199			'news' => 'carbon:calendar',
200			'profiles' => 'carbon:person',
201			'publications' => 'carbon:wikis',
202			'tags' => 'carbon:tag',
203			'users' => 'carbon:user',
204			'videos' => 'carbon:video',
205			];
206			if (!in_array($name, array_keys($map))) {
207			return '';
208			}
209
210			return sprintf('<app-icon icon="%s" :style="{ width: \'28px\', height: \'28px\' }"></app-icon>', $map[$name]);
211			}
212
213			/**
214			* Return module css class(es).
215			* If object is locked by parents, return base class plus 'locked' class.
216			* If object is locked by concurrent editors, return 'concurrent-editors' class plus publish status class.
217			* If object is not locked, return base class plus publish status class.
218			* Publish status class is 'expired', 'future', 'locked' or 'draft'.
219			*
220			* @return string
221			*/
222			public function moduleClass(): string
223			{
224			$moduleClasses = ['app-module-box'];
225			$object = (array)$this->getView()->get('object');
226			if (!empty($object) && $this->Perms->isLockedByParents((string)Hash::get($object, 'id'))) {
227			$moduleClasses[] = 'locked';
228
229			return trim(implode(' ', $moduleClasses));
230			}
231			$editors = $this->Editors->list();
232			if (count($editors) > 1) {
233			$moduleClasses = ['app-module-box-concurrent-editors'];
234			}
235			$moduleClasses[] = $this->publishStatus($object);
236
237			return trim(implode(' ', $moduleClasses));
238			}
239
240			/**
241			* Module main link
242			*
243			* @return string The link
244			*/
245			public function moduleLink(): string
246			{
247			$currentModule = (array)$this->getView()->get('currentModule');
248			if (!empty($currentModule) && !empty($currentModule['name'])) {
249			$name = $currentModule['name'];
250			$label = Hash::get($currentModule, 'label', $name);
251			$counters = Configure::read('UI.modules.counters', ['trash']);
252			$showCounter = is_array($counters) ? in_array($name, $counters) : $counters === 'all';
253			$count = !$showCounter ? '' : $this->moduleCount($name);
254
255			return sprintf(
256			'<a href="%s" class="%s"><span class="mr-05">%s</span>%s%s</a>',
257			$this->Url->build(['_name' => 'modules:list', 'object_type' => $name]),
258			sprintf('module-item has-background-module-%s', $name),
259			$this->tr($label),
260			$this->moduleIcon($name, $currentModule),
261			$count
262			);
263			}
264
265			// if no `currentModule` has been set a `moduleLink` must be set in controller otherwise current link is displayed
266			return $this->Html->link(
267			$this->tr($this->getView()->getName()),
268			(array)$this->getView()->get('moduleLink'),
269			['class' => $this->commandLinkClass()]
270			);
271			}
272
273			/**
274			* Return module index default view type
275			*
276			* @return string
277			*/
278			public function moduleIndexDefaultViewType(): string
279			{
280			$module = (array)$this->getView()->get('currentModule');
281			$name = (string)Hash::get($module, 'name');
282
283			return $name === 'folders' ? 'tree' : 'list';
284			}
285
286			/**
287			* Return module index view type
288			*
289			* @return string
290			*/
291			public function moduleIndexViewType(): string
292			{
293			$query = (array)$this->getView()->getRequest()->getQueryParams();
294
295			return (string)Hash::get($query, 'view_type', $this->moduleIndexDefaultViewType());
296			}
297
298			/**
299			* Return module index view types
300			*
301			* @return array
302			*/
303			public function moduleIndexViewTypes(): array
304			{
305			$defaultType = $this->moduleIndexDefaultViewType();
306
307			return $defaultType === 'tree' ? ['tree', 'tree-compact', 'list'] : ['list'];
308			}
309
310			/**
311			* Append view type buttons to the sidebar
312			*
313			* @return void
314			*/
315			public function appendViewTypeButtons(): void
316			{
317			$indexViewTypes = $this->moduleIndexViewTypes();
318			if (count($indexViewTypes) > 1) {
319			$indexViewType = $this->moduleIndexViewType();
320			foreach ($indexViewTypes as $t) {
321			if ($t !== $indexViewType) {
322			$append = false;
323			$icon = '';
324			$label = '';
325			switch ($t) {
326			case 'tree':
327			$icon = 'carbon:tree-view';
328			$label = __('Tree view');
329			$append = true;
330			break;
331			case 'tree-compact':
332			$icon = 'carbon:tree-view';
333			$label = __('Tree compact');
334			$meta = $this->getView()->get('meta');
335			$count = (int)Hash::get($meta, 'pagination.count');
336			$append = $count <= Configure::read('UI.tree_compact_view_limit', 100);
337			break;
338			case 'list':
339			$icon = 'carbon:list';
340			$label = __('List view');
341			$append = true;
342			break;
343			}
344			if ($append) {
345			$url = $this->Url->build(
346			[
347			'_name' => 'modules:list',
348			'object_type' => $this->getView()->get('objectType'),
349			],
350			);
351			$url = sprintf('%s?view_type=%s', $url, $t);
352			$anchor = sprintf(
353			'<a href="%s" class="button button-outlined button-outlined-module-%s"><app-icon icon="%s"></app-icon><span class="ml-05">%s</span></a>',
354			$url,
355			$this->getView()->get('currentModule.name'),
356			$icon,
357			__($label)
358			);
359			$this->getView()->append('app-module-buttons', $anchor);
360			}
361			}
362			}
363			}
364			}
365
366			/**
367			* Return style class for command link
368			*
369			* @return string
370			*/
371			protected function commandLinkClass(): string
372			{
373			$moduleClasses = [
374			'UserProfile' => 'has-background-black icon-user',
375			'Import' => 'has-background-black icon-download-alt',
376			'ObjectTypes' => 'has-background-black',
377			'Relations' => 'has-background-black',
378			'PropertyTypes' => 'has-background-black',
379			'Categories' => 'has-background-black',
380			'Appearance' => 'has-background-black',
381			'Applications' => 'has-background-black',
382			'AsyncJobs' => 'has-background-black',
383			'Config' => 'has-background-black',
384			'Endpoints' => 'has-background-black',
385			'Roles' => 'has-background-black',
386			'RolesModules' => 'has-background-black',
387			'EndpointPermissions' => 'has-background-black',
388			'Tags' => 'has-background-module-tags',
389			'ObjectsHistory' => 'has-background-black',
390			'SystemInfo' => 'has-background-black',
391			'UserAccesses' => 'has-background-black',
392			'Statistics' => 'has-background-black',
393			'AuthProviders' => 'has-background-black',
394			'ExternalAuth' => 'has-background-black',
395			];
396
397			return (string)Hash::get($moduleClasses, $this->_View->getName(), 'commands-menu__module');
398			}
399
400			/**
401			* Get translated val by input string, using plugins (if any) translations.
402			*
403			* @param string $input The input string
404			* @return string\|null
405			*/
406			public function tr(string $input): ?string
407			{
408			return Translate::get($input);
409			}
410
411			/**
412			* Return configuration items to create JSON BEDITA object
413			*
414			* @return array
415			*/
416			public function metaConfig(): array
417			{
418			return [
419			'base' => $this->Link->baseUrl(),
420			'currentModule' => $this->getView()->get('currentModule', ['name' => 'home']),
421			'template' => $this->getView()->getTemplate(),
422			'modules' => array_keys($this->getView()->get('modules', [])),
423			'plugins' => \App\Plugin::loadedAppPlugins(),
424			'uploadable' => $this->getView()->get('uploadable', []),
425			'locale' => \Cake\I18n\I18n::getLocale(),
426			'csrfToken' => $this->getCsrfToken(),
427			'maxFileSize' => $this->System->getMaxFileSize(),
428			'canReadUsers' => $this->Perms->canRead('users'),
429			'canSave' => $this->Perms->canSave(),
430			'cloneConfig' => (array)Configure::read('Clone'),
431			'placeholdersConfig' => $this->System->placeholdersConfig(),
432			'uploadConfig' => $this->System->uploadConfig(),
433			'relationsSchema' => $this->getView()->get('relationsSchema', []),
434			'richeditorConfig' => (array)Configure::read('Richeditor'),
435			'richeditorByPropertyConfig' => (array)Configure::read('UI.richeditor', []),
436			'indexLists' => (array)$this->indexLists(),
437			'fastCreateFields' => (array)$this->Property->fastCreateFieldsMap(),
438			];
439			}
440
441			/**
442			* Get csrf token, searching in: request params, data, attributes and cookies
443			*
444			* @return string\|null
445			*/
446			public function getCsrfToken(): ?string
447			{
448			if (!empty($this->getView()->getRequest()->getParam('_csrfToken'))) {
449			return (string)$this->getView()->getRequest()->getParam('_csrfToken');
450			}
451			if (!empty($this->getView()->getRequest()->getData('_csrfToken'))) {
452			return (string)$this->getView()->getRequest()->getData('_csrfToken');
453			}
454			if (!empty($this->getView()->getRequest()->getAttribute('csrfToken'))) {
455			return (string)$this->getView()->getRequest()->getAttribute('csrfToken');
456			}
457			if (!empty($this->getView()->getRequest()->getCookie('csrfToken'))) {
458			return (string)$this->getView()->getRequest()->getCookie('csrfToken');
459			}
460
461			return null;
462			}
463
464			/**
465			* Trash link by type.
466			*
467			* @param string\|null $type The object type, if any.
468			* @return string
469			*/
470			public function trashLink(?string $type): string
471			{
472			if (empty($type) \|\| $type === 'trash' \|\| $type === 'translations') {
473			return '';
474			}
475
476			$modules = (array)$this->_View->get('modules');
477			if (!Hash::check($modules, sprintf('%s.hints.object_type', $type))) {
478			return '';
479			}
480
481			$classes = sprintf('button icon icon-only-icon has-text-module-%s', $type);
482			$title = $this->tr($type) . __(' in Trashcan');
483			$filter = ['type' => [$type]];
484
485			return $this->Html->link(
486			sprintf('<span class="is-sr-only">%s</span><app-icon icon="carbon:trash-can"></app-icon>', __('Trash')),
487			['_name' => 'trash:list', '?' => compact('filter')],
488			['class' => $classes, 'title' => $title, 'escape' => false]
489			);
490			}
491
492			/**
493			* Return properties group for given property
494			*
495			* @param string $needle The property to search
496			* @return ?string
497			*/
498			public function propertyGroup(string $needle): ?string
499			{
500			$properties = (array)$this->getView()->get('properties');
501			foreach ($properties as $group => $props) {
502			$keys = array_keys($props);
503			if (in_array($needle, $keys)) {
504			return $group;
505			}
506			}
507
508			return null;
509			}
510
511			/**
512			* Return list of properties to display in `index` view per modules
513			*
514			* @return array
515			*/
516			public function indexLists(): array
517			{
518			if (!Configure::check('API.apiBaseUrl')) {
519			return [];
520			}
521			$cacheKey = CacheTools::cacheKey('properties.indexLists');
522			$indexLists = Cache::read($cacheKey, 'default');
523			if (!empty($indexLists)) {
524			return $indexLists;
525			}
526			Configure::load('properties');
527			$properties = (array)Configure::read('Properties');
528			$defaultProperties = (array)Configure::read('DefaultProperties');
529			$keys = array_keys($properties);
530			$keysDefault = array_keys($defaultProperties);
531			$keys = array_unique(array_merge($keys, $keysDefault));
532			$indexLists = [];
533			foreach ($keys as $objectType) {
534			$il = (array)Hash::get($properties, sprintf('%s.index', $objectType));
535			$il = empty($il) ? (array)Hash::get($defaultProperties, sprintf('%s.index', $objectType)) : $il;
536			$indexLists[$objectType] = $il;
537			}
538			Cache::write($cacheKey, $indexLists);
539
540			return $indexLists;
541			}
542			}
543

bedita / manager

Pull Request — master (#1275)

LayoutHelper::dashboardModuleLink() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like