You are here

Home » API reference » Field collection 8.3 » FieldCollection.php

class FieldCollection in Field collection 8.3

Same name in this branch
  1. 8.3 src/Entity/FieldCollection.php \Drupal\field_collection\Entity\FieldCollection
  2. 8.3 src/Plugin/Field/FieldType/FieldCollection.php \Drupal\field_collection\Plugin\Field\FieldType\FieldCollection
Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldType/FieldCollection.php \Drupal\field_collection\Plugin\Field\FieldType\FieldCollection

Plugin implementation of the 'field_collection' field type.

Plugin annotation


@FieldType(
  id = "field_collection",
  label = @Translation("Field collection"),
  description = @Translation(
    "This field stores references to embedded entities, which itself may
    contain any number of fields."
  ),
  settings = {
    "path" = "",
    "hide_blank_items" = TRUE,
  },
  instance_settings = {
  },
  default_widget = "field_collection_embed",
  default_formatter = "field_collection_list",
  list_class = "\Drupal\field_collection\FieldCollectionItemList",
)

Hierarchy

Expanded class hierarchy of FieldCollection

1 file declares its use of FieldCollection
FieldCollectionItemNormalizer.php in src/Normalizer/FieldCollectionItemNormalizer.php

File

src/Plugin/Field/FieldType/FieldCollection.php, line 36

Namespace

Drupal\field_collection\Plugin\Field\FieldType
View source 
class FieldCollection extends EntityReferenceItem {

  /**
   * Cache for whether the host is a new revision.
   *
   * Set in preSave and used in update().  By the time update() is called
   * isNewRevision() for the host is always FALSE.
   *
   * @var bool
   */
  protected $newHostRevision;

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    return [
      'target_type' => 'field_collection_item',
    ] + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field) {
    return [
      'columns' => [
        'target_id' => [
          'type' => 'int',
          'unsigned' => TRUE,
          'description' => 'The ID of the field collection item.',
          'not null' => TRUE,
        ],
        'revision_id' => [
          'type' => 'int',
          'not null' => FALSE,
        ],
      ],
      'indexes' => [
        'target_id' => [
          'target_id',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['target_id'] = DataReferenceTargetDefinition::create('integer')
      ->setLabel(t('The ID of the field collection item.'))
      ->setSetting('unsigned', TRUE)
      ->setRequired(TRUE)
      ->setReadOnly(TRUE);
    $properties['revision_id'] = DataDefinition::create('integer')
      ->setLabel(t('Field collection item revision'))
      ->setReadOnly(TRUE);
    $properties['entity'] = DataReferenceDefinition::create('entity')
      ->setLabel(t('Field collection item'))
      ->setDescription(t('The referenced field collection item'))
      ->setComputed(TRUE)
      ->setReadOnly(TRUE)
      ->setTargetDefinition(EntityDataDefinition::create('field_collection_item'))
      ->addConstraint('EntityType', 'field_collection_item');
    return $properties;
  }

  /**
   * Override EntityReferenceItem storage settings form.
   *
   * The target type setting from EntityReferenceItem does not apply to field
   * collections so override the settings form with a blank one.
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    return [];
  }

  /**
   * Override EntityReferenceItem field settings form.
   *
   * These options do not apply to field collections.
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::fieldSettingsForm($form, $form_state);
    $form['handler']['#access'] = FALSE;
    $form['handler']['handler_settings']['target_bundles']['#access'] = FALSE;
    $form['handler']['handler_settings']['target_bundles']['#default_value'] = [
      $this
        ->getFieldDefinition()
        ->getName() => $this
        ->getFieldDefinition()
        ->getName(),
    ];
    $form['handler']['handler_settings']['auto_create']['#access'] = FALSE;
    $form['handler']['handler']['#access'] = FALSE;
    $form['handler']['handler_settings']['sort']['field']['#access'] = FALSE;
    return $form;
  }

  /**
   * @TODO
   */
  public function getFieldCollectionItem($create = FALSE, $use_reference = TRUE) {
    if ($use_reference && isset($this->entity)) {
      return $this->entity;
    }
    elseif (isset($this->target_id)) {

      // By default always load the default revision, so caches get used.
      $field_collection_item = FieldCollectionItem::load($this->target_id);
      if ($field_collection_item !== NULL && $field_collection_item
        ->getRevisionId() != $this->revision_id) {

        // A non-default revision is a referenced, so load this one.
        $field_collection_item = \Drupal::entityTypeManager()
          ->getStorage('field_collection_item')
          ->loadRevision($this->revision_id);
      }
      return $field_collection_item;
    }
    elseif ($create) {
      $field_collection_item = FieldCollectionItem::create([
        'field_name' => $this
          ->getFieldDefinition()
          ->getName(),
      ]);

      // TODO: Uncomment or delete

      /*
      $field_collection_item->setHostEntity($this->getEntity(), FALSE);
      */
      return $field_collection_item;
    }
    return FALSE;
  }
  public function delete() {
    $field_collection_item = $this
      ->getFieldCollectionItem();
    if ($field_collection_item !== NULL) {

      // Set a flag so the field collection item entity knows that the field in
      // its host is already being taken care of.
      // See \Drupal\field_collection\Entity\FieldCollectionItem::delete().
      $field_collection_item->field_collection_deleting = TRUE;
      $field_collection_item
        ->delete();
    }
    parent::delete();
  }

  // TODO: Format comment

  /**
   * Care about removed field collection items.
   *
   * Support saving field collection items in @code $item['entity'] @endcode. This
   * may be used to seamlessly create field collection items during host-entity
   * creation or to save changes to the host entity and its collections at once.
   */
  public function preSave() {
    if ($field_collection_item = $this
      ->getFieldCollectionItem()) {
      $host = $this
        ->getEntity();

      // Handle node cloning
      if ($host
        ->isNew() && !$field_collection_item
        ->isNew()) {

        // If the host entity is new but we have a field_collection that is not
        // new, it means that its host is being cloned. Thus we need to clone
        // the field collection entity as well.
        $field_collection_item = $field_collection_item
          ->createDuplicate();
      }

      // TODO: Handle deleted items

      /*
      $field_name = $this->getFieldDefinition()->field_name;
      $host_original = $host->original;
      $items_original = !empty($host_original->$field_name) ? $host_original->$field_name : [];
      $original_by_id = array_flip(field_collection_field_item_to_ids($items_original));
      foreach ($items as &$item) {
      */

      // TODO: Handle deleted items

      /*
        unset($original_by_id[$item['target_id']]);
      }
      // If there are removed items, care about deleting the item entities.
      if ($original_by_id) {
        $ids = array_flip($original_by_id);
        // If we are creating a new revision, the old-items should be kept but get
        // marked as archived now.
        if (!empty($host_entity->revision)) {
          db_update('field_collection_item')
            ->fields(['archived' => 1])
            ->condition('target_id', $ids, 'IN')
            ->execute();
        }
        else {
          // Delete unused field collection items now.
          foreach (FieldCollectionItem::loadMultiple($ids) as $un_item) {
            $un_item->updateHostEntity($host_entity);
            $un_item->deleteRevision(TRUE);
          }
        }
      }
      */
      $this->newHostRevision = $host
        ->isNewRevision();

      // If the host entity is saved as new revision, do the same for the item.
      if ($this->newHostRevision) {
        $field_collection_item
          ->setNewRevision();

        // TODO: Verify for D8, may not be necessary

        /*
        // Without this cache clear entity_revision_is_default will
        // incorrectly return false here when creating a new published revision
        if (!isset($cleared_host_entity_cache)) {
          list($entity_id) = entity_extract_ids($host_entity_type, $host_entity);
          entity_get_controller($host_entity_type)->resetCache([$entity_id]);
          $cleared_host_entity_cache = true;
        }
        */
        if ($host
          ->isDefaultRevision()) {
          $field_collection_item
            ->isDefaultRevision(TRUE);

          //$entity->archived = FALSE;
        }
      }
      if ($field_collection_item
        ->isNew()) {
        $field_collection_item
          ->setHostEntity($this
          ->getEntity(), FALSE);
      }
      $field_collection_item
        ->save(TRUE);
      $this->target_id = $field_collection_item
        ->id();
      $this->revision_id = $field_collection_item
        ->getRevisionId();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    if ($this->target_id) {
      return FALSE;
    }
    else {
      if ($this
        ->getFieldCollectionItem()) {
        return $this
          ->getFieldCollectionItem()
          ->isEmpty();
      }
    }
    return TRUE;
  }

  /**
   * No preconfigured options.
   *
   * This overrides the EntityReferenceItem version because that would allow
   * FieldCollectionItem fields to be created that could point to entities
   * other than FieldCollectionItems.
   */
  public static function getPreconfiguredOptions() {
    return [];
  }

}

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
EntityReferenceItem::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemBase::calculateDependencies
EntityReferenceItem::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemBase::calculateStorageDependencies
EntityReferenceItem::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings 1
EntityReferenceItem::fieldSettingsAjaxProcess public static function Render API callback: Processes the field settings form and allows access to the form state.
EntityReferenceItem::fieldSettingsAjaxProcessElement public static function Adds entity_reference specific properties to AJAX form elements from the field settings form.
EntityReferenceItem::fieldSettingsFormValidate public static function Form element validation handler; Invokes selection plugin's validation.
EntityReferenceItem::formProcessMergeParent public static function Render API callback: Moves entity_reference specific Form API elements (i.e. 'handler_settings') up a level for easier processing by the validation and submission handlers.
EntityReferenceItem::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemBase::generateSampleValue 1
EntityReferenceItem::getConstraints public function Gets a list of validation constraints. Overrides TypedData::getConstraints
EntityReferenceItem::getPossibleOptions public function Returns an array of possible values with labels for display. Overrides OptionsProviderInterface::getPossibleOptions
EntityReferenceItem::getPossibleValues public function Returns an array of possible values. Overrides OptionsProviderInterface::getPossibleValues
EntityReferenceItem::getRandomBundle protected static function Gets a bundle for a given entity type and selection options.
EntityReferenceItem::getSettableOptions public function Returns an array of settable values with labels for display. Overrides OptionsProviderInterface::getSettableOptions
EntityReferenceItem::getSettableValues public function Returns an array of settable values. Overrides OptionsProviderInterface::getSettableValues
EntityReferenceItem::getValue public function Gets the data value. Overrides Map::getValue
EntityReferenceItem::hasNewEntity public function Determines whether the item holds an unsaved entity.
EntityReferenceItem::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
EntityReferenceItem::onChange public function React to changes to a child property or item. Overrides Map::onChange
EntityReferenceItem::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemBase::onDependencyRemoval
EntityReferenceItem::settingsAjax public static function Ajax callback for the handler settings form.
EntityReferenceItem::settingsAjaxSubmit public static function Submit handler for the non-JS case.
EntityReferenceItem::setValue public function Sets the data value. Overrides FieldItemBase::setValue
FieldCollection::$newHostRevision protected property Cache for whether the host is a new revision.
FieldCollection::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides EntityReferenceItem::defaultStorageSettings
FieldCollection::delete public function Defines custom delete behavior for field values. Overrides FieldItemBase::delete
FieldCollection::fieldSettingsForm public function Override EntityReferenceItem field settings form. Overrides EntityReferenceItem::fieldSettingsForm
FieldCollection::getFieldCollectionItem public function @TODO
FieldCollection::getPreconfiguredOptions public static function No preconfigured options. Overrides EntityReferenceItem::getPreconfiguredOptions
FieldCollection::isEmpty public function Determines whether the data structure is empty. Overrides EntityReferenceItem::isEmpty
FieldCollection::preSave public function Care about removed field collection items. Overrides EntityReferenceItem::preSave
FieldCollection::propertyDefinitions public static function Defines field item properties. Overrides EntityReferenceItem::propertyDefinitions
FieldCollection::schema public static function Returns the schema for the field. Overrides EntityReferenceItem::schema
FieldCollection::storageSettingsForm public function Override EntityReferenceItem storage settings form. Overrides EntityReferenceItem::storageSettingsForm
FieldItemBase::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting protected function Returns the value of a field setting.
FieldItemBase::getSettings protected function Returns the array of field settings.
FieldItemBase::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave 2
FieldItemBase::storageSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue protected function Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct public function Constructs a TypedData object given its definition and context. Overrides TypedData::__construct 1
FieldItemBase::__get public function Magic method: Gets a property value. Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Magic method: Sets a property value. Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Magic method: Unsets a property. Overrides FieldItemInterface::__unset
Map::$definition protected property The data definition. Overrides TypedData::$definition
Map::$properties protected property The array of properties.
Map::$values protected property An array of values for the contained properties.
Map::applyDefaultValue public function Applies the default value. Overrides TypedData::applyDefaultValue 4
Map::get public function Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator public function
Map::getProperties public function Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString public function Returns a string representation of the data. Overrides TypedData::getString
Map::set public function Sets a property value. Overrides ComplexDataInterface::set
Map::toArray public function Returns an array of all property values. Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
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::$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
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