You are here

Home » API reference » Layout Paragraphs 2.0.x » LayoutParagraphsLayout.php

class LayoutParagraphsLayout in Layout Paragraphs 2.0.x

Provides a domain object for a complete Layout Paragraphs Layout.

A Layout Paragraphs Layout represents a collection of Layout Paragraphs Sections and Layout Paragraphs Components associated with a paragraphs reference field. This class provides public methods for manipulating a layout - i.e. adding, removing, and reording paragraph layout sections and paragraph layout components.

See also:

Hierarchy

Expanded class hierarchy of LayoutParagraphsLayout

14 files declare their use of LayoutParagraphsLayout
ChooseComponentController.php in src/Controller/ChooseComponentController.php
ComponentFormController.php in src/Controller/ComponentFormController.php
DeleteComponentForm.php in src/Form/DeleteComponentForm.php
EditComponentForm.php in src/Form/EditComponentForm.php
InsertComponentForm.php in src/Form/InsertComponentForm.php

... See full list

File

src/LayoutParagraphsLayout.php, line 26

Namespace

Drupal\layout_paragraphs
View source 
class LayoutParagraphsLayout implements ThirdPartySettingsInterface {
  use DependencySerializationTrait;

  /**
   * The paragraph reference field the layout is attached to.
   *
   * @var \Drupal\Core\Field\EntityReferenceFieldItemListInterface
   */
  protected $paragraphsReferenceField;

  /**
   * Third party settings.
   *
   * An array of key/value pairs keyed by provider.
   *
   * @var array[]
   */
  protected $thirdPartySettings = [];

  /**
   * Settings.
   *
   * An array of key/value pairs.
   *
   * @var array[]
   */
  protected $settings;

  /**
   * Class constructor.
   *
   * @param \Drupal\Core\Field\EntityReferenceFieldItemListInterface $paragraphs_reference_field
   *   The paragraph reference field this layout is attached to.
   * @param array[] $settings
   *   An array of settings.
   */
  public function __construct(EntityReferenceFieldItemListInterface $paragraphs_reference_field, array $settings = []) {
    $this->paragraphsReferenceField = $paragraphs_reference_field;
    $this->settings = $settings;
  }

  /**
   * Returns a unique id for this layout.
   *
   * @return string
   *   A unique id.
   */
  public function id() {
    return Crypt::hashBase64($this
      ->getEntity()
      ->getEntityType()
      ->id() . $this
      ->getEntity()
      ->id() . $this
      ->getFieldName());
  }

  /**
   * Returns the layout's parent entity with updated paragraphs reference field.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The entity.
   */
  public function getEntity() {
    $entity = $this->paragraphsReferenceField
      ->getEntity();
    return $entity;
  }

  /**
   * Set the entity that this layout is attached to.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to set.
   *
   * @return $this
   */
  public function setEntity(EntityInterface $entity) {
    $this->entity = $entity;
    return $this;
  }

  /**
   * Sets the settings array.
   *
   * @param array[] $settings
   *   An associative array of settings.
   *
   * @return $this
   */
  public function setSettings(array $settings) {
    $this->settings = $settings;
    return $this;
  }

  /**
   * Returns the settings array.
   */
  public function getSettings() {
    return $this->settings;
  }

  /**
   * Returns a single setting from the settings array.
   *
   * @param string $key
   *   The key of the setting to return.
   * @param mixed $default
   *   The default value to return if the setting is empty.
   */
  public function getSetting(string $key, $default = NULL) {
    return $this->settings[$key] ?? $default;
  }

  /**
   * Returns the reference field that this layout is attached to.
   *
   * @return \Drupal\Core\Field\EntityReferenceFieldItemListInterface
   *   The field item list.
   */
  public function &getParagraphsReferenceField() {
    return $this->paragraphsReferenceField;
  }

  /**
   * Set the field item list.
   *
   * @param \Drupal\Core\Field\EntityReferenceFieldItemListInterface $paragraphs_reference_field
   *   The field item list to set.
   *
   * @return $this
   */
  public function setParagraphsReferenceField(EntityReferenceFieldItemListInterface $paragraphs_reference_field) {
    $this->paragraphsReferenceField = $paragraphs_reference_field;
    return $this;
  }

  /**
   * Returns the field name.
   *
   * @return string
   *   The field name.
   */
  public function getFieldName() {

    /** @var \Drupal\field\Entity\FieldConfig $definition **/
    $definition = $this->paragraphsReferenceField
      ->getFieldDefinition();
    $field_name = $definition
      ->get('field_name');
    return $field_name;
  }

