AdminController::filterCreateCapability() - Code Metrics - Inspection of "v5.10.3 release" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b694dd...6c1d9a )

by Paul

created 2021-04-28 18:47 UTC

AdminController::filterCreateCapability() A

↳ Parent: AdminController

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes

Metric	Value
cc	2
eloc	3
c	0
b	0
f	0
nc	2
nop	2
dl	0
loc	6
ccs	3
cts	4
cp	0.75
crap	2.0625
rs	10

<?php

namespace GeminiLabs\SiteReviews\Controllers;

use GeminiLabs\SiteReviews\Commands\EnqueueAdminAssets;
use GeminiLabs\SiteReviews\Commands\ExportRatings;
use GeminiLabs\SiteReviews\Commands\ImportRatings;
use GeminiLabs\SiteReviews\Commands\RegisterTinymcePopups;
use GeminiLabs\SiteReviews\Commands\TogglePinned;
use GeminiLabs\SiteReviews\Commands\ToggleStatus;
use GeminiLabs\SiteReviews\Database;
use GeminiLabs\SiteReviews\Helpers\Arr;
use GeminiLabs\SiteReviews\Install;
use GeminiLabs\SiteReviews\Modules\Html\Builder;
use GeminiLabs\SiteReviews\Modules\Migrate;
use GeminiLabs\SiteReviews\Modules\Notice;
use GeminiLabs\SiteReviews\Modules\Translation;
use GeminiLabs\SiteReviews\Request;

class AdminController extends Controller
{
    /**
     * @return void
     * @action site-reviews/export/cleanup
     */
    public function cleanupAfterExport()
    {
        glsr(Database::class)->deleteMeta(glsr()->export_key);
    }

    /**
     * @return void
     * @action admin_enqueue_scripts
     */
    public function enqueueAssets()
    {
        $this->execute(new EnqueueAdminAssets());
    }

    /**
     * @return array
     * @filter plugin_action_links_site-reviews/site-reviews.php
     */
    public function filterActionLinks(array $links)
    {
        if (glsr()->hasPermission('settings')) {
            $links['settings'] = glsr(Builder::class)->a([
                'href' => admin_url('edit.php?post_type='.glsr()->post_type.'&page=settings'),
                'text' => _x('Settings', 'admin-text', 'site-reviews'),
            ]);
        }
        if (glsr()->hasPermission('documentation')) {
            $links['documentation'] = glsr(Builder::class)->a([
                'href' => admin_url('edit.php?post_type='.glsr()->post_type.'&page=documentation'),
                'text' => _x('Help', 'admin-text', 'site-reviews'),
            ]);
        }
        return $links;
    }

    /**
     * @param array $capabilities
     * @param string $capability
     * @return array
     * @filter map_meta_cap
     */
    public function filterCreateCapability($capabilities, $capability)
    {
        if ($capability == 'create_'.glsr()->post_type) {
            $capabilities[] = 'do_not_allow';
        }
        return $capabilities;
    }

    /**
     * @param array $items
     * @return array
     * @filter dashboard_glance_items
     */
    public function filterDashboardGlanceItems($items)
    {
        $postCount = wp_count_posts(glsr()->post_type);
        if (empty($postCount->publish)) {
            return $items;
        }
        $text = _nx('%s Review', '%s Reviews', $postCount->publish, 'admin-text', 'site-reviews');
        $text = sprintf($text, number_format_i18n($postCount->publish));
        $items = Arr::consolidate($items);
        if (glsr()->can('edit_posts')) {
            $items[] = glsr(Builder::class)->a($text, [
                'class' => 'glsr-review-count',
                'href' => 'edit.php?post_type='.glsr()->post_type,
            ]);
        } else {
            $items[] = glsr(Builder::class)->span($text, [
                'class' => 'glsr-review-count',
            ]);
        }
        return $items;
    }

    /**
     * @param array $args
     * @return array
     * @filter export_args
     */
    public function filterExportArgs($args)
    {
        if (in_array(Arr::get($args, 'content'), ['all', glsr()->post_type])) {
            $this->execute(new ExportRatings(glsr()->args($args)));
        }
        return $args;
    }

