You are here

Home » API reference » File URL 2.0.x » FileUrlFieldItemList.php

class FileUrlFieldItemList in File URL 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldType/FileUrlFieldItemList.php \Drupal\file_url\Plugin\Field\FieldType\FileUrlFieldItemList

Represents a configurable entity file URL field.

Hierarchy

Expanded class hierarchy of FileUrlFieldItemList

1 file declares its use of FileUrlFieldItemList
FileUrlFieldItemListTest.php in tests/src/Kernel/FileUrlFieldItemListTest.php

File

src/Plugin/Field/FieldType/FileUrlFieldItemList.php, line 13

Namespace

Drupal\file_url\Plugin\Field\FieldType
View source 
class FileUrlFieldItemList extends EntityReferenceFieldItemList {

  /**
   * {@inheritdoc}
   */
  public function getConstraints() {
    $constraints = [];
    $cardinality = $this
      ->getFieldDefinition()
      ->getFieldStorageDefinition()
      ->getCardinality();
    if ($cardinality != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
      $constraints[] = $this
        ->getTypedDataManager()
        ->getValidationConstraintManager()
        ->create('Count', [
        'max' => $cardinality,
        'maxMessage' => t('%name: this field cannot hold more than @count values.', [
          '%name' => $this
            ->getFieldDefinition()
            ->getLabel(),
          '@count' => $cardinality,
        ]),
      ]);
    }

    // @todo Add a constraint to file URI references.
    return $constraints;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultValuesForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function postSave($update) {

    /** @var \Drupal\file_url\FileUrlHandler $file_handler */
    $file_handler = \Drupal::service('file_url.handler');
    $entity = $this
      ->getEntity();
    if (!$update) {

      // Add a new usage for newly uploaded files.
      foreach ($this
        ->referencedEntities() as $file) {
        if (!$file_handler
          ->isRemote($file)) {
          \Drupal::service('file.usage')
            ->add($file, 'file', $entity
            ->getEntityTypeId(), $entity
            ->id());
        }
      }
    }
    else {

      // Get current target file entities and file IDs.
      $files = $this
        ->referencedEntities();
      $ids = [];

      /** @var \Drupal\file\FileInterface $file */
      foreach ($files as $file) {
        $ids[] = $file
          ->id();
      }

      // On new revisions, all files are considered to be a new usage and no
      // deletion of previous file usages are necessary.
      if (!empty($entity->original) && $entity
        ->getRevisionId() != $entity->original
        ->getRevisionId()) {
        foreach ($files as $file) {
          if (!$file_handler
            ->isRemote($file)) {
            \Drupal::service('file.usage')
              ->add($file, 'file', $entity
              ->getEntityTypeId(), $entity
              ->id());
          }
        }
        return;
      }

      // Get the file IDs attached to the field before this update.
      $field_name = $this
        ->getFieldDefinition()
        ->getName();
      $original_ids = [];
      $langcode = $this
        ->getLangcode();
      $original = $entity->original;
      if ($original
        ->hasTranslation($langcode)) {
        $original_items = $original
          ->getTranslation($langcode)->{$field_name};
        foreach ($original_items as $item) {
          $file = $file_handler::urlToFile($item->target_id);
          if (!$file_handler
            ->isRemote($file)) {
            $original_ids[] = $file
              ->id();
          }
        }
      }

      // Decrement file usage by 1 for files that were removed from the field.
      $removed_ids = array_filter(array_diff($original_ids, $ids));
      $removed_files = \Drupal::service('entity_type.manager')
        ->getStorage('file')
        ->loadMultiple($removed_ids);
      foreach ($removed_files as $file) {
        \Drupal::service('file.usage')
          ->delete($file, 'file', $entity
          ->getEntityTypeId(), $entity
          ->id());
      }

      // Add new usage entries for newly added files.
      foreach ($files as $file) {
        if (!in_array($file
          ->id(), $original_ids) && !$file_handler
          ->isRemote($file)) {
          \Drupal::service('file.usage')
            ->add($file, 'file', $entity
            ->getEntityTypeId(), $entity
            ->id());
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function referencedEntities() {

    /** @var \Drupal\file_url\FileUrlHandler $file_handler */
    $file_handler = \Drupal::service('file_url.handler');
    if (empty($this->list)) {
      return [];
    }

    // Collect the IDs of existing entities to load, and directly grab the
    // "autocreate" entities that are already populated in $item->entity.
    $target_entities = [];
    foreach ($this->list as $delta => $item) {
      if ($item->target_id !== NULL) {
        $file = $file_handler::urlToFile($item->target_id);
        $target_entities[$delta] = $file;
      }
      elseif ($item
        ->hasNewEntity()) {
        $target_entities[$delta] = $item->entity;
      }
    }

    // Ensure the returned array is ordered by deltas.
    ksort($target_entities);
    return $target_entities;
  }

  /**
   * {@inheritdoc}
   */
  public function delete() {
    parent::delete();
    $entity = $this
      ->getEntity();

    // If a translation is deleted only decrement the file usage by one. If the
    // default translation is deleted remove all file usages within this entity.
    $count = $entity
      ->isDefaultTranslation() ? 0 : 1;
    foreach ($this
      ->referencedEntities() as $file) {
      if (!FileUrlHandler::isRemote($file)) {
        \Drupal::service('file.usage')
          ->delete($file, 'file', $entity
          ->getEntityTypeId(), $entity
          ->id(), $count);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function deleteRevision() {
    parent::deleteRevision();
    $entity = $this
      ->getEntity();

    // Decrement the file usage by 1.
    foreach ($this
      ->referencedEntities() as $file) {
      if (!FileUrlHandler::isRemote($file)) {
        \Drupal::service('file.usage')
          ->delete($file, 'file', $entity
          ->getEntityTypeId(), $entity
          ->id());
      }
    }
  }

}

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
EntityReferenceFieldItemList::defaultValuesFormSubmit public function Processes the submitted default value. Overrides FieldItemList::defaultValuesFormSubmit
EntityReferenceFieldItemList::processDefaultValue public static function Processes the default value before being applied. Overrides FieldItemList::processDefaultValue
FieldItemList::$langcode protected property The langcode of the field values held in the object.
FieldItemList::$list protected property Numerically indexed array of field items. Overrides ItemList::$list 1
FieldItemList::access public function Checks data value access. Overrides AccessibleInterface::access 1
FieldItemList::applyDefaultValue public function Applies the default value. Overrides TypedData::applyDefaultValue
FieldItemList::createItem protected function Helper for creating a list item object. Overrides ItemList::createItem
FieldItemList::defaultAccess public function Contains the default access logic of this field. Overrides FieldItemListInterface::defaultAccess 3
FieldItemList::defaultValuesFormValidate public function Validates the submitted default value. Overrides FieldItemListInterface::defaultValuesFormValidate 1
FieldItemList::defaultValueWidget protected function Returns the widget object used in default value form.
FieldItemList::delegateMethod protected function Calls a method on each FieldItem.
FieldItemList::equals public function Determines equality to another object implementing FieldItemListInterface. Overrides FieldItemListInterface::equals 2
FieldItemList::filterEmptyItems public function Filters out empty field items and re-numbers the item deltas. Overrides FieldItemListInterface::filterEmptyItems
FieldItemList::generateSampleItems public function Populates a specified number of field items with valid sample data. Overrides FieldItemListInterface::generateSampleItems 1
FieldItemList::getEntity public function Gets the entity that field belongs to. Overrides FieldItemListInterface::getEntity 1
FieldItemList::getFieldDefinition public function Gets the field definition. Overrides FieldItemListInterface::getFieldDefinition
FieldItemList::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemListInterface::getLangcode
FieldItemList::getSetting public function Returns the value of a given field setting. Overrides FieldItemListInterface::getSetting
FieldItemList::getSettings public function Returns the array of field settings. Overrides FieldItemListInterface::getSettings
FieldItemList::hasAffectingChanges public function Determines whether the field has relevant changes. Overrides FieldItemListInterface::hasAffectingChanges 1
FieldItemList::preSave public function Defines custom presave behavior for field values. Overrides FieldItemListInterface::preSave 1
FieldItemList::setLangcode public function Sets the langcode of the field values held in the object. Overrides FieldItemListInterface::setLangcode
FieldItemList::setValue public function Sets the data value. Overrides ItemList::setValue
FieldItemList::view public function Returns a renderable array for the field items. Overrides FieldItemListInterface::view
FieldItemList::__get public function Magic method: Gets a property value of to the first field item. Overrides FieldItemListInterface::__get
FieldItemList::__isset public function Magic method: Determines whether a property of the first field item is set. Overrides FieldItemListInterface::__isset
FieldItemList::__set public function Magic method: Sets a property value of the first field item. Overrides FieldItemListInterface::__set
FieldItemList::__unset public function Magic method: Unsets a property of the first field item. Overrides FieldItemListInterface::__unset
FileUrlFieldItemList::defaultValuesForm public function Returns a form for the default value input. Overrides FieldItemList::defaultValuesForm
FileUrlFieldItemList::delete public function Defines custom delete behavior for field values. Overrides FieldItemList::delete
FileUrlFieldItemList::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemList::deleteRevision
FileUrlFieldItemList::getConstraints public function Gets a list of validation constraints. Overrides EntityReferenceFieldItemList::getConstraints
FileUrlFieldItemList::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemList::postSave
FileUrlFieldItemList::referencedEntities public function Gets the entities referenced by this field, preserving field item deltas. Overrides EntityReferenceFieldItemList::referencedEntities
ItemList::appendItem public function Appends a new item to the list. Overrides ListInterface::appendItem
ItemList::count public function
ItemList::filter public function Filters the items in the list using a custom callback. Overrides ListInterface::filter
ItemList::first public function Returns the first item in this list. Overrides ListInterface::first
ItemList::get public function Returns the item at the specified position in this list. Overrides ListInterface::get 2
ItemList::getItemDefinition public function Gets the definition of a contained item. Overrides ListInterface::getItemDefinition
ItemList::getIterator public function
ItemList::getString public function Returns a string representation of the data. Overrides TypedData::getString
ItemList::getValue public function Gets the data value. Overrides TypedData::getValue
ItemList::isEmpty public function Determines whether the list contains any non-empty items. Overrides ListInterface::isEmpty
ItemList::offsetExists public function 1
ItemList::offsetGet public function
ItemList::offsetSet public function
ItemList::offsetUnset public function
ItemList::onChange public function React to changes to a child property or item. Overrides TraversableTypedDataInterface::onChange 1
ItemList::rekey protected function Renumbers the items in the list.
ItemList::removeItem public function Removes the item at the specified position. Overrides ListInterface::removeItem
ItemList::set public function Sets the value of the item at a given position in the list. Overrides ListInterface::set
ItemList::__clone public function Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
TypedData::$definition protected property The data definition. 1
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent public function Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct public function Constructs a TypedData object given its definition and context. 3
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2