diff --git a/README.md b/README.md index d4a0a8e..76a08a3 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,32 @@ # Custom elements Custom elements modules allows to render content entities as custom elements. - + ## Overview -Renders entities into custom elements markup that can be picked up for client-side rendering. It renders the data of all -visible fields either as attribute to the custom element tag, or as nested tag with a slot attribute. +Renders entities into custom elements markup that can be picked up for +client-side rendering. It renders the data of all visible fields either as +attribute to the custom element tag, or as nested tag with a slot attribute. -Custom element attributes may be picked up as property during client-side rendering. +Custom element attributes may be picked up as property during client-side +rendering. -Slots are a useful way for content distribution in [Vue.js - thus the rendered slots can be used directly by the Vue.js -[slot implementation](https://vuejs.org/v2/guide/components.html#Content-Distribution-with-Slots). But the concept can -be used with out client-side libraries as well, e.g. see https://github.com/dschnare/react-slot for a React based -solution. +Slots are a useful way for content distribution in [Vue.js - thus the rendered +slots can be used directly by the Vue.js +[slot implementation](https://vuejs.org/v2/guide/components.html#Content-Distribution-with-Slots). +But the concept can be used with out client-side libraries as well, e.g. see +https://github.com/dschnare/react-slot for a React based solution. ## How it works -The module takes over render for all view-modes that are prefixed with `custom_elements` - thus to render content -entity as custom elements you just need to introduce custom view mode with `custom_elements` prefix. Every entity render -with such a view mode is then automatically processed. +The module takes over render for all view-modes that are prefixed with +`custom_elements` - thus to render content entity as custom elements you just +need to introduce custom view mode with `custom_elements` prefix. Every entity +render with such a view mode is then automatically processed. -In order to make client-side rendering possible, the necessary client libraries may be added to the -custom_elements/main library, which the module is attaching to custom element markup. +In order to make client-side rendering possible, the necessary client libraries +may be added to the custom_elements/main library, which the module is attaching +to custom element markup. ## Example @@ -87,4 +92,4 @@ Other field types as considered as complex fields and are rendered within ## Credits - [Österreichischer Wirtschaftsverlag GmbH](https://www.drupal.org/%C3%B6sterreichischer-wirtschaftsverlag-gmbh): Initiator, Sponsor - - [drunomics GmbH](https://www.drupal.org/drunomics): Concept, Development, Maintenance \ No newline at end of file + - [drunomics GmbH](https://www.drupal.org/drunomics): Concept, Development, Maintenance diff --git a/modules/custom_elements_everywhere/custom_elements_everywhere.module b/modules/custom_elements_everywhere/custom_elements_everywhere.module index 84cefab..82bfa52 100644 --- a/modules/custom_elements_everywhere/custom_elements_everywhere.module +++ b/modules/custom_elements_everywhere/custom_elements_everywhere.module @@ -11,9 +11,10 @@ function custom_elements_everywhere_entity_prepare_view($entity_type_id, array $entities, array $displays, $view_mode) { if (!\Drupal::service('router.admin_context')->isAdminRoute()) { // Use this hook for enabling custom elements rendering since it applies - // to all proper entity rendering, but not to single-field rendered displays. - // Single field rendered displayed should be rendered as usual, such that - // custom elements processor may use it to render individual fields. + // to all proper entity rendering, but not to single-field rendered + // displays. Single field rendered displayed should be rendered as usual, + // such that custom elements processor may use it to render individual + // fields. foreach ($displays as $display) { $display->setThirdPartySetting('custom_elements', 'enabled', 1); } diff --git a/modules/custom_elements_thunder/src/Processor/ParagraphGalleryProcessor.php b/modules/custom_elements_thunder/src/Processor/ParagraphGalleryProcessor.php index bee927d..9d64666 100644 --- a/modules/custom_elements_thunder/src/Processor/ParagraphGalleryProcessor.php +++ b/modules/custom_elements_thunder/src/Processor/ParagraphGalleryProcessor.php @@ -1,6 +1,5 @@ getEntityTypeId() == 'paragraph' && - $data->bundle() =='twitter'; + $data->bundle() == 'twitter'; } else { return FALSE; diff --git a/modules/custom_elements_thunder/src/Processor/ParagraphVideoProcessor.php b/modules/custom_elements_thunder/src/Processor/ParagraphVideoProcessor.php index 9e8714f..594744d 100644 --- a/modules/custom_elements_thunder/src/Processor/ParagraphVideoProcessor.php +++ b/modules/custom_elements_thunder/src/Processor/ParagraphVideoProcessor.php @@ -1,6 +1,5 @@ element. * - * @param array $build + * @param array $render * The render array. * * @return \Drupal\custom_elements\CustomElement|mixed + * Created custom element. */ public static function createFromRenderArray(array $render) { if (isset($render['#custom_element'])) { @@ -256,7 +257,7 @@ class CustomElement implements CacheableDependencyInterface { * * @return $this */ - public function setSlotFromRenderArray($key, array $build, $tag = 'div', $attributes = [], $index = NULL, $weight = 0) { + public function setSlotFromRenderArray($key, array $build, $tag = 'div', array $attributes = [], $index = NULL, $weight = 0) { $markup = \Drupal::service('renderer')->renderPlain($build); // Add cache metadata as needed from the cache metadata attached to the // render array. @@ -284,7 +285,7 @@ class CustomElement implements CacheableDependencyInterface { * * @return $this */ - public function setSlot($key, $value, $tag = 'div', $attributes = [], $index = NULL, $weight = 0) { + public function setSlot($key, $value, $tag = 'div', array $attributes = [], $index = NULL, $weight = 0) { if (in_array($tag, static::$noEndTags) && !empty($value)) { throw new \LogicException(sprintf('Tag %s is no-end tag and should not have a content.', $tag)); } @@ -311,7 +312,8 @@ class CustomElement implements CacheableDependencyInterface { $value = Markup::create((string) $value); } - // If markup and attributes are given, we need to wrap the content in another custom element. + // If markup and attributes are given, we need to wrap the content in + // another custom element. if ($value && ($attributes || ($tag != 'div' && $tag != 'span'))) { $slot = CustomElement::create($tag) ->setAttributes($attributes) @@ -332,7 +334,7 @@ class CustomElement implements CacheableDependencyInterface { $this->slots[$key][$index] = [ 'weight' => $weight, 'key' => $key, - 'content' => $slot + 'content' => $slot, ]; return $this; @@ -353,8 +355,9 @@ class CustomElement implements CacheableDependencyInterface { * (optional) A weight for ordering output slots. Defaults to 0. * * @return $this + * The CustomElement object. */ - public function addSlot($key, $value, $tag = 'div', $attributes = [], $weight = 0) { + public function addSlot($key, $value, $tag = 'div', array $attributes = [], $weight = 0) { return $this->setSlot($key, $value, $tag, $attributes, $this->getIndexForNewSlotEntry($key), $weight); } @@ -370,7 +373,7 @@ class CustomElement implements CacheableDependencyInterface { // Determine last index. if (isset($this->slots[$key])) { // Determine array index by appending a new one. ::setSlot() will - // overwrite the array with the right slot array afterwards. + // overwrite the array with the right slot array afterwards. $this->slots[$key][] = []; end($this->slots[$key]); return key($this->slots[$key]); @@ -381,14 +384,14 @@ class CustomElement implements CacheableDependencyInterface { } /** - * Sets the slot with a single custom element on a certain index + * Sets the slot with a single custom element on a certain index. * * Note: This is overwriting possibly already existing slots. * * This method avoids a wrapper div as necessary by the helper for multiple * elements. * - * @param $key + * @param string $key * Name of the slot to set value for. * @param \Drupal\custom_elements\CustomElement $nestedElement * The nested custom element. @@ -400,6 +403,7 @@ class CustomElement implements CacheableDependencyInterface { * (optional) A weight for ordering output slots. Defaults to 0. * * @return $this + * The CustomElement object. * * @see ::addSlotFromCustomElement() */ @@ -432,6 +436,7 @@ class CustomElement implements CacheableDependencyInterface { * Whether to enable the style (default) or disable it. * * @return $this + * The CustomElement object. */ public function setSlotNormalizationStyle($key, $style, $enable = TRUE) { $key = $this->fixSlotKey($key); @@ -477,6 +482,7 @@ class CustomElement implements CacheableDependencyInterface { * (optional) A weight for ordering output slots. Defaults to 0. * * @return $this + * The CustomElement object. */ public function addSlotFromCustomElement($key, CustomElement $nestedElement, $weight = 0) { return $this->setSlotFromCustomElement($key, $nestedElement, $this->getIndexForNewSlotEntry($key), $weight); @@ -502,10 +508,11 @@ class CustomElement implements CacheableDependencyInterface { * (optional) A weight for ordering output slots. Defaults to 0. * * @return $this + * The CustomElement object. * * @see ::addSlotFromNestedElements() */ - public function setSlotFromNestedElements($key, array $nestedElements, $tag = 'div', $attributes = [], $index = 0, $weight = 0) { + public function setSlotFromNestedElements($key, array $nestedElements, $tag = 'div', array $attributes = [], $index = 0, $weight = 0) { $element = CustomElement::create($tag) ->setAttributes($attributes); foreach ($nestedElements as $delta => $nestedElement) { @@ -607,6 +614,7 @@ class CustomElement implements CacheableDependencyInterface { * The element tag name. * * @return $this + * The CustomElement object. */ public function setTag($tag) { $tag = str_replace('_', '-', $tag); @@ -635,6 +643,7 @@ class CustomElement implements CacheableDependencyInterface { * Attribute value or NULL to unset the attribute. * * @return $this + * The CustomElement object. */ public function setAttribute($key, $value = NULL) { $key = str_replace('_', '-', $key); @@ -666,6 +675,7 @@ class CustomElement implements CacheableDependencyInterface { * The attributes. * * @return $this + * The CustomElement object. */ public function setAttributes(array $attributes) { $this->attributes = $attributes; @@ -688,6 +698,7 @@ class CustomElement implements CacheableDependencyInterface { * The tag prefix. * * @return $this + * The CustomElement object. */ public function setTagPrefix($tagPrefix) { $tagPrefix = str_replace('_', '-', $tagPrefix); diff --git a/src/CustomElementGenerator.php b/src/CustomElementGenerator.php index a4763ad..c1e5360 100644 --- a/src/CustomElementGenerator.php +++ b/src/CustomElementGenerator.php @@ -60,13 +60,15 @@ class CustomElementGenerator { * Gets an array of processors, sorted by their priority. * * @return \Drupal\custom_elements\Processor\CustomElementProcessorInterface[] + * Array of processors. */ public function getSortedProcessors() { if (!isset($this->sortedProcessors)) { // Sort the processors according to priority. krsort($this->processorByPriority); - // Merge nested processors from $this->processors into $this->sortedProviders. + // Merge nested processors from $this->processors into + // $this->sortedProviders. $this->sortedProcessors = []; foreach ($this->processorByPriority as $processors) { $this->sortedProcessors = array_merge($this->sortedProcessors, $processors); @@ -125,11 +127,11 @@ class CustomElementGenerator { /** * Process the given data and adds it to the custom element. * - * @param $data + * @param mixed $data * The data. * @param \Drupal\custom_elements\CustomElement $custom_element * The custom element to which to add it. - * @param $viewMode + * @param string $viewMode * The current view-mode. */ public function process($data, CustomElement $custom_element, $viewMode) { diff --git a/src/CustomElementGeneratorTrait.php b/src/CustomElementGeneratorTrait.php index 9ceaff4..6c1aef1 100644 --- a/src/CustomElementGeneratorTrait.php +++ b/src/CustomElementGeneratorTrait.php @@ -13,6 +13,7 @@ trait CustomElementGeneratorTrait { * @var \Drupal\custom_elements\CustomElementGenerator */ protected $customElementGenerator; + /** * Sets custom element generator. * @@ -25,6 +26,7 @@ trait CustomElementGeneratorTrait { $this->customElementGenerator = $custom_element_generator; return $this; } + /** * Gets custom element generator. * diff --git a/src/CustomElementNormalizer.php b/src/CustomElementNormalizer.php index a54a925..f8da4ec 100644 --- a/src/CustomElementNormalizer.php +++ b/src/CustomElementNormalizer.php @@ -14,7 +14,7 @@ use \Symfony\Component\Serializer\Normalizer\NormalizerInterface; class CustomElementNormalizer implements NormalizerInterface { /** - * @inheritDoc + * {@inheritDoc} */ public function normalize($object, $format = NULL, array $context = []) { $cache_metadata = isset($context['cache_metadata']) ? $context['cache_metadata'] : new BubbleableMetadata(); @@ -23,7 +23,7 @@ class CustomElementNormalizer implements NormalizerInterface { } /** - * @inheritDoc + * {@inheritDoc} */ public function supportsNormalization($data, $format = NULL) { return $data instanceof CustomElement; @@ -33,11 +33,12 @@ class CustomElementNormalizer implements NormalizerInterface { * Normalize custom element. * * @param \Drupal\custom_elements\CustomElement $element - * The custom element. + * The custom element. * @param \Drupal\Core\Render\BubbleableMetadata $cache_metadata - * The cache metadata. + * The cache metadata. * * @return array + * Data array. */ protected function normalizeCustomElement(CustomElement $element, BubbleableMetadata $cache_metadata) { $result = ['element' => $element->getPrefixedTag()]; @@ -73,6 +74,7 @@ class CustomElementNormalizer implements NormalizerInterface { * The cache metadata. * * @return array + * Attributes array. */ protected function normalizeAttributes(array $attributes, BubbleableMetadata $cache_metadata) { $result = []; @@ -95,6 +97,7 @@ class CustomElementNormalizer implements NormalizerInterface { * The cache metadata. * * @return array + * Data array. */ protected function normalizeSlots(CustomElement $element, BubbleableMetadata $cache_metadata) { $data = []; @@ -139,8 +142,10 @@ class CustomElementNormalizer implements NormalizerInterface { * Converts keys to camel case. * * @param array $array + * Array of keys to convert. * * @return array + * Results array keys. */ protected function convertKeysToCamelCase(array $array) { $keys = array_map(function ($key) use (&$array) { diff --git a/src/CustomElementsEntityViewDisplay.php b/src/CustomElementsEntityViewDisplay.php index 96ea152..60cff8d 100644 --- a/src/CustomElementsEntityViewDisplay.php +++ b/src/CustomElementsEntityViewDisplay.php @@ -15,6 +15,7 @@ class CustomElementsEntityViewDisplay extends EntityViewDisplay { * Returns whether the entity is rendered via custom elements. * * @return bool + * Whether custom_elements is enabled. */ public function isCustomElementsEnabled() { return (bool) $this->getThirdPartySetting('custom_elements', 'enabled', 0); diff --git a/src/CustomElementsEntityViewDisplayTrait.php b/src/CustomElementsEntityViewDisplayTrait.php index fd42897..d4ab89f 100644 --- a/src/CustomElementsEntityViewDisplayTrait.php +++ b/src/CustomElementsEntityViewDisplayTrait.php @@ -1,6 +1,5 @@ getThirdPartySetting('custom_elements', 'enabled', 0); @@ -51,4 +52,5 @@ class CustomElementsLayoutBuilderEntityViewDisplay extends LayoutBuilderEntityVi return $this->buildSections($entity); } } + } diff --git a/src/Processor/CustomElementProcessorInterface.php b/src/Processor/CustomElementProcessorInterface.php index 118620d..6377793 100644 --- a/src/Processor/CustomElementProcessorInterface.php +++ b/src/Processor/CustomElementProcessorInterface.php @@ -2,7 +2,6 @@ namespace Drupal\custom_elements\Processor; - use Drupal\custom_elements\CustomElement; /** @@ -19,6 +18,7 @@ interface CustomElementProcessorInterface { * The view mode used for current rendering. * * @return bool + * Whether processor supports processing given data. */ public function supports($data, $viewMode); diff --git a/src/Processor/DefaultContentEntityProcessor.php b/src/Processor/DefaultContentEntityProcessor.php index 88b0e53..abe4c3e 100644 --- a/src/Processor/DefaultContentEntityProcessor.php +++ b/src/Processor/DefaultContentEntityProcessor.php @@ -1,6 +1,5 @@