    /**
     * @param array $plugins
     * @return array
     * @filter mce_external_plugins
     */
    public function filterTinymcePlugins($plugins)
    {
        if (glsr()->can('edit_posts')) {
            $plugins = Arr::consolidate($plugins);
            $plugins['glsr_shortcode'] = glsr()->url('assets/scripts/mce-plugin.js');
        }
        return $plugins;
    }

    /**
     * @return void
     * @action admin_init
     */
    public function onActivation()
    {
        if (empty(get_option(glsr()->prefix.'activated'))) {
            glsr(Install::class)->run();
            glsr(Migrate::class)->run();
            update_option(glsr()->prefix.'activated', true);
        }
    }

    /**
     * @return void
     * @action import_end
     */
    public function onImportEnd()
    {
        $this->execute(new ImportRatings());
    }

    /**
     * @return void
     * @action admin_head
     */
    public function printInlineStyle()
    {
        echo '<style type="text/css">a[href="edit.php?post_type=site-review&page=addons"]:not(.current):not(:hover) { color:#F6E05E!important; }</style>';
    }

    /**
     * @return void
     * @action admin_init
     */
    public function registerTinymcePopups()
    {
        $this->execute(new RegisterTinymcePopups([
            'site_reviews' => _x('Recent Reviews', 'admin-text', 'site-reviews'),
            'site_reviews_form' => _x('Submit a Review', 'admin-text', 'site-reviews'),
            'site_reviews_summary' => _x('Summary of Reviews', 'admin-text', 'site-reviews'),
        ]));
    }

    /**
     * @param string $editorId
     * @return void|null
     * @action media_buttons
     */
    public function renderTinymceButton($editorId)
    {
        $allowedEditors = glsr()->filterArray('tinymce/editor-ids', ['content'], $editorId);
        if ('post' !== glsr_current_screen()->base || !in_array($editorId, $allowedEditors)) {
            return;
        }
        $shortcodes = [];
        foreach (glsr()->retrieve('mce', []) as $shortcode => $values) {
            $shortcodes[$shortcode] = $values;
        }
        if (empty($shortcodes)) {
            return;
        }
        glsr()->render('partials/editor/tinymce', [
            'shortcodes' => $shortcodes,
        ]);
    }

    /**
     * @return void
     * @action site-reviews/route/ajax/search-posts
     */
    public function searchPostsAjax(Request $request)
    {
        $results = glsr(Database::class)->searchPosts($request->search);
        wp_send_json_success([
            'empty' => '<div>'._x('Nothing found.', 'admin-text', 'site-reviews').'</div>',
            'items' => $results,
        ]);
    }

    /**
     * @return void
     * @action site-reviews/route/ajax/search-translations
     */
    public function searchTranslationsAjax(Request $request)
    {
        if (empty($request->exclude)) {
            $request->exclude = [];
        }
        $results = glsr(Translation::class)
            ->search($request->search)
            ->exclude()
            ->exclude($request->exclude)
            ->renderResults();
        wp_send_json_success([
            'empty' => '<div>'._x('Nothing found.', 'admin-text', 'site-reviews').'</div>',
            'items' => $results,
        ]);
    }

    /**
     * @return void
     * @action site-reviews/route/ajax/search-users
     */
    public function searchUsersAjax(Request $request)
    {
        $results = glsr(Database::class)->searchUsers($request->search);
        wp_send_json_success([
            'empty' => '<div>'._x('Nothing found.', 'admin-text', 'site-reviews').'</div>',
            'items' => $results,
        ]);
    }

    /**
     * @return void
     * @action site-reviews/route/ajax/toggle-pinned
     */
    public function togglePinnedAjax(Request $request)
    {
        wp_send_json_success([
            'notices' => glsr(Notice::class)->get(),
            'pinned' => $this->execute(new TogglePinned($request->toArray())),
        ]);
    }

    /**
     * @return void
     * @action site-reviews/route/ajax/toggle-status
     */
    public function toggleStatusAjax(Request $request)
    {
        wp_send_json_success(
            $this->execute(new ToggleStatus($request->post_id, $request->status))
        );
    }
}