  /**
   * Wraps the paragraph in the component class.
   *
   * @param Drupal\paragraphs\Entity\Paragraph $paragraph
   *   The paragraph entity.
   *
   * @return LayoutParagraphsComponent|LayoutParagraphsSection
   *   The component.
   */
  public function getComponent(Paragraph $paragraph) {
    return new LayoutParagraphsComponent($paragraph);
  }

  /**
   * Returns the component with matching uuid.
   *
   * @param string $uuid
   *   The uuid to search for.
   *
   * @return LayoutParagraphsComponent
   *   The component.
   */
  public function getComponentByUuid($uuid) {
    foreach ($this
      ->getEntities() as $entity) {
      if ($entity
        ->uuid() == $uuid) {
        return $this
          ->getComponent($entity);
      }
    }
  }

  /**
   * Returns a Layout Paragraphs Layout Section for the given paragraph.
   *
   * If the provided paragraph is not a layout section, returns false.
   *
   * @param \Drupal\paragraphs\Entity\Paragraph $paragraph
   *   The paragraph.
   *
   * @return \Drupal\layout_paragraphs\LayoutParagraphsSection|false
   *   The layout section or false.
   */
  public function getLayoutSection(Paragraph $paragraph) {
    if (!LayoutParagraphsSection::isLayoutComponent($paragraph)) {
      return FALSE;
    }
    $uuid = $paragraph
      ->uuid();
    $components = array_filter($this
      ->getComponents(), function ($component) use ($uuid) {
      return $component
        ->getParentUuid() == $uuid;
    });
    return new LayoutParagraphsSection($paragraph, $components);
  }

  /**
   * Returns a list of root level components for this collection.
   *
   * @return array
   *   An array of root level layout paragraph components.
   */
  public function getRootComponents() {
    return array_filter($this
      ->getComponents(), function ($component) {
      return $component
        ->isRoot();
    });
  }

  /**
   * Returns a list of all components for this collection.
   *
   * @return array
   *   An array of layout paragraph components.
   */
  public function getComponents() {
    return array_map(function ($paragraph) {
      return $this
        ->getComponent($paragraph);
    }, $this
      ->getEntities());
  }

  /**
   * Returns a list of all paragraph entities associated with this collection.
   *
   * @return \Drupal\paragraphs\Entity\Paragraph[]
   *   An array of paragraph entities.
   */
  public function getEntities() {
    $items = [];
    foreach ($this->paragraphsReferenceField as $field_item) {
      if ($field_item->entity) {
        $items[] = $field_item->entity;
      }
    }
    return $items;
  }

  /**
   * Determines whether the reference field contains any non-empty items.
   *
   * @return bool
   *   TRUE if the list is empty, FALSE otherwise.
   */
  public function isEmpty() {
    return $this->paragraphsReferenceField
      ->isEmpty();
  }

  /**
   * Sets a layout component.
   *
   * If a component is found with a matching paragraph,
   * the matching component's paragraph is overwritten with the
   * incoming paragraph. Otherwise the paragraph is appended
   * to the field item list.
   *
   * @param \Drupal\paragraphs\Entity\Paragraph $paragraph
   *   The paragraph to set.
   *
   * @return $this
   */
  public function setComponent(Paragraph $paragraph) {
    $delta = $this
      ->getComponentDeltaByUuid($paragraph
      ->uuid());
    if ($delta > -1) {
      $this->paragraphsReferenceField[$delta]->entity = $paragraph;
    }
    else {
      $this->paragraphsReferenceField[] = $paragraph;
    }
    return $this;
  }

  /**
   * Reorder components.
   *
   * Accepts an associative of component uuids, parent uuids, and regions.
   *
   * @param array $ordered_items
   *   The nested array with the new order for items.
   *
   * @return $this
   */
  public function reorderComponents(array $ordered_items) {
    foreach ($ordered_items as $ordered_item) {
      if ($component = $this
        ->getComponentByUuid($ordered_item['uuid'])) {
        $component
          ->setSettings([
          'parent_uuid' => $ordered_item['parentUuid'],
          'region' => $ordered_item['region'],
        ]);
        $reordered_items[] = [
          'entity' => $component
            ->getEntity(),
        ];
      }
    }
    $this->paragraphsReferenceField
      ->setValue($reordered_items);
    return $this;
  }

