You are here

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

class DefaultFileHandler in CMS Content Sync 8

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

Providing a minimalistic implementation for any field type.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_file_handler",
  label = @Translation("Default File"),
  weight = 90
)

Hierarchy

Expanded class hierarchy of DefaultFileHandler

File

src/Plugin/cms_content_sync/field_handler/DefaultFileHandler.php, line 22

Namespace

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

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    $allowed = [
      'image',
      'file_uri',
      'file',
      'svg_image_field',
    ];
    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 {
      $file_ids = [];
      foreach ($data as $value) {

        /**
         * @var \Drupal\file\Entity\File $file
         */
        $file = $intent
          ->loadEmbeddedEntity($value);
        $meta = $intent
          ->getEmbeddedEntityData($value);
        if ($file) {
          $meta['target_id'] = $file
            ->id();
          $file_ids[] = $meta;
        }
      }
      $entity
        ->set($this->fieldName, $file_ids);
    }
    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;
    }
    $result = [];
    $file = null;
    $invalid_subfields = [
      '_accessCacheability',
      '_attributes',
      '_loaded',
      'top',
      'target_revision_id',
      'subform',
    ];
    if ('uri' == $this->fieldDefinition
      ->getType()) {
      $data = $entity
        ->get($this->fieldName)
        ->getValue();
      foreach ($data as $i => $value) {
        $files = \Drupal::entityTypeManager()
          ->getStorage('file')
          ->loadByProperties([
          'uri' => $value['value'],
        ]);
        $file = empty($files) ? null : reset($files);
        if ($file) {
          foreach ($invalid_subfields as $invalid_subfield) {
            unset($value[$invalid_subfield]);
          }
          unset($value['value']);
          $result[] = $this
            ->embedFile($intent, $file, $value, $entity->{$this->fieldName}[$i]);
        }
      }
    }
    else {
      $data = $entity
        ->get($this->fieldName)
        ->getValue();
      foreach ($data as $i => $value) {
        if (empty($value['target_id'])) {
          continue;
        }
        $file = File::load($value['target_id']);
        if ($file) {
          foreach ($invalid_subfields as $invalid_subfield) {
            unset($value[$invalid_subfield]);
          }
          unset($value['target_id']);
          $result[] = $this
            ->embedFile($intent, $file, $value, $entity->{$this->fieldName}[$i]);
        }
      }
    }
    $intent
      ->setProperty($this->fieldName, $result);
    return true;
  }

  /**
   * @param \Drupal\cms_content_sync\PushIntent $intent
   * @param \Drupal\file\Entity\File            $file
   * @param array                               $value
   * @param mixed                               $item
   *
   * @return mixed
   */
  protected function embedFile($intent, $file, $value, $item) {

    // Handle crop entities.
    $moduleHandler = \Drupal::service('module_handler');
    $crop_types = $intent
      ->getFlow()
      ->getEntityTypeConfig('crop', null, true);
    if ($moduleHandler
      ->moduleExists('crop') && !empty($crop_types)) {
      $settings = $this->flow
        ->getEntityTypeConfig('file', 'file');
      if ($settings['handler_settings']['export_crop']) {
        foreach ($crop_types as $crop_type) {
          if (Crop::cropExists($file
            ->getFileUri(), $crop_type['bundle_name'])) {
            $crop = Crop::findCrop($file
              ->getFileUri(), $crop_type['bundle_name']);
            if ($crop) {
              $intent
                ->addDependency($crop);
            }
          }
        }
      }
    }
    return $intent
      ->addDependency($file, $value);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultFileHandler::embedFile protected function
DefaultFileHandler::pull public function Overrides FieldHandlerBase::pull
DefaultFileHandler::push public function Overrides FieldHandlerBase::push
DefaultFileHandler::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.