mmikkel\cpfieldinspect\CpFieldInspect

Complexity

Total Complexity

20

Size/Duplication

Total Lines	175
Duplicated Lines	0 %

Importance

Changes	6
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	doIt()	0	54	8
B	renderEditSourceLink()	0	28	9
A	init()	0	45	3

<?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\ElementInterface;
use craft\base\Plugin;
use craft\elements\Asset;
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;

        $request = Craft::$app->getRequest();

        if (!$request->getIsCpRequest() || $request->getIsConsoleRequest()) {
            return;
        }

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

        /**
         * Logging in Craft involves using one of the following methods:
         *
         * Craft::trace(): record a message to trace how a piece of code runs. This is mainly for development use.
         * Craft::info(): record a message that conveys some useful information.
         * Craft::warning(): record a warning message that indicates something unexpected has happened.
         * Craft::error(): record a fatal error that should be investigated as soon as possible.
         *
         * Unless `devMode` is on, only Craft::warning() & Craft::error() will log to `craft/storage/logs/web.log`
         *
         * It's recommended that you pass in the magic constant `__METHOD__` as the second parameter, which sets
         * the category to the method (prefixed with the fully qualified class name) where the constant appears.
         *
         * To enable the Yii debug toolbar, go to your user account in the AdminCP and check the
         * [] Show the debug toolbar on the front end & [] Show the debug toolbar on the Control Panel
         *
         * http://www.yiiframework.com/doc-2.0/guide-runtime-logging.html
         */
        Craft::info(
            Craft::t(
                'cp-field-inspect',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

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

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

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

        $user = Craft::$app->getUser();
        if (!$user->getIsAdmin()) {
            return;
        }

        // Template hooks
        $view = Craft::$app->getView();
        $view->hook('cp.assets.edit.meta', [$this, 'renderEditSourceLink']);
        $view->hook('cp.entries.edit.meta', [$this, 'renderEditSourceLink']);
        $view->hook('cp.globals.edit.content', [$this, 'renderEditSourceLink']);
        $view->hook('cp.users.edit.details', [$this, 'renderEditSourceLink']);
        $view->hook('cp.categories.edit.details', [$this, 'renderEditSourceLink']);
        $view->hook('cp.commerce.product.edit.details', [$this, 'renderEditSourceLink']);
        $view->hook('cp.commerce.order.edit.main-pane', [$this, 'renderEditSourceLink']);

        $request = Craft::$app->getRequest();

        if ($request->getIsAjax()) {

            if (!$request->getIsPost()) {
                return;
            }

            $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 = [
                'fields' => [],
                'redirectUrl' => Craft::$app->getSecurity()->hashData($redirectUrl),
            ];

            $fields = Craft::$app->getFields()->getAllFields();

            foreach ($fields as $field) {

                $data['fields'][$field->handle] = [
                    'id' => $field->id,
                    'handle' => $field->handle,
                ];
            }

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

}