  /**
   * Insert a paragraph component before an existing component.
   *
   * @param string $parent_uuid
   *   The parent component's uuid.
   * @param string $region
   *   The region.
   * @param \Drupal\paragraphs\Entity\Paragraph $paragraph
   *   The paragraph component to add.
   *
   * @return $this
   */
  public function insertIntoRegion(string $parent_uuid, string $region, Paragraph $paragraph) {

    // Create a layout component for the new paragraph.
    $component = $this
      ->getComponent($paragraph);

    // Make sure the parent component exists.
    if ($this
      ->getComponentByUuid($parent_uuid)) {

      // Set the parent and region.
      $component
        ->setSettings([
        'parent_uuid' => $parent_uuid,
        'region' => $region,
      ]);

      // Get the paragraph entity from the component.
      $new_paragraph = $component
        ->getEntity();
      $new_paragraph
        ->setParentEntity($this
        ->getEntity(), $this
        ->getFieldName());

      // Splice the new paragraph into the field item list.
      $list = $this->paragraphsReferenceField
        ->getValue();
      $list[] = [
        'entity' => $new_paragraph,
      ];
      $this->paragraphsReferenceField
        ->setValue($list);
    }
    else {

      // @todo: throw exception.
    }
    return $this;
  }

  /**
   * Insert a paragraph component before an existing component.
   *
   * @param string $sibling_uuid
   *   The existing sibling paragraph component's uuid.
   * @param \Drupal\paragraphs\Entity\Paragraph $paragraph
   *   The paragraph component to add.
   *
   * @return $this
   */
  public function insertBeforeComponent(string $sibling_uuid, Paragraph $paragraph) {
    return $this
      ->insertSiblingComponent($sibling_uuid, $paragraph);
  }

  /**
   * Insert a paragraph component after an existing component.
   *
   * @param string $sibling_uuid
   *   The existing sibling paragraph component's uuid.
   * @param \Drupal\paragraphs\Entity\Paragraph $paragraph
   *   The paragraph component to add.
   *
   * @return $this
   */
  public function insertAfterComponent(string $sibling_uuid, Paragraph $paragraph) {
    return $this
      ->insertSiblingComponent($sibling_uuid, $paragraph, 1);
  }

  /**
   * Insert an new item adjacent to $sibling.
   *
   * @param string $sibling_uuid
   *   The existing sibling paragraph component's uuid.
   * @param \Drupal\paragraphs\Entity\Paragraph $new_paragraph
   *   The paragraph component to add.
   * @param int $delta_offset
   *   Where to add the new item in relation to sibling.
   *
   * @return $this
   */
  protected function insertSiblingComponent(string $sibling_uuid, Paragraph $new_paragraph, int $delta_offset = 0) {

    // Create a layout component for the new paragraph.
    $new_component = $this
      ->getComponent($new_paragraph);

    // Find the existing sibling component, and copy the layout settings
    // into the new component to be inserted.
    if ($existing_component = $this
      ->getComponentByUuid($sibling_uuid)) {

      // Copy layout settings into the new component.
      $sibling_settings = $existing_component
        ->getSettings();
      $new_component_settings = [
        'parent_uuid' => $sibling_settings['parent_uuid'] ?? NULL,
        'region' => $sibling_settings['region'] ?? NULL,
      ];
      $new_component
        ->setSettings($new_component_settings);

      // Get the paragraph entity from the component.
      $new_paragraph = $new_component
        ->getEntity();
      $new_paragraph
        ->setParentEntity($this
        ->getEntity(), $this
        ->getFieldName());

      // Splice the new paragraph into the field item list.
      $list = $this->paragraphsReferenceField
        ->getValue();
      $delta = $this
        ->getComponentDeltaByUuid($sibling_uuid);
      $delta += $delta_offset;
      array_splice($list, $delta, 0, [
        'entity' => $new_paragraph,
      ]);
      $this->paragraphsReferenceField
        ->setValue($list);
    }
    else {

      // @todo: throw exception.
    }
    return $this;
  }

  /**
   * Append a new component.
   *
   * @param \Drupal\paragraphs\Entity\Paragraph $new_paragraph
   *   The paragraph component to append.
   *
   * @return $this
   */
  public function appendComponent(Paragraph $new_paragraph) {
    $this->paragraphsReferenceField
      ->appendItem([
      'entity' => $new_paragraph,
    ]);
    return $this;
  }

  /**
   * Delete a component.
   *
   * @param string $uuid
   *   The uuid of the component to delete.
   * @param bool $recursive
   *   Recursively delete child components.
   *
   * @return $this
   */
  public function deleteComponent(string $uuid, $recursive = FALSE) {
    if ($recursive) {
      $component = $this
        ->getComponentByUuid($uuid);
      if ($component
        ->isLayout()) {

        /** @var \Drupal\layout_paragraphs\LayoutParagraphsSection $section */
        $section = $this
          ->getLayoutSection($component
          ->getEntity());
        foreach ($section
          ->getComponents() as $component) {
          $this
            ->deleteComponent($component
            ->getEntity()
            ->uuid(), TRUE);
        }
      }
    }
    $delta = $this
      ->getComponentDeltaByUuid($uuid);
    if (isset($this->paragraphsReferenceField[$delta])) {
      unset($this->paragraphsReferenceField[$delta]);
    }
    return $this;
  }

