You are here

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

class DefaultFormattedTextHandler in CMS Content Sync 8

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

Providing a minimalistic implementation for any field type.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_formatted_text_handler",
  label = @Translation("Default Formatted Text"),
  weight = 90
)

Hierarchy

Expanded class hierarchy of DefaultFormattedTextHandler

File

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

Namespace

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

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

  /**
   * {@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 $item) {
        if (!empty($item['value'])) {

          // Replace node links correctly.
          $item['value'] = $this
            ->replaceEntityReferenceLinks($item['value']);
        }
        $result[] = $item;
      }
      $entity
        ->set($this->fieldName, $result);
    }
    return true;
  }

  /**
   * {@inheritdoc}
   */
  public function push(PushIntent $intent) {
    if (!parent::push($intent)) {
      return false;
    }
    $entity = $intent
      ->getEntity();
    $add_file_uri_dependency = function ($matches) use ($intent) {

      // PDF files can have a #page=... anchor attached that we want to keep.
      $path = preg_replace('@#.*$@', '', $matches[1]);
      $uri = 'public://' . urldecode($path);

      /** @var FileInterface[] $files */
      $files = \Drupal::entityTypeManager()
        ->getStorage('file')
        ->loadByProperties([
        'uri' => $uri,
      ]);
      if (!count($files)) {
        \Drupal::logger('cms_content_sync')
          ->error('Failed to push referenced file by URI in the formatted text as the file is missing on this site: @uri<br>Flow: @flow_id | Pool: @pool_id', [
          '@uri' => $uri,
          '@flow_id' => $intent
            ->getFlow()
            ->id(),
          '@pool_id' => $intent
            ->getPool()
            ->id(),
        ]);
        return '';
      }
      $file = reset($files);
      $intent
        ->addDependency($file);
      return '';
    };
    $base_path = PublicStream::basePath();
    foreach ($entity
      ->get($this->fieldName)
      ->getValue() as $item) {
      $text = $item['value'];

      // Simple image embedding (default ckeditor + IMCE images)
      preg_replace_callback('@<img[^>]+src="/' . $base_path . '/([^"]+)"@', $add_file_uri_dependency, $text);

      // Other file embedding (IMCE files)
      preg_replace_callback('@<a[^>]+href="/' . $base_path . '/([^"]+)"@', $add_file_uri_dependency, $text);

      // Entity embedding (especially media)
      preg_replace_callback('@<drupal-(entity|media)[^>]+data-entity-type="([^"]+)"\\s+data-entity-uuid="([^"]+)"@', function ($matches) use ($intent) {
        $type = $matches[2];
        $uuid = $matches[3];
        $entity = \Drupal::service('entity.repository')
          ->loadEntityByUuid($type, $uuid);
        if (!$entity) {
          return '';
        }
        $intent
          ->addDependency($entity);
        return '';
      }, $text);
    }
    return true;
  }

  /**
   * Replace all "/node/..." links with their correct ID for the current site.
   *
   * @todo If a new entity is added, we should scan the database for existing
   * references to it that can now be resolved.
   *
   * @param $text
   *
   * @return string
   */
  protected function replaceEntityReferenceLinks($text) {
    $entity_repository = \Drupal::service('entity.repository');
    $replace_uri_callback = function ($matches) {
      $path = $matches[2];

      // PDF files can have a #page=... anchor attached that we want to keep.
      $anchor = null;
      if (false !== strpos($path, '#')) {
        list($path, $anchor) = explode('#', $path);
      }
      $parts = explode('/', $path);
      $file = null;
      $uri = null;
      for ($i = 0; $i < count($parts); ++$i) {
        $uri = 'public://' . urldecode(implode('/', array_slice($parts, $i)));

        /** @var FileInterface[] $files */
        $files = \Drupal::entityTypeManager()
          ->getStorage('file')
          ->loadByProperties([
          'uri' => $uri,
        ]);
        if (count($files)) {
          $file = reset($files);
          break;
        }
      }
      if (!$file) {
        \Drupal::logger('cms_content_sync')
          ->error('Failed to replace file URI in the formatted text as the file is missing on this site: @uri', [
          '@uri' => 'public://' . urldecode($path),
        ]);
        return $matches[1] . '"/404"';
      }
      $url = file_url_transform_relative(file_create_url($uri));
      if ($anchor) {
        $url .= '#' . $anchor;
      }
      return $matches[1] . '"' . $url . '"';
    };

    // Simple image embedding (default ckeditor + IMCE images)
    $text = preg_replace_callback('@(<img[^>]+src=)"/sites/[^/]+/files/([^"]+)"@', $replace_uri_callback, $text);

    // Other file embedding (IMCE files)
    $text = preg_replace_callback('@(<a[^>]+href=)"/sites/[^/]+/files/([^"]+)"@', $replace_uri_callback, $text);

    // Entity embedding (especially media)
    return preg_replace_callback('@data-entity-uuid="([0-9a-z-]+)" href="/node/([0-9]+)"@', function ($matches) use ($entity_repository) {
      $uuid = $matches[1];
      $id = $matches[2];
      try {
        $node = $entity_repository
          ->loadEntityByUuid('node', $uuid);
        if ($node) {
          $id = $node
            ->id();
        }
      } catch (\Exception $e) {
      }
      return 'data-entity-uuid="' . $uuid . '" href="/node/' . $id . '"';
    }, $text);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultFormattedTextHandler::pull public function Overrides FieldHandlerBase::pull
DefaultFormattedTextHandler::push public function Overrides FieldHandlerBase::push
DefaultFormattedTextHandler::replaceEntityReferenceLinks protected function Replace all "/node/..." links with their correct ID for the current site.
DefaultFormattedTextHandler::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.