CpFieldInspect::doIt() - Code Metrics - Inspection of "Make Scrutinizr happy" - mmikkel/CpFieldInspect-Craft - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ecac3e...b0b3b0 )

by M. Mikkel

created 2022-03-17 10:44 UTC

CpFieldInspect::doIt() C

↳ Parent: CpFieldInspect

Complexity

Conditions	12
Paths	17

Size

Total Lines	79
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Importance

Changes	8
Bugs	0	Features	0

Metric	Value
cc	12
eloc	42
c	8
b	0
f	0
nc	17
nop	0
dl	0
loc	79
rs	6.9666

How to fix Long Method Complexity

<?php
/**
 * CP Field Inspect plugin for Craft CMS 3.x
 *
 * Inspect field handles and easily edit field settings
 *
 * @link      http://mmikkel.no
 * @copyright Copyright (c) 2017 Mats Mikkel Rummelhoff
 */

namespace mmikkel\cpfieldinspect;

use Craft;
use craft\base\Element;
use craft\base\ElementInterface;
use craft\base\Plugin;
use craft\commerce\elements\Product;
use craft\elements\Asset;
use craft\elements\Category;
use craft\elements\Entry;
use craft\elements\GlobalSet;
use craft\elements\User;
use craft\events\DefineHtmlEvent;
use craft\events\PluginEvent;
use craft\helpers\UrlHelper;
use craft\services\Plugins;

use yii\base\Event;

/**
 * Craft plugins are very much like little applications in and of themselves. We’ve made
 * it as simple as we can, but the training wheels are off. A little prior knowledge is
 * going to be required to write a plugin.
 *
 * For the purposes of the plugin docs, we’re going to assume that you know PHP and SQL,
 * as well as some semi-advanced concepts like object-oriented programming and PHP namespaces.
 *
 * https://craftcms.com/docs/plugins/introduction
 *
 * @author    Mats Mikkel Rummelhoff
 * @package   CpFieldInspect
 * @since     1.0.0
 *
 *
 * Plugin icon credit: CUSTOMIZE SEARCH by creative outlet from the Noun Project
 *
 */

/**
 * Class CpFieldInspect
 * @package mmikkel\cpfieldinspect
 *
 */
class CpFieldInspect extends Plugin
{
    // Static Properties
    // =========================================================================

    /**
     * Static property that is an instance of this plugin class so that it can be accessed via
     * CpFieldInspect::$plugin
     *
     * @var CpFieldInspect
     */
    public static $plugin;

    // Public Methods
    // =========================================================================

