public static function FieldCollectionItem::baseFieldDefinitions in Field collection 8

Same name and namespace in other branches

1. 8.3 src/Entity/FieldCollectionItem.php \Drupal\field_collection\Entity\FieldCollectionItem::baseFieldDefinitions()

Provides base field definitions for an entity type.

Implementations typically use the class \Drupal\Core\Field\BaseFieldDefinition for creating the field definitions; for example a 'name' field could be defined as the following:

$fields['name'] = BaseFieldDefinition::create('string')
  ->setLabel(t('Name'));

By definition, base fields are fields that exist for every bundle. To provide definitions for fields that should only exist on some bundles, use \Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions().

The definitions returned by this function can be overridden for all bundles by hook_entity_base_field_info_alter() or overridden on a per-bundle basis via 'base_field_override' configuration entities.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type definition. Useful when a single class is used for multiple, possibly dynamic entity types.

Return value

\Drupal\Core\Field\FieldDefinitionInterface[] An array of base field definitions for the entity type, keyed by field name.

Overrides ContentEntityBase::baseFieldDefinitions

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()

File

src/Entity/FieldCollectionItem.php, line 94

Class

FieldCollectionItem

Defines the field collection item entity class.

Namespace

Drupal\field_collection\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['item_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Field collection item ID'))
    ->setDescription(t('The field collection item ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['host_type'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Host\'s entity type'))
    ->setDescription(t('Type of entity for the field collection item\'s host.'))
    ->setReadOnly(TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The field collection item UUID.'))
    ->setReadOnly(TRUE);
  $fields['revision_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Revision ID'))
    ->setDescription(t('The field collection item revision ID.'))
    ->setReadOnly(TRUE);
  $fields['field_name'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Type'))
    ->setDescription(t('The field collection item field.'))
    ->setSetting('target_type', 'field_collection')
    ->setReadOnly(TRUE);
  return $fields;
}