Craft 5 refactor

mmikkel · Oct 6, 2023 · e1fcaa4 · e1fcaa4
1 parent bf63f99
commit e1fcaa4
Show file tree

Hide file tree

Showing 13 changed files with 468 additions and 355 deletions.
diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
@@ -7,3 +7,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 ## 2.0.0
 ### Added
 - Added Craft 5 compatibility
+- Added fully functioning cogwheel buttons to Matrix sub fields (easy as pie, since they are all global now!)
+- Added "Edit entry type" buttons to Matrix blocks' action menus (again, easy as pie since everything is entries now!)
+### Improved
+- Improved performance
+- Improved accessibility
diff --git a/src/CpFieldInspect.php b/src/CpFieldInspect.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * CP Field Inspect plugin for Craft CMS 3.x
+ * CP Field Inspect plugin for Craft CMS 5.x
  *
  * Inspect field handles and easily edit field settings
  *
@@ -12,28 +12,28 @@
 
 use Craft;
 use craft\base\Element;
-use craft\base\ElementInterface;
+use craft\base\Field;
 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\CreateFieldLayoutFormEvent;
 use craft\events\DefineHtmlEvent;
 use craft\events\PluginEvent;
 use craft\events\TemplateEvent;
-use craft\helpers\UrlHelper;
+use craft\helpers\StringHelper;
+use craft\models\EntryType;
+use craft\models\FieldLayout;
+use craft\models\FieldLayoutTab;
 use craft\services\Plugins;
-use craft\web\Application;
-use craft\web\Controller;
 use craft\web\View;
 
-use mmikkel\cpfieldinspect\services\Redirect;
+use mmikkel\cpfieldinspect\fieldlayoutelements\EditSourceLink;
+use mmikkel\cpfieldinspect\helpers\CpFieldInspectHelper;
+use mmikkel\cpfieldinspect\web\CpFieldInspectBundle;
 
-use yii\base\ActionEvent;
 use yii\base\Event;
 