    /**
     * Set our $plugin static property to this class so that it can be accessed via
     * CpFieldInspect::$plugin
     *
     * Called after the plugin class is instantiated; do any one-time initialization
     * here such as hooks and events.
     *
     * If you have a '/vendor/autoload.php' file, it will be loaded for you automatically;
     * you do not need to load it in your init() method.
     *
     */
    public function init()
    {
        parent::init();
        self::$plugin = $this;

        $config = Craft::$app->getConfig()->getGeneral();
        if (!$config->allowAdminChanges) {
            // Do nothing if admin changes aren't allowed
            return;
        }

        $request = Craft::$app->getRequest();
        if (!$request->getIsCpRequest() || $request->getIsConsoleRequest()) {
            // Also do nothing if this is a console or site request
            return;
        }

        // Handler: EVENT_AFTER_LOAD_PLUGINS
        Event::on(
            Plugins::class,
            Plugins::EVENT_AFTER_LOAD_PLUGINS,
            function () {
                $this->doIt();
            }
        );

        Craft::info(
            Craft::t(
                'cp-field-inspect',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    // Protected Methods
    // =========================================================================

    /**
     * @throws \yii\base\Exception
     * @throws \yii\base\InvalidConfigException
     */
    protected function doIt()
    {

        /** @var User|null $user */
        $user = Craft::$app->getUser()->getIdentity();
        if (!$user || !$user->admin || !$user->getPreference('showFieldHandles')) {

            // Do nothing if the user is not an admin, or if field handles aren't visible
            return;
        }

        // Render edit source links
        if (\version_compare(Craft::$app->getVersion(), '4.0', '<')) {

            // Legacy template hooks for entries, assets and categories on Craft 3.x
            Craft::$app->getView()->hook('cp.entries.edit.meta', function (array $context) {
                return $this->renderEditSourceLink($context);
            });
            Craft::$app->getView()->hook('cp.assets.edit.meta', function (array $context) {
                return $this->renderEditSourceLink($context);
            });
            Craft::$app->getView()->hook('cp.categories.edit.details', function (array $context) {
                return $this->renderEditSourceLink($context);
            });

        } else {

            // Use the EVENT_DEFINE_META_FIELDS_HTML event to inject source buttons for Craft 4
            Event::on(
                Element::class,
                Element::EVENT_DEFINE_META_FIELDS_HTML,
                function (DefineHtmlEvent $event) {
                    if ($event->static) {
                        return;
                    }
                    $event->html .= $this->renderEditSourceLink(['element' => $event->sender]);
                }
            );
        }

        // Hooks that work on Craft 3.x and 4.x
        Craft::$app->getView()->hook('cp.globals.edit.content', function (array $context) {
            return $this->renderEditSourceLink($context);
        });
        Craft::$app->getView()->hook('cp.users.edit.details', function (array $context) {
            return $this->renderEditSourceLink($context);
        });
        Craft::$app->getView()->hook('cp.commerce.product.edit.details', function (array $context) {
            return $this->renderEditSourceLink($context);
        });

        $request = Craft::$app->getRequest();
        $isAjax = $request->getIsAjax() || $request->getAcceptsJson();

        if ($isAjax) {

            $segments = $request->getActionSegments();
            if (empty($segments) || !\is_array($segments) || $segments[count($segments) - 1] !== 'get-editor-html') {
                return;
            }

            Craft::$app->getView()->registerJs('Craft.CpFieldInspectPlugin.initElementEditor();');

        } else {

            $redirectUrl = \implode('?', \array_filter([\implode('/', $request->getSegments()), $request->getQueryStringWithoutPath()]));

            $data = [
                'editFieldBtnLabel' => Craft::t('cp-field-inspect', 'Edit field settings'),
                'baseEditFieldUrl' => \rtrim(UrlHelper::cpUrl('settings/fields/edit'), '/'),
                'redirectUrl' => Craft::$app->getSecurity()->hashData($redirectUrl, Craft::$app->getConfig()->getGeneral()->securityKey),
            ];

            $fields = Craft::$app->getFields()->getAllFields('global');
            foreach ($fields as $field) {
                $data['fields'][$field->handle] = (int)$field->id;
            }

            Craft::$app->getView()->registerAssetBundle(CpFieldInspectBundle::class);
            Craft::$app->getView()->registerJs('Craft.CpFieldInspectPlugin.init(' . \json_encode($data) . ');');
        }
    }

    /**
     * @return string
     * @throws \Twig\Error\LoaderError
     * @throws \Twig\Error\RuntimeError
     * @throws \Twig\Error\SyntaxError
     * @throws \Twig\Error\LoaderError
     * @throws \yii\base\Exception
     */
    protected function renderEditSourceLink(array $context): string
    {
        $element = $context['element'] ?? $context['entry'] ?? $context['asset'] ?? $context['globalSet'] ?? $context['user'] ?? $context['category'] ?? $context['product'] ?? null;
        if ($element instanceof Entry) {
            return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-entry-type-link', ['entry' => $element]);
        }
        if ($element instanceof Asset) {
            return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-volume-link', ['asset' => $element]);
        }
        if ($element instanceof GlobalSet) {
            return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-globalset-link', ['globalSet' => $element]);
        }
        if ($element instanceof User) {
            return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-users-link', ['user' => $element]);
        }
        if ($element instanceof Category) {
            return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-category-group-link', ['category' => $element]);
        }
        if ($element instanceof Product) {
            return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-commerce-product-type-link', ['product' => $element]);
        }
        return '';
    }

}


1			<?php
2			/**
3			* CP Field Inspect plugin for Craft CMS 3.x
4			*
5			* Inspect field handles and easily edit field settings
6			*
7			* @link http://mmikkel.no
8			* @copyright Copyright (c) 2017 Mats Mikkel Rummelhoff
9			*/
10
11			namespace mmikkel\cpfieldinspect;
12
13			use Craft;
14			use craft\base\Element;
15			use craft\base\ElementInterface;
16			use craft\base\Plugin;
17			use craft\commerce\elements\Product;
18			use craft\elements\Asset;
19			use craft\elements\Category;
20			use craft\elements\Entry;
21			use craft\elements\GlobalSet;
22			use craft\elements\User;
23			use craft\events\DefineHtmlEvent;
24			use craft\events\PluginEvent;
25			use craft\helpers\UrlHelper;
26			use craft\services\Plugins;
27
28			use yii\base\Event;
29
30			/**
31			* Craft plugins are very much like little applications in and of themselves. We’ve made
32			* it as simple as we can, but the training wheels are off. A little prior knowledge is
33			* going to be required to write a plugin.
34			*
35			* For the purposes of the plugin docs, we’re going to assume that you know PHP and SQL,
36			* as well as some semi-advanced concepts like object-oriented programming and PHP namespaces.
37			*
38			* https://craftcms.com/docs/plugins/introduction
39			*
40			* @author Mats Mikkel Rummelhoff
41			* @package CpFieldInspect
42			* @since 1.0.0
43			*
44			*
45			* Plugin icon credit: CUSTOMIZE SEARCH by creative outlet from the Noun Project
46			*
47			*/
48
49			/**
50			* Class CpFieldInspect
51			* @package mmikkel\cpfieldinspect
52			*
53			*/
54			class CpFieldInspect extends Plugin
55			{
56			// Static Properties
57			// =========================================================================
58
59			/**
60			* Static property that is an instance of this plugin class so that it can be accessed via
61			* CpFieldInspect::$plugin
62			*
63			* @var CpFieldInspect
64			*/
65			public static $plugin;
66
67			// Public Methods
68			// =========================================================================
69
70			/**
71			* Set our $plugin static property to this class so that it can be accessed via
72			* CpFieldInspect::$plugin
73			*
74			* Called after the plugin class is instantiated; do any one-time initialization
75			* here such as hooks and events.
76			*
77			* If you have a '/vendor/autoload.php' file, it will be loaded for you automatically;
78			* you do not need to load it in your init() method.
79			*
80			*/
81			public function init()
82			{
83			parent::init();
84			self::$plugin = $this;
85
86			$config = Craft::$app->getConfig()->getGeneral();
87			if (!$config->allowAdminChanges) {
88			// Do nothing if admin changes aren't allowed
89			return;
90			}
91
92			$request = Craft::$app->getRequest();
93			if (!$request->getIsCpRequest() \|\| $request->getIsConsoleRequest()) {
94			// Also do nothing if this is a console or site request
95			return;
96			}
97
98			// Handler: EVENT_AFTER_LOAD_PLUGINS
99			Event::on(
100			Plugins::class,
101			Plugins::EVENT_AFTER_LOAD_PLUGINS,
102			function () {
103			$this->doIt();
104			}
105			);
106
107			Craft::info(
108			Craft::t(
109			'cp-field-inspect',
110			'{name} plugin loaded',
111			['name' => $this->name]
112			),
113			__METHOD__
114			);
115			}
116
117			// Protected Methods
118			// =========================================================================
119
120			/**
121			* @throws \yii\base\Exception
122			* @throws \yii\base\InvalidConfigException
123			*/
124			protected function doIt()
125			{
126
127			/** @var User\|null $user */
128			$user = Craft::$app->getUser()->getIdentity();
129			if (!$user \|\| !$user->admin \|\| !$user->getPreference('showFieldHandles')) {
			0 ignored issues – show introduced 2022-03-17 10:48 UTC by Report Bug Copy Issue Report `$user` is of type `craft\elements\User`, thus it always evaluated to `true`. Loading history...
130			// Do nothing if the user is not an admin, or if field handles aren't visible
131			return;
132			}
133
134			// Render edit source links
135			if (\version_compare(Craft::$app->getVersion(), '4.0', '<')) {
136
137			// Legacy template hooks for entries, assets and categories on Craft 3.x
138			Craft::$app->getView()->hook('cp.entries.edit.meta', function (array $context) {
139			return $this->renderEditSourceLink($context);
140			});
141			Craft::$app->getView()->hook('cp.assets.edit.meta', function (array $context) {
142			return $this->renderEditSourceLink($context);
143			});
144			Craft::$app->getView()->hook('cp.categories.edit.details', function (array $context) {
145			return $this->renderEditSourceLink($context);
146			});
147
148			} else {
149
150			// Use the EVENT_DEFINE_META_FIELDS_HTML event to inject source buttons for Craft 4
151			Event::on(
152			Element::class,
153			Element::EVENT_DEFINE_META_FIELDS_HTML,
154			function (DefineHtmlEvent $event) {
155			if ($event->static) {
156			return;
157			}
158			$event->html .= $this->renderEditSourceLink(['element' => $event->sender]);
159			}
160			);
161			}
162
163			// Hooks that work on Craft 3.x and 4.x
164			Craft::$app->getView()->hook('cp.globals.edit.content', function (array $context) {
165			return $this->renderEditSourceLink($context);
166			});
167			Craft::$app->getView()->hook('cp.users.edit.details', function (array $context) {
168			return $this->renderEditSourceLink($context);
169			});
170			Craft::$app->getView()->hook('cp.commerce.product.edit.details', function (array $context) {
171			return $this->renderEditSourceLink($context);
172			});
173
174			$request = Craft::$app->getRequest();
175			$isAjax = $request->getIsAjax() \|\| $request->getAcceptsJson();
176
177			if ($isAjax) {
178
179			$segments = $request->getActionSegments();
180			if (empty($segments) \|\| !\is_array($segments) \|\| $segments[count($segments) - 1] !== 'get-editor-html') {
181			return;
182			}
183
184			Craft::$app->getView()->registerJs('Craft.CpFieldInspectPlugin.initElementEditor();');
185
186			} else {
187
188			$redirectUrl = \implode('?', \array_filter([\implode('/', $request->getSegments()), $request->getQueryStringWithoutPath()]));
189
190			$data = [
191			'editFieldBtnLabel' => Craft::t('cp-field-inspect', 'Edit field settings'),
192			'baseEditFieldUrl' => \rtrim(UrlHelper::cpUrl('settings/fields/edit'), '/'),
193			'redirectUrl' => Craft::$app->getSecurity()->hashData($redirectUrl, Craft::$app->getConfig()->getGeneral()->securityKey),
194			];
195
196			$fields = Craft::$app->getFields()->getAllFields('global');
197			foreach ($fields as $field) {
198			$data['fields'][$field->handle] = (int)$field->id;
199			}
200
201			Craft::$app->getView()->registerAssetBundle(CpFieldInspectBundle::class);
202			Craft::$app->getView()->registerJs('Craft.CpFieldInspectPlugin.init(' . \json_encode($data) . ');');
203			}
204			}
205
206			/**
207			* @return string
208			* @throws \Twig\Error\LoaderError
209			* @throws \Twig\Error\RuntimeError
210			* @throws \Twig\Error\SyntaxError
211			* @throws \Twig\Error\LoaderError
212			* @throws \yii\base\Exception
213			*/
214			protected function renderEditSourceLink(array $context): string
215			{
216			$element = $context['element'] ?? $context['entry'] ?? $context['asset'] ?? $context['globalSet'] ?? $context['user'] ?? $context['category'] ?? $context['product'] ?? null;
217			if ($element instanceof Entry) {
218			return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-entry-type-link', ['entry' => $element]);
219			}
220			if ($element instanceof Asset) {
221			return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-volume-link', ['asset' => $element]);
222			}
223			if ($element instanceof GlobalSet) {
224			return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-globalset-link', ['globalSet' => $element]);
225			}
226			if ($element instanceof User) {
227			return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-users-link', ['user' => $element]);
228			}
229			if ($element instanceof Category) {
230			return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-category-group-link', ['category' => $element]);
231			}
232			if ($element instanceof Product) {
233			return Craft::$app->getView()->renderTemplate('cp-field-inspect/edit-commerce-product-type-link', ['product' => $element]);
234			}
235			return '';
236			}
237
238			}
239

mmikkel / CpFieldInspect-Craft

Push — master ( ecac3e...b0b3b0 )

CpFieldInspect::doIt() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like