diff --git a/ReadMe.md b/ReadMe.md index 97fb306..2f8fcb4 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -7,7 +7,8 @@ module. With this you can enable specific UI styles for desired paragraph type. Install as usual any other Drupal module using ### Getting Started -- Create/edit a paragraph type (admin > structure > paragraph types) for which you want to enable UI Styles. +- Create/edit a paragraph type (admin > structure > paragraph types) for which + you want to enable UI Styles. - Enable the “UI Styles options†paragraph behavior for your paragraph type, and select one or more UI styles you wish to make available. - Now on add/edit paragraph form you will see enabled styles. diff --git a/src/Plugin/paragraphs/Behavior/UIStyleOptions.php b/src/Plugin/paragraphs/Behavior/UIStyleOptions.php index d27317d..66aecc8 100644 --- a/src/Plugin/paragraphs/Behavior/UIStyleOptions.php +++ b/src/Plugin/paragraphs/Behavior/UIStyleOptions.php @@ -27,8 +27,12 @@ use Symfony\Component\DependencyInjection\ContainerInterface; */ class UIStyleOptions extends ParagraphsBehaviorBase { - /** @var \Drupal\ui_styles\StylePluginManagerInterface */ - protected StylePluginManagerInterface $ui_styles_manager; + /** + * Style Plugin Manager Interface. + * + * @var \Drupal\ui_styles\StylePluginManagerInterface + */ + protected StylePluginManagerInterface $uiStylesManager; /** * The transliteration service. @@ -43,22 +47,35 @@ class UIStyleOptions extends ParagraphsBehaviorBase { public const MULTIPLE_GROUPS_KEY = 'ui_styles_groups'; /** + * {@inheritdoc} + * * @param array $configuration - * @param $plugin_id - * @param $plugin_definition + * Configuration. + * @param string $plugin_id + * Plugin ID. + * @param string $plugin_definition + * Plugin Definition. * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager - * @param \Drupal\ui_styles\StylePluginManager $ui_styles_manager + * Entity Field manager. + * @param \Drupal\ui_styles\StylePluginManager $uiStylesManager + * UI styles manager. * @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration + * Transliteration Interface. */ - public function __construct(array $configuration, $plugin_id, $plugin_definition, + public function __construct(array $configuration, + $plugin_id, + $plugin_definition, EntityFieldManagerInterface $entity_field_manager, - StylePluginManager $ui_styles_manager, - TransliterationInterface $transliteration) { + StylePluginManager $uiStylesManager, + TransliterationInterface $transliteration) { parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_field_manager); - $this->ui_styles_manager = $ui_styles_manager; + $this->uiStylesManager = $uiStylesManager; $this->transliteration = $transliteration; } + /** + * {@inheritdoc} + */ public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { return new static( $configuration, @@ -77,7 +94,7 @@ class UIStyleOptions extends ParagraphsBehaviorBase { $enabled_style_ids = $this->getEnabledStyles(); $def = []; foreach ($enabled_style_ids as $id) { - $def[] = $this->ui_styles_manager->getDefinition($id); + $def[] = $this->uiStylesManager->getDefinition($id); } // Load selected values. $selected = $this->getFlattenedSettings($paragraph); @@ -118,7 +135,7 @@ class UIStyleOptions extends ParagraphsBehaviorBase { */ public function view(array &$build, Paragraph $paragraph, EntityViewDisplayInterface $display, $view_mode) { $classes = $this->getFlattenedSettings($paragraph); - foreach ($classes as $key => $class) { + foreach ($classes as $class) { if ($class) { $build['#attributes']['class'][] = $class; } @@ -129,7 +146,7 @@ class UIStyleOptions extends ParagraphsBehaviorBase { * {@inheritdoc} */ public function buildConfigurationForm(array $form, FormStateInterface $form_state) { - $grouped_plugin_definitions = $this->ui_styles_manager->getGroupedDefinitions(); + $grouped_plugin_definitions = $this->uiStylesManager->getGroupedDefinitions(); if (empty($grouped_plugin_definitions)) { return $form; } @@ -253,9 +270,10 @@ class UIStyleOptions extends ParagraphsBehaviorBase { * Get settings for paragraph as flattened array. * * @param \Drupal\paragraphs\Entity\Paragraph $paragraph - * The paragraph entity. + * The paragraph entity. + * * @return array - * Flattened array. + * Flattened array. */ public function getFlattenedSettings(Paragraph $paragraph): array { $values = $paragraph->getBehaviorSetting($this->pluginId, []);