You are here

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

class DefaultLinkHandler in CMS Content Sync 8

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

Providing a minimalistic implementation for any field type.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_link_handler",
  label = @Translation("Default Link"),
  weight = 90
)

Hierarchy

Expanded class hierarchy of DefaultLinkHandler

File

src/Plugin/cms_content_sync/field_handler/DefaultLinkHandler.php, line 23

Namespace

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

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    $allowed = [
      'link',
    ];
    return false !== in_array($field
      ->getType(), $allowed);
  }

  /**
   * {@inheritdoc}
   */
  public function getHandlerSettings($current_values, $type = 'both') {
    $options = [];
    if ('pull' !== $type) {
      $options['export_as_absolute_url'] = [
        '#type' => 'checkbox',
        '#title' => 'Push as absolute URL',
        '#default_value' => isset($current_values['export_as_absolute_url']) ? $current_values['export_as_absolute_url'] : false,
      ];
    }
    return array_merge(parent::getHandlerSettings($current_values, $type), $options);
  }

  /**
   * {@inheritdoc}
   */
  public function pull(PullIntent $intent) {
    $action = $intent
      ->getAction();

    /**
     * @var \Drupal\Core\Entity\FieldableEntityInterface $entity
     */
    $entity = $intent
      ->getEntity();

    // Deletion doesn't require any action on field basis for static data.
    if (SyncIntent::ACTION_DELETE == $action) {
      return false;
    }
    if ($intent
      ->shouldMergeChanges()) {
      return false;
    }
    $data = $intent
      ->getProperty($this->fieldName);
    if (empty($data)) {
      $entity
        ->set($this->fieldName, null);
    }
    else {
      $result = [];
      foreach ($data as &$link_element) {
        if (empty($link_element['uri'])) {
          if (!empty($link_element[Entity::ENTITY_TYPE_KEY]) && !empty($link_element[Entity::BUNDLE_KEY])) {
            $reference = $intent
              ->loadEmbeddedEntity($link_element);
            if ($reference) {
              $result[] = [
                'uri' => 'entity:' . $reference
                  ->getEntityTypeId() . '/' . $reference
                  ->id(),
                'title' => $link_element['title'],
                'options' => $link_element['options'],
              ];
            }
            elseif ($entity instanceof MenuLinkContent && 'link' == $this->fieldName) {
              $result[] = [
                'uri' => 'internal:/' . $link_element[Entity::ENTITY_TYPE_KEY] . '/' . $link_element[Entity::UUID_KEY],
                'title' => $link_element['title'],
                'options' => $link_element['options'],
              ];
            }
          }
        }
        else {
          $result[] = [
            'uri' => $link_element['uri'],
            'title' => $link_element['title'],
            'options' => $link_element['options'],
          ];
        }
      }
      $entity
        ->set($this->fieldName, $result);
    }
    return true;
  }

  /**
   * {@inheritdoc}
   */
  public function push(PushIntent $intent) {
    $action = $intent
      ->getAction();

    /**
     * @var \Drupal\Core\Entity\FieldableEntityInterface $entity
     */
    $entity = $intent
      ->getEntity();

    // Deletion doesn't require any action on field basis for static data.
    if (SyncIntent::ACTION_DELETE == $action) {
      return false;
    }
    $data = $entity
      ->get($this->fieldName)
      ->getValue();
    $absolute = !empty($this->settings['handler_settings']['export_as_absolute_url']);
    $result = [];
    foreach ($data as $key => $value) {
      $uri =& $data[$key]['uri'];

      // Find the linked entity and replace it's id with the UUID
      // References have following pattern: entity:entity_type/entity_id.
      preg_match('/^entity:(.*)\\/(\\d*)$/', $uri, $found);
      if (empty($found) || $absolute) {
        if ($absolute) {
          $uri = Url::fromUri($uri, [
            'absolute' => true,
          ])
            ->toString();
        }
        $result[] = [
          'uri' => $uri,
          'title' => isset($value['title']) ? $value['title'] : null,
          'options' => $value['options'],
        ];
      }
      else {
        $link_entity_type = $found[1];
        $link_entity_id = $found[2];
        $entity_manager = \Drupal::entityTypeManager();
        $link_entity = $entity_manager
          ->getStorage($link_entity_type)
          ->load($link_entity_id);
        if (empty($link_entity)) {
          continue;
        }
        if (!$this->flow
          ->supportsEntity($link_entity)) {
          continue;
        }
        $result[] = $intent
          ->addReference($link_entity, [
          'title' => $value['title'],
          'options' => $value['options'],
        ]);
      }
    }
    $intent
      ->setProperty($this->fieldName, $result);
    return true;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultLinkHandler::getHandlerSettings public function Get the handler settings. Overrides FieldHandlerBase::getHandlerSettings
DefaultLinkHandler::pull public function Overrides FieldHandlerBase::pull
DefaultLinkHandler::push public function Overrides FieldHandlerBase::push
DefaultLinkHandler::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::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.