+
 /**
  * Class CpFieldInspect
  * @author Mats Mikkel Rummelhoff
@@ -42,7 +42,6 @@
  *
  * Plugin icon credit: CUSTOMIZE SEARCH by creative outlet from the Noun Project
  *
- * @property Redirect $redirect
  */
 class CpFieldInspect extends Plugin
 {
@@ -52,80 +51,83 @@ class CpFieldInspect extends Plugin
      */
     public function init(): void
     {
-        parent::init();
 
-        $this->setComponents([
-            'redirect' => Redirect::class,
-        ]);
+        parent::init();
 
+        // If admin changes are disallowed, we have no purpose.
         $allowAdminChanges = Craft::$app->getConfig()->getGeneral()->allowAdminChanges;
+        if (!$allowAdminChanges) {
+            return;
+        }
 
         // After installation, set the "Show field handles" user preference for active admin users
-        if ($allowAdminChanges) {
-            Event::on(
-                Plugins::class,
-                Plugins::EVENT_AFTER_INSTALL_PLUGIN,
-                function (PluginEvent $event) {
-                    if ($event->plugin !== $this) {
-                        return;
-                    }
-                    $adminUsers = User::find()->admin(true)->status('active')->all();
-                    foreach ($adminUsers as $adminUser) {
+        Event::on(
+            Plugins::class,
+            Plugins::EVENT_AFTER_INSTALL_PLUGIN,
+            function (PluginEvent $event) {
+                if ($event->plugin !== $this) {
+                    return;
+                }
+                $adminUsers = User::find()->admin()->status(User::STATUS_ACTIVE)->all();
+                foreach ($adminUsers as $adminUser) {
+                    try {
                         Craft::$app->getUsers()->saveUserPreferences($adminUser, [
                             'showFieldHandles' => true,
                         ]);
+                    } catch (\Throwable $e) {
+                        Craft::error($e, __METHOD__);
                     }
                 }
-            );
-        }
+            }
+        );
 
-        // Defer further initialisation to after plugins have loaded
-        // Or, do nothing if admin changes are not allowed, or if this isn't a CP web request
+        // At this point, we'll eject if this looks like anything other than a normal CP request
         $request = Craft::$app->getRequest();
-        if ($allowAdminChanges && $request->getIsCpRequest() && !$request->getIsConsoleRequest() && !$request->getIsLoginRequest()) {
-            Event::on(
-                Application::class,
-                Application::EVENT_INIT,
-                function () {
-                    $this->doIt();
-                }
-            );
+        if (!$request->getIsCpRequest() || $request->getIsConsoleRequest() || $request->getIsLoginRequest() || !$request->getIsGet()) {
+            return;
         }
 
-        Craft::info(
-            Craft::t(
-                'cp-field-inspect',
-                '{name} plugin loaded',
-                ['name' => $this->name]
-            ),
-            __METHOD__
-        );
-    }
+        // Defer further initialisation to after app init
+        Craft::$app->onInit(function () {
+            try {
+                $this->doIt();
+            } catch (\Throwable $e) {
+                Craft::error($e, __METHOD__);
+            }
+        });
 
-    // Protected Methods
-    // =========================================================================
+    }
 
     /**
      * @return void
-     * @throws \yii\base\Exception
-     * @throws \yii\base\InvalidConfigException
+     * @throws \Throwable
      */
     protected function doIt(): void
     {
 
-        // Do nothing if the user is not an admin
-        if (!Craft::$app->getUser()->getIsAdmin()) {
-            return;
-        }
-
-        // Also do nothing if the user doesn't have field handles visible
+        // Do nothing if the user is not an admin, or if they don't have field handles visible
         /** @var User $user */
         $user = Craft::$app->getUser()->getIdentity();
-        if (!$user->getPreference('showFieldHandles')) {
+        if (!$user?->admin || !$user->getPreference('showFieldHandles')) {
             return;
         }
 
-        $isCraft4 = \version_compare(Craft::$app->getVersion(), '4.0', '>=');
+        // Inject edit source buttons for elements that support the EVENT_DEFINE_META_FIELDS_HTML event
+        Event::on(
+            Element::class,
+            Element::EVENT_DEFINE_META_FIELDS_HTML,
+            function (DefineHtmlEvent $event) {
+                if ($event->static) {
+                    return;
+                }
+                $event->html .= CpFieldInspectHelper::getEditElementSourceButton($event->sender);
+            }
+        );
+
+        // Inject edit source buttons for elements that still use the old template hooks
+        Craft::$app->getView()->hook('cp.globals.edit.content', [CpFieldInspectHelper::class, 'renderEditSourceLink']);
+        Craft::$app->getView()->hook('cp.users.edit.details', [CpFieldInspectHelper::class, 'renderEditSourceLink']);
+        Craft::$app->getView()->hook('cp.commerce.product.edit.details', [CpFieldInspectHelper::class, 'renderEditSourceLink']);
 
         // Register asset bundle
         Event::on(
@@ -135,99 +137,10 @@ function (TemplateEvent $event) {
                 if ($event->templateMode !== View::TEMPLATE_MODE_CP) {
                     return;
                 }
-                $this->registerAssetBundle();
+                Craft::$app->getView()->registerAssetBundle(CpFieldInspectBundle::class, View::POS_END);
             }
         );
 
-        // Edit source links
-        if ($isCraft4) {
-
-            // 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]);
-                }
-            );
-
-        } else {
-
-            // Legacy template hooks for entries, assets and categories on Craft 3.x
-            Craft::$app->getView()->hook('cp.entries.edit.meta', [$this, 'renderEditSourceLink']);
-
-            Craft::$app->getView()->hook('cp.assets.edit.meta', [$this, 'renderEditSourceLink']);
-
-            Craft::$app->getView()->hook('cp.categories.edit.details', [$this, 'renderEditSourceLink']);
-
-        }
-
-        // Hooks that still work on both Craft 3.x and 4.x
-        Craft::$app->getView()->hook('cp.globals.edit.content', [$this, 'renderEditSourceLink']);
-
-        Craft::$app->getView()->hook('cp.users.edit.details', [$this, 'renderEditSourceLink']);
-
-        Craft::$app->getView()->hook('cp.commerce.product.edit.details', [$this, 'renderEditSourceLink']);
-
-    }
-
-    /**
-     * @return string
-     * @throws \Twig\Error\LoaderError
-     * @throws \Twig\Error\RuntimeError
-     * @throws \Twig\Error\SyntaxError
-     * @throws \Twig\Error\LoaderError
-     * @throws \yii\base\Exception
-     */
-    public 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 '';
-    }
-
-    /**
-     * @return void
-     * @throws \yii\base\Exception
-     * @throws \yii\base\InvalidConfigException
-     */
-    protected function registerAssetBundle(): void
-    {
-
-        $data = [
-            'editFieldBtnLabel' => Craft::t('cp-field-inspect', 'Edit field settings'),
-            'redirectUrl' => $this->redirect->getRedirectUrl(),
-        ];
-
-        $fields = Craft::$app->getFields()->getAllFields('global');
-
-        foreach ($fields as $field) {
-            $data['fields'][$field->handle] = (int)$field->id;
-        }
-
-        Craft::$app->getView()->registerAssetBundle(CpFieldInspectBundle::class, \yii\web\View::POS_END);
-        Craft::$app->getView()->registerJs('Craft.CpFieldInspectPlugin.init(' . \json_encode($data) . ');', \yii\web\View::POS_END);
-
     }
 
 }
diff --git a/src/CpFieldInspectBundle.php b/src/CpFieldInspectBundle.php
diff --git a/src/controllers/DefaultController.php b/src/controllers/DefaultController.php
@@ -5,10 +5,9 @@
 use Craft;
 use craft\web\Controller;
 
-use mmikkel\cpfieldinspect\CpFieldInspect;
+use mmikkel\cpfieldinspect\helpers\CpFieldInspectHelper;
 
 use yii\web\BadRequestHttpException;
-use yii\web\Response;
 
 class DefaultController extends Controller
 {
@@ -24,24 +23,24 @@ public function actionGetRedirectHash(): string
         $this->requireCpRequest();
         $this->requirePostRequest();
         $url = $this->request->getRequiredBodyParam('url');
-        if (!$url || !\is_string($url) || !$path = \parse_url($url, PHP_URL_PATH)) {
+        if (!$url || !is_string($url) || !$path = parse_url($url, PHP_URL_PATH)) {
             throw new BadRequestHttpException('Bad URL parameter');
         }
-        $segments = \array_values(\array_filter(\explode('/', $path)));
+        $segments = array_values(array_filter(explode('/', $path)));
         $cpTrigger = Craft::$app->getConfig()->getGeneral()->cpTrigger;
         if ($segments[0] === $cpTrigger) {
-            \array_shift($segments);
+            array_shift($segments);
         }
-        $redirectTo = \implode('/', $segments);
-        $queryString = \parse_url($url, PHP_URL_QUERY);
+        $redirectTo = implode('/', $segments);
+        $queryString = parse_url($url, PHP_URL_QUERY);
         if ($queryString) {
             $redirectTo .= "?{$queryString}";
         }
-        $hashbang = \parse_url($url, PHP_URL_FRAGMENT);
+        $hashbang = parse_url($url, PHP_URL_FRAGMENT);
         if ($hashbang) {
             $redirectTo .= "#{$hashbang}";
         }
-        return CpFieldInspect::getInstance()->redirect->getRedirectUrl($redirectTo);
+        return CpFieldInspectHelper::getRedirectUrl($redirectTo);
     }
 
 }