  /**
   * Searchs for a component by its uuid and returns its delta.
   *
   * @param string $uuid
   *   The uuid to search for.
   *
   * @return int
   *   The component's delta, or -1 if no match.
   */
  protected function getComponentDeltaByUuid(string $uuid) {
    foreach ($this->paragraphsReferenceField as $key => $item) {
      if (isset($item->entity) && $item->entity
        ->uuid() == $uuid) {
        return $key;
      }
    }
    return -1;
  }

  /**
   * {@inheritdoc}
   */
  public function getThirdPartySetting($provider, $key, $default = NULL) {
    return isset($this->thirdPartySettings[$provider][$key]) ? $this->thirdPartySettings[$provider][$key] : $default;
  }

  /**
   * {@inheritdoc}
   */
  public function getThirdPartySettings($provider) {
    return isset($this->thirdPartySettings[$provider]) ? $this->thirdPartySettings[$provider] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function setThirdPartySetting($provider, $key, $value) {
    $this->thirdPartySettings[$provider][$key] = $value;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function unsetThirdPartySetting($provider, $key) {
    unset($this->thirdPartySettings[$provider][$key]);

    // If the third party is no longer storing any information, completely
    // remove the array holding the settings for this provider.
    if (empty($this->thirdPartySettings[$provider])) {
      unset($this->thirdPartySettings[$provider]);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getThirdPartyProviders() {
    return array_keys($this->thirdPartySettings);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
LayoutParagraphsLayout::$paragraphsReferenceField protected property The paragraph reference field the layout is attached to.
LayoutParagraphsLayout::$settings protected property Settings.
LayoutParagraphsLayout::$thirdPartySettings protected property Third party settings.
LayoutParagraphsLayout::appendComponent public function Append a new component.
LayoutParagraphsLayout::deleteComponent public function Delete a component.
LayoutParagraphsLayout::getComponent public function Wraps the paragraph in the component class.
LayoutParagraphsLayout::getComponentByUuid public function Returns the component with matching uuid.
LayoutParagraphsLayout::getComponentDeltaByUuid protected function Searchs for a component by its uuid and returns its delta.
LayoutParagraphsLayout::getComponents public function Returns a list of all components for this collection.
LayoutParagraphsLayout::getEntities public function Returns a list of all paragraph entities associated with this collection.
LayoutParagraphsLayout::getEntity public function Returns the layout's parent entity with updated paragraphs reference field.
LayoutParagraphsLayout::getFieldName public function Returns the field name.
LayoutParagraphsLayout::getLayoutSection public function Returns a Layout Paragraphs Layout Section for the given paragraph.
LayoutParagraphsLayout::getParagraphsReferenceField public function Returns the reference field that this layout is attached to.
LayoutParagraphsLayout::getRootComponents public function Returns a list of root level components for this collection.
LayoutParagraphsLayout::getSetting public function Returns a single setting from the settings array.
LayoutParagraphsLayout::getSettings public function Returns the settings array.
LayoutParagraphsLayout::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
LayoutParagraphsLayout::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
LayoutParagraphsLayout::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
LayoutParagraphsLayout::id public function Returns a unique id for this layout.
LayoutParagraphsLayout::insertAfterComponent public function Insert a paragraph component after an existing component.
LayoutParagraphsLayout::insertBeforeComponent public function Insert a paragraph component before an existing component.
LayoutParagraphsLayout::insertIntoRegion public function Insert a paragraph component before an existing component.
LayoutParagraphsLayout::insertSiblingComponent protected function Insert an new item adjacent to $sibling.
LayoutParagraphsLayout::isEmpty public function Determines whether the reference field contains any non-empty items.
LayoutParagraphsLayout::reorderComponents public function Reorder components.
LayoutParagraphsLayout::setComponent public function Sets a layout component.
LayoutParagraphsLayout::setEntity public function Set the entity that this layout is attached to.
LayoutParagraphsLayout::setParagraphsReferenceField public function Set the field item list.
LayoutParagraphsLayout::setSettings public function Sets the settings array.
LayoutParagraphsLayout::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
LayoutParagraphsLayout::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
LayoutParagraphsLayout::__construct public function Class constructor.