You are here

Home » API reference » CMS Content Sync 8 » DefaultLayoutBuilderHandler.php

class DefaultLayoutBuilderHandler in CMS Content Sync 8

Same name and namespace in other branches
  1. 2.1.x src/Plugin/cms_content_sync/field_handler/DefaultLayoutBuilderHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultLayoutBuilderHandler
  2. 2.0.x src/Plugin/cms_content_sync/field_handler/DefaultLayoutBuilderHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultLayoutBuilderHandler

Providing a minimalistic implementation for any field type.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_layout_builder",
  label = @Translation("Default Layout Builder"),
  weight = 100
)

Hierarchy

Expanded class hierarchy of DefaultLayoutBuilderHandler

File

src/Plugin/cms_content_sync/field_handler/DefaultLayoutBuilderHandler.php, line 21

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler
View source 
class DefaultLayoutBuilderHandler extends FieldHandlerBase {

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    return 'layout_section' == $field
      ->getType();
  }

  /**
   * {@inheritdoc}
   */
  public function push(PushIntent $intent) {
    $action = $intent
      ->getAction();
    $entity = $intent
      ->getEntity();
    if (PushIntent::PUSH_AUTOMATICALLY != $this->settings['export']) {
      return false;
    }

    // Deletion doesn't require any action on field basis for static data.
    if (SyncIntent::ACTION_DELETE == $action) {
      return false;
    }
    $layout_builder_elements = $entity
      ->get($this->fieldName)
      ->getValue();
    $layout_builder_array = [];
    foreach ($layout_builder_elements as $key => $layout_builder_element) {

      /**
       * @var \Drupal\layout_builder\Section $layout_builder_element
       */
      $serialize = $layout_builder_element['section']
        ->toArray();
      if (isset($serialize['components'])) {
        foreach ($serialize['components'] as &$component) {
          if (isset($component['configuration']['provider'])) {
            if ('block_content' == $component['configuration']['provider']) {
              list($provider, $uuid) = explode(':', $component['configuration']['id']);
              $block_storage = \Drupal::entityTypeManager()
                ->getStorage('block_content');
              $block = $block_storage
                ->loadByProperties([
                'uuid' => $uuid,
              ]);
              if (!empty($block)) {
                $component['configuration']['block_reference'] = $intent
                  ->addDependency(reset($block));
              }
            }
            elseif ('layout_builder' == $component['configuration']['provider']) {
              if (isset($component['configuration']['block_revision_id'])) {
                $block_storage = \Drupal::entityTypeManager()
                  ->getStorage('block_content');
                $block = $block_storage
                  ->loadByProperties([
                  'revision_id' => $component['configuration']['block_revision_id'],
                ]);
                unset($component['configuration']['block_revision_id']);
                if (!empty($block)) {
                  $component['configuration']['block_reference'] = $intent
                    ->addDependency(reset($block));
                }
              }
            }
          }
        }
      }
      $layout_builder_array[$key] = $serialize;
    }
    if (!empty($layout_builder_array)) {
      $intent
        ->setProperty($this->fieldName, $layout_builder_array);
      return true;
    }
    return false;
  }
  public function pull(PullIntent $intent) {
    $layout_builder_array = $intent
      ->getProperty($this->fieldName);
    if (!empty($layout_builder_array)) {
      $layout_builder_elements = [];
      foreach ($layout_builder_array as $key => $layout_builder_element) {
        if (isset($layout_builder_element['components'])) {
          foreach ($layout_builder_element['components'] as $uuid => $component) {
            if (isset($component['configuration']['provider'])) {
              if ('layout_builder' == $component['configuration']['provider']) {
                if (isset($component['configuration']['block_reference'])) {
                  $block = $intent
                    ->loadEmbeddedEntity($component['configuration']['block_reference']);
                  if ($block) {
                    $layout_builder_element['components'][$uuid]['configuration']['block_revision_id'] = $block
                      ->get('revision_id')->value;
                  }
                }
              }
            }
          }
        }
        $layout_builder_elements[$key]['section'] = Section::fromArray($layout_builder_element);
      }
      $intent
        ->getEntity()
        ->set($this->fieldName, $layout_builder_elements);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultLayoutBuilderHandler::pull public function Overrides FieldHandlerBase::pull
DefaultLayoutBuilderHandler::push public function Overrides FieldHandlerBase::push
DefaultLayoutBuilderHandler::supports public static function Check if this handler supports the given field instance. Overrides FieldHandlerInterface::supports
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FieldHandlerBase::$bundleName protected property
FieldHandlerBase::$entityTypeName protected property
FieldHandlerBase::$fieldDefinition protected property
FieldHandlerBase::$fieldName protected property
FieldHandlerBase::$flow protected property
FieldHandlerBase::$logger protected property A logger instance.
FieldHandlerBase::$settings protected property Additional settings as provided by {
FieldHandlerBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldHandlerBase::forceMergeOverwrite protected function 1
FieldHandlerBase::getAllowedPullOptions public function Get the allowed pull options. Overrides FieldHandlerInterface::getAllowedPullOptions
FieldHandlerBase::getAllowedPushOptions public function Get the allowed push options. Overrides FieldHandlerInterface::getAllowedPushOptions
FieldHandlerBase::getFieldName public function Overrides FieldHandlerInterface::getFieldName
FieldHandlerBase::getHandlerSettings public function Get the handler settings. Overrides FieldHandlerInterface::getHandlerSettings 3
FieldHandlerBase::validateHandlerSettings public function Validate the settings defined above. $form and $form_state are the same as in the Form API. $settings_key is the index at $form['sync_entities'] for this handler instance. Overrides FieldHandlerInterface::validateHandlerSettings 1
FieldHandlerBase::__construct public function Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.