You are here

Home » API reference » Mini site 8 » MinisiteItemList.php

class MinisiteItemList in Mini site 8

Class MinisiteItemList.

Represents a configurable Minisite file field.

@package Drupal\minisite\Plugin\Field\FieldType

Hierarchy

Expanded class hierarchy of MinisiteItemList

File

src/Plugin/Field/FieldType/MinisiteItemList.php, line 15

Namespace

Drupal\minisite\Plugin\Field\FieldType
View source 
class MinisiteItemList extends FileFieldItemList {

  /**
   * {@inheritdoc}
   */
  public function postSave($update) {
    parent::postSave($update);
    $result = [];

    // Item update or creation.
    if (!$this
      ->isEmpty()) {
      $result = $this
        ->delegateMethodForItemList('postSave', $this, $update);
    }
    else {
      $original_item_list = $this
        ->getOriginalItemsList();
      if ($original_item_list) {
        $result = $this
          ->delegateMethodForItemList('delete', $original_item_list);
      }
    }
    return (bool) array_filter($result);
  }

  /**
   * Get original item list for the current instance.
   *
   * @return null|\Drupal\Core\Field\FieldItemList
   *   The original item list for the same language as the current item list
   *   or NULL if the item list for the same language does not exist.
   */
  protected function getOriginalItemsList() {
    $entity = $this
      ->getEntity();
    $original = $entity->original;
    $field_name = $this
      ->getFieldDefinition()
      ->getName();
    $langcode = $this
      ->getLangcode();
    if (!$original || !$original
      ->hasTranslation($langcode)) {
      return NULL;
    }
    return $original
      ->getTranslation($langcode)->{$field_name};
  }

  /**
   * Delegate method for an items list.
   *
   * Works in the same way as
   * \Drupal\Core\Field\EntityReferenceFieldItemList::delegateMethod(), but
   * with supplied items list object.
   *
   * Any argument passed will be forwarded to the invoked method.
   *
   * @param string $method
   *   The method name to call for each item in the list.
   * @param \Drupal\Core\Field\FieldItemList $item_list
   *   The items list to traverse.
   *
   * @return array
   *   An array of results keyed by delta.
   *
   * @see \Drupal\Core\Field\FieldItemList::delegateMethod()
   */
  protected function delegateMethodForItemList($method, FieldItemList $item_list) {
    $result = [];
    $args = array_slice(func_get_args(), 2);
    foreach ($item_list->list as $delta => $item) {

      // call_user_func_array() is way slower than a direct call so we avoid
      // using it if have no parameters.
      $result[$delta] = $args ? call_user_func_array([
        $item,
        $method,
      ], $args) : $item
        ->{$method}();
    }
    return $result;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
EntityReferenceFieldItemList::defaultValuesFormSubmit public function Processes the submitted default value. Overrides FieldItemList::defaultValuesFormSubmit
EntityReferenceFieldItemList::getConstraints public function Gets a list of validation constraints. Overrides FieldItemList::getConstraints
EntityReferenceFieldItemList::processDefaultValue public static function Processes the default value before being applied. Overrides FieldItemList::processDefaultValue
EntityReferenceFieldItemList::referencedEntities public function Gets the entities referenced by this field, preserving field item deltas. Overrides EntityReferenceFieldItemListInterface::referencedEntities
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
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
FileFieldItemList::defaultValuesForm public function Returns a form for the default value input. Overrides FieldItemList::defaultValuesForm
FileFieldItemList::delete public function Defines custom delete behavior for field values. Overrides FieldItemList::delete
FileFieldItemList::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemList::deleteRevision
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.
MinisiteItemList::delegateMethodForItemList protected function Delegate method for an items list.
MinisiteItemList::getOriginalItemsList protected function Get original item list for the current instance.
MinisiteItemList::postSave public function Defines custom post-save behavior for field values. Overrides FileFieldItemList::postSave
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.
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