1		<?php
2
3		namespace GeminiLabs\SiteReviews\Controllers;
4
5		use GeminiLabs\SiteReviews\Commands\EnqueueAdminAssets;
6		use GeminiLabs\SiteReviews\Commands\ExportRatings;
7		use GeminiLabs\SiteReviews\Commands\ImportRatings;
8		use GeminiLabs\SiteReviews\Commands\RegisterTinymcePopups;
9		use GeminiLabs\SiteReviews\Commands\TogglePinned;
10		use GeminiLabs\SiteReviews\Commands\ToggleStatus;
11		use GeminiLabs\SiteReviews\Database;
12		use GeminiLabs\SiteReviews\Helpers\Arr;
13		use GeminiLabs\SiteReviews\Install;
14		use GeminiLabs\SiteReviews\Modules\Html\Builder;
15		use GeminiLabs\SiteReviews\Modules\Migrate;
16		use GeminiLabs\SiteReviews\Modules\Notice;
17		use GeminiLabs\SiteReviews\Modules\Translation;
18		use GeminiLabs\SiteReviews\Request;
19
20		class AdminController extends Controller
21		{
22		/**
23		* @return void
24		* @action site-reviews/export/cleanup
25		*/
26		public function cleanupAfterExport()
27		{
28		glsr(Database::class)->deleteMeta(glsr()->export_key);
29		}
30
31		/**
32		* @return void
33		* @action admin_enqueue_scripts
34		*/
35		public function enqueueAssets()
36		{
37		$this->execute(new EnqueueAdminAssets());
38		}
39
40		/**
41		* @return array
42		* @filter plugin_action_links_site-reviews/site-reviews.php
43		*/
44		public function filterActionLinks(array $links)
45		{
46		if (glsr()->hasPermission('settings')) {
47		$links['settings'] = glsr(Builder::class)->a([
48		'href' => admin_url('edit.php?post_type='.glsr()->post_type.'&page=settings'),
49		'text' => _x('Settings', 'admin-text', 'site-reviews'),
50		]);
51		}
52		if (glsr()->hasPermission('documentation')) {
53		$links['documentation'] = glsr(Builder::class)->a([
54		'href' => admin_url('edit.php?post_type='.glsr()->post_type.'&page=documentation'),
55		'text' => _x('Help', 'admin-text', 'site-reviews'),
56		]);
57		}
58		return $links;
59		}
60
61		/**
62		* @param array $capabilities
63		* @param string $capability
64		* @return array
65		* @filter map_meta_cap
66		*/
67	8	public function filterCreateCapability($capabilities, $capability)
68		{
69	8	if ($capability == 'create_'.glsr()->post_type) {
70		$capabilities[] = 'do_not_allow';
71		}
72	8	return $capabilities;
73		}
74
75		/**
76		* @param array $items
77		* @return array
78		* @filter dashboard_glance_items
79		*/
80		public function filterDashboardGlanceItems($items)
81		{
82		$postCount = wp_count_posts(glsr()->post_type);
83		if (empty($postCount->publish)) {
84		return $items;
85		}
86		$text = _nx('%s Review', '%s Reviews', $postCount->publish, 'admin-text', 'site-reviews');
87		$text = sprintf($text, number_format_i18n($postCount->publish));
88		$items = Arr::consolidate($items);
89		if (glsr()->can('edit_posts')) {
90		$items[] = glsr(Builder::class)->a($text, [
91		'class' => 'glsr-review-count',
92		'href' => 'edit.php?post_type='.glsr()->post_type,
93		]);
94		} else {
95		$items[] = glsr(Builder::class)->span($text, [
96		'class' => 'glsr-review-count',
97		]);
98		}
99		return $items;
100		}
101
102		/**
103		* @param array $args
104		* @return array
105		* @filter export_args
106		*/
107		public function filterExportArgs($args)
108		{
109		if (in_array(Arr::get($args, 'content'), ['all', glsr()->post_type])) {
110		$this->execute(new ExportRatings(glsr()->args($args)));
111		}
112		return $args;
113		}
114
115		/**
116		* @param array $plugins
117		* @return array
118		* @filter mce_external_plugins
119		*/
120		public function filterTinymcePlugins($plugins)
121		{
122		if (glsr()->can('edit_posts')) {
123		$plugins = Arr::consolidate($plugins);
124		$plugins['glsr_shortcode'] = glsr()->url('assets/scripts/mce-plugin.js');
125		}
126		return $plugins;
127		}
128
129		/**
130		* @return void
131		* @action admin_init
132		*/
133	7	public function onActivation()
134		{
135	7	if (empty(get_option(glsr()->prefix.'activated'))) {
136	7	glsr(Install::class)->run();
137	7	glsr(Migrate::class)->run();
138	7	update_option(glsr()->prefix.'activated', true);
139		}
140	7	}
141
142		/**
143		* @return void
144		* @action import_end
145		*/
146		public function onImportEnd()
147		{
148		$this->execute(new ImportRatings());
149		}
150
151		/**
152		* @return void
153		* @action admin_head
154		*/
155		public function printInlineStyle()
156		{
157		echo '<style type="text/css">a[href="edit.php?post_type=site-review&page=addons"]:not(.current):not(:hover) { color:#F6E05E!important; }</style>';
158		}
159
160		/**
161		* @return void
162		* @action admin_init
163		*/
164	7	public function registerTinymcePopups()
165		{
166	7	$this->execute(new RegisterTinymcePopups([
167	7	'site_reviews' => _x('Recent Reviews', 'admin-text', 'site-reviews'),
168	7	'site_reviews_form' => _x('Submit a Review', 'admin-text', 'site-reviews'),
169	7	'site_reviews_summary' => _x('Summary of Reviews', 'admin-text', 'site-reviews'),
170		]));
171	7	}
172
173		/**
174		* @param string $editorId
175		* @return void\|null
176		* @action media_buttons
177		*/
178		public function renderTinymceButton($editorId)
179		{
180		$allowedEditors = glsr()->filterArray('tinymce/editor-ids', ['content'], $editorId);
181		if ('post' !== glsr_current_screen()->base \|\| !in_array($editorId, $allowedEditors)) {
182		return;
183		}
184		$shortcodes = [];
185		foreach (glsr()->retrieve('mce', []) as $shortcode => $values) {
186		$shortcodes[$shortcode] = $values;
187		}
188		if (empty($shortcodes)) {
189		return;
190		}
191		glsr()->render('partials/editor/tinymce', [
192		'shortcodes' => $shortcodes,
193		]);
194		}
195
196		/**
197		* @return void
198		* @action site-reviews/route/ajax/search-posts
199		*/
200		public function searchPostsAjax(Request $request)
201		{
202		$results = glsr(Database::class)->searchPosts($request->search);
203		wp_send_json_success([
204		'empty' => '<div>'._x('Nothing found.', 'admin-text', 'site-reviews').'</div>',
205		'items' => $results,
206		]);
207		}
208
209		/**
210		* @return void
211		* @action site-reviews/route/ajax/search-translations
212		*/
213		public function searchTranslationsAjax(Request $request)
214		{
215		if (empty($request->exclude)) {
216		$request->exclude = [];
217		}
218		$results = glsr(Translation::class)
219		->search($request->search)
220		->exclude()
221		->exclude($request->exclude)
222		->renderResults();
223		wp_send_json_success([
224		'empty' => '<div>'._x('Nothing found.', 'admin-text', 'site-reviews').'</div>',
225		'items' => $results,
226		]);
227		}
228
229		/**
230		* @return void
231		* @action site-reviews/route/ajax/search-users
232		*/
233		public function searchUsersAjax(Request $request)
234		{
235		$results = glsr(Database::class)->searchUsers($request->search);
236		wp_send_json_success([
237		'empty' => '<div>'._x('Nothing found.', 'admin-text', 'site-reviews').'</div>',
238		'items' => $results,
239		]);
240		}
241
242		/**
243		* @return void
244		* @action site-reviews/route/ajax/toggle-pinned
245		*/
246		public function togglePinnedAjax(Request $request)
247		{
248		wp_send_json_success([
249		'notices' => glsr(Notice::class)->get(),
250		'pinned' => $this->execute(new TogglePinned($request->toArray())),
251		]);
252		}
253
254		/**
255		* @return void
256		* @action site-reviews/route/ajax/toggle-status
257		*/
258		public function toggleStatusAjax(Request $request)
259		{
260		wp_send_json_success(
261		$this->execute(new ToggleStatus($request->post_id, $request->status))
262		);
263		}
264		}
265

pryley / site-reviews

Push — master ( b694dd...6c1d9a )

AdminController::filterCreateCapability() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like