Feature/pt 2776 create entries toolbar configurator

CHANGELOG.md

@@ -46,7 +46,7 @@
 - Added the “Parse embeds” field setting. ([#409](https://github.com/craftcms/ckeditor/pull/409))
 - Added the “Show toolbar buttons for entry types with icons” field settings. ([#413](https://github.com/craftcms/ckeditor/pull/413))
 - Fixed an error that occurred when copy/pasting a nested entry from a top-level element’s CKEditor field into a nested element’s CKEditor field. ([#408](https://github.com/craftcms/ckeditor/issues/408))
-- Fixed an error that could occur when generating a GraphQL introspection schema, if a CKEditor field’s GraphQL Mode setting was set to “Full data”. ([#414](https://github.com/craftcms/ckeditor/issues/414))  
+- Fixed an error that could occur when generating a GraphQL introspection schema, if a CKEditor field’s GraphQL Mode setting was set to “Full data”. ([#414](https://github.com/craftcms/ckeditor/issues/414))
 
 ## 4.8.0 - 2025-04-30
 

src/CkeConfig.php

@@ -11,6 +11,9 @@
 use craft\base\Actionable;
 use craft\base\Chippable;
 use craft\base\Model;
+use craft\ckeditor\helpers\CkeditorConfig;
+use craft\ckeditor\models\EntryType as CkeEntryType;
+use craft\helpers\Cp;
 use craft\helpers\Json;
 use Illuminate\Support\Collection;
 use yii\base\InvalidArgumentException;
@@ -82,6 +85,13 @@ public static function get(int|string $id): ?static
      */
     public ?string $css = null;
 
+    /**
+     * @var CkeEntryType[] The field’s available entry types
+     * @see getEntryTypes()
+     * @see setEntryTypes()
+     */
+    private array $_entryTypes = [];
+
     public function __construct($config = [])
     {
         if (isset($config['toolbar']) && is_array($config['toolbar'])) {
@@ -118,6 +128,10 @@ public function __construct($config = [])
             }
         }
 
+        if (isset($config['entryTypes']) && $config['entryTypes'] === '') {
+            $config['entryTypes'] = [];
+        }
+
         unset($config['listPlugin']);
 
         parent::__construct($config);
@@ -305,6 +319,78 @@ function(string $attribute, ?array $params, Validator $validator) {
                 },
                 'when' => fn() => isset($this->_json),
             ],
+            ['entryTypes', function(string $attribute, ?array $params, Validator $validator) {
+                // ensure that each selected entry type has at least one of: withText, withIcon
+                foreach ($this->$attribute as $entryType) {
+                    if (!$entryType->withIcon && !$entryType->withText) {
+                        $validator->addError($this, $attribute, Craft::t('ckeditor', 'Each entry type must either have an icon or text.'));
+                    }
+                }
+            }],
         ];
     }
+
+    /**
+     * Returns the available entry types.
+     *
+     * @return CkeEntryType[]
+     * @since 5.0.0
+     */
+    public function getEntryTypes(): array
+    {
+        return $this->_entryTypes;
+    }
+
+    /**
+     * Sets the available entry types.
+     *
+     * @param array<string> $entryTypes The entry types, or their IDs or UUIDs
+     * @since 5.0.0
+     */
+    public function setEntryTypes(array $entryTypes): void
+    {
+        // normalize the $entryTypes; when saving the config, it'll be an array of json strings, like so:
+        foreach ($entryTypes as &$entryType) {
+            if (is_string($entryType)) {
+                try {
+                    $entryType = Json::decode($entryType);
+                } catch (InvalidArgumentException) {
+                    // do nothing?
+                }
+            }
+        }
+        unset($entryType);
+
+        foreach ($entryTypes as $entryType) {
+            /** @var array $entryType */
+            $this->_entryTypes[] = CkeditorConfig::getCkeEntryType($entryType);
+        }
+    }
+
+    /**
+     * Returns entry type options in form of an array with 'label' and 'value' keys for each option.
+     *
+     * @return array
+     * @since 5.0.0
+     */
+    public function getEntryTypeOptions(): array
+    {
+        $entryTypeOptions = [];
+
+        foreach ($this->getEntryTypes() as $entryType) {
+            $entryTypeOptions[] = [
+                'color' => $entryType->getColor()?->value,
+                'expanded' => $entryType['expanded'] ?? false,
+                'icon' => $entryType->icon ? Cp::iconSvg($entryType->icon) : null,
+                'label' => Craft::t('site', $entryType->name),
+                'uid' => $entryType->uid,
+                'value' => $entryType->id,
+                'withColor' => $entryType['withColor'] ?? true,
+                'withIcon' => $entryType['withIcon'] ?? true,
+                'withText' => $entryType['withText'] ?? true,
+            ];
+        }
+
+        return $entryTypeOptions;
+    }
 }

src/CkeConfigs.php

@@ -8,6 +8,7 @@
 namespace craft\ckeditor;
 
 use Craft;
+use craft\models\EntryType;
 use yii\base\Component;
 use yii\base\InvalidArgumentException;
 
@@ -40,15 +41,15 @@ public function getAll(): array
     /**
      * @throws InvalidArgumentException if $uid is invalid
      */
-    public function getByUid(string $uid): CkeConfig
+    public function getByUid(string $uid, bool $forToolbarEditor = false): CkeConfig
     {
         $config = Craft::$app->getProjectConfig()->get($this->_pcPath($uid));
 
         if ($config === null) {
             throw new InvalidArgumentException("Invalid CKEditor config UUID: $uid");
         }
 
-        $config = $this->_adjustConfig($config);
+        $config = $this->_adjustConfig($config, $forToolbarEditor);
 
         return new CkeConfig($config + ['uid' => $uid]);
     }
@@ -70,6 +71,10 @@ public function save(CkeConfig $ckeConfig, bool $runValidation = true): bool
             'options' => $ckeConfig->options,
             'js' => $ckeConfig->js,
             'css' => $ckeConfig->css,
+            'entryTypes' => array_map(
+                fn(EntryType $entryType) => $entryType->getUsageConfig(),
+                $ckeConfig->getEntryTypes(),
+            ),
         ], fn($item) => $item !== null));
 
         return true;
@@ -91,14 +96,28 @@ private function _pcPath(string $uid): string
      * @param array $config
      * @return array
      */
-    private function _adjustConfig(array $config): array
+    private function _adjustConfig(array $config, bool $forToolbarEditor = false): array
     {
         // rewrite anchor toolbar item to bookmark
         $key = array_search('anchor', $config['toolbar']);
         if ($key !== false) {
             $config['toolbar'][$key] = 'bookmark';
         }
 
+        // rewrite createEntry into per-entry-type buttons
+        if (!$forToolbarEditor && in_array('createEntry', $config['toolbar'])) {
+            if (!empty($config['entryTypes'])) {
+                // ensure the dropdown option is after the individual buttons
+                $key = array_search('createEntry', $config['toolbar']);
+                unset($config['toolbar'][$key]);
+                // create toolbar items for individual entry types
+                foreach ($config['entryTypes'] as $entryType) {
+                    $config['toolbar'][] = 'createEntry-' . $entryType['uid'];
+                }
+                $config['toolbar'][] = 'createEntry';
+            }
+        }
+
         return $config;
     }
 }

src/Field.php

@@ -53,7 +53,6 @@
 use craft\htmlfield\HtmlFieldData;
 use craft\i18n\Locale;
 use craft\models\CategoryGroup;
-use craft\models\EntryType;
 use craft\models\ImageTransform;
 use craft\models\Section;
 use craft\models\Volume;
@@ -453,26 +452,6 @@ private static function adjustFieldValues(
      */
     public bool $fullGraphqlData = true;
 
-    /**
-     * @var string|null The “New entry” button label.
-     * @since 4.0.0
-     * @deprecated in 4.8.0
-     */
-    public ?string $createButtonLabel = null;
-
-    /**
-     * @var bool Whether entry types with icons should be shown as separate buttons in the toolbar.
-     * @since 4.9.0
-     */
-    public bool $expandEntryButtons = false;
-
-    /**
-     * @var EntryType[] The field’s available entry types
-     * @see getEntryTypes()
-     * @see setEntryTypes()
-     */
-    private array $_entryTypes = [];
-
     /**
      * @inheritdoc
      */
@@ -483,6 +462,9 @@ public function __construct($config = [])
             $config['removeInlineStyles'],
             $config['removeEmptyTags'],
             $config['removeNbsp'],
+            $config['createButtonLabel'],
+            $config['entryTypes'],
+            $config['expandEntryButtons'],
         );
 
         if (isset($config['enableSourceEditingForNonAdmins'])) {
@@ -501,10 +483,6 @@ public function __construct($config = [])
             unset($config['limitUnit'], $config['fieldLimit']);
         }
 
-        if (isset($config['entryTypes']) && $config['entryTypes'] === '') {
-            $config['entryTypes'] = [];
-        }
-
         if (isset($config['graphqlMode'])) {
             $config['fullGraphqlData'] = ArrayHelper::remove($config, 'graphqlMode') === 'full';
         }
@@ -620,6 +598,7 @@ public function settingsAttributes(): array
     /**
      * @inheritdoc
      */
+
     public function getUriFormatForElement(NestedElementInterface $element): ?string
     {
         return null;
@@ -756,37 +735,12 @@ public function getSettingsHtml(): ?string
         ]);
     }
 
-    /**
-     * Returns the available entry types.
-     *
-     * @return EntryType[]
-     */
-    public function getEntryTypes(): array
-    {
-        return $this->_entryTypes;
-    }
-
-    /**
-     * Sets the available entry types.
-     *
-     * @param array<int|string|EntryType> $entryTypes The entry types, or their IDs or UUIDs
-     */
-    public function setEntryTypes(array $entryTypes): void
-    {
-        $entriesService = Craft::$app->getEntries();
-
-        $this->_entryTypes = array_values(array_filter(array_map(
-            fn($entryType) => $entriesService->getEntryType($entryType),
-            $entryTypes,
-        )));
-    }
-
     /**
      * @inheritdoc
      */
     public function getFieldLayoutProviders(): array
     {
-        return $this->getEntryTypes();
+        return $this->_ckeConfig()->getEntryTypes();
     }
 
     /**
@@ -801,11 +755,8 @@ public function getSettings(): array
             $settings['removeInlineStyles'],
             $settings['removeEmptyTags'],
             $settings['removeNbsp'],
-        );
-
-        $settings['entryTypes'] = array_map(
-            fn(EntryType $entryType) => $entryType->getUsageConfig(),
-            $this->getEntryTypes(),
+            $settings['entryTypes'],
+            $settings['createButtonLabel'],
         );
 
         return $settings;
@@ -1026,7 +977,8 @@ private function _inputHtml(mixed $value, ?ElementInterface $element, bool $stat
         $toolbar = array_merge($ckeConfig->toolbar);
 
         if (!$element?->id) {
-            ArrayHelper::removeValue($toolbar, 'createEntry');
+            // remove all toolbar items that start with 'createEntry'
+            $toolbar = array_filter($toolbar, fn($item) => !str_starts_with($item, 'createEntry'));
         }
 
         if (!$this->isSourceEditingAllowed(Craft::$app->getUser()->getIdentity())) {
@@ -1045,8 +997,7 @@ private function _inputHtml(mixed $value, ?ElementInterface $element, bool $stat
             'elementSiteId' => $element?->siteId,
             'accessibleFieldName' => $this->_accessibleFieldName($element),
             'describedBy' => $this->_describedBy($view),
-            'entryTypeOptions' => $this->_getEntryTypeOptions(),
-            'expandEntryButtons' => $this->expandEntryButtons,
+            'entryTypeOptions' => $ckeConfig->getEntryTypeOptions(),
             'findAndReplace' => [
                 'uiType' => 'dropdown',
             ],
@@ -1478,26 +1429,6 @@ protected function searchKeywords(mixed $value, ElementInterface $element): stri
         return $keywords;
     }
 
-    /**
-     * Returns entry type options in form of an array with 'label' and 'value' keys for each option.
-     *
-     * @return array
-     */
-    private function _getEntryTypeOptions(): array
-    {
-        $entryTypeOptions = array_map(
-            fn(EntryType $entryType) => [
-                'icon' => $entryType->icon ? Cp::iconSvg($entryType->icon) : null,
-                'color' => $entryType->getColor()?->value,
-                'label' => Craft::t('site', $entryType->name),
-                'value' => $entryType->id,
-            ],
-            $this->getEntryTypes(),
-        );
-
-        return $entryTypeOptions;
-    }
-
     /**
      * Normalizes <figure> tags, ensuring they have an `image` or `media` class depending on their contents,
      * and they contain a <div data-oembed-url> or <oembed> tag, depending on the `mediaEmbed.previewsInData`
@@ -1954,7 +1885,8 @@ private function _adjustPurifierConfig(HTMLPurifier_Config $purifierConfig): HTM
             $def?->addAttribute('ul', 'style', 'Text');
         }
 
-        if (in_array('createEntry', $ckeConfig->toolbar)) {
+        $createEntryToolbarItems = array_filter($ckeConfig->toolbar, fn($item) => str_starts_with($item, 'createEntry'));
+        if (!empty($createEntryToolbarItems)) {
             $def?->addElement('craft-entry', 'Inline', 'Inline', '', [
                 'data-entry-id' => 'Number',
                 'data-site-id' => 'Number',

src/Plugin.php

@@ -56,7 +56,7 @@ public static function registerCkeditorPackage(string $name, string $entry = 'in
     private static array $ckeditorPackages = [];
     private static array $ckeditorImports = [];
 
-    public string $schemaVersion = '3.0.0.0';
+    public string $schemaVersion = '5.0.0.0';
     public bool $hasCpSettings = true;
     public bool $hasReadOnlyCpSettings = true;