public static function PreviewLink::baseFieldDefinitions in Preview Link 2.0.x

Same name and namespace in other branches

1. 8 src/Entity/PreviewLink.php \Drupal\preview_link\Entity\PreviewLink::baseFieldDefinitions()
2. 2.x src/Entity/PreviewLink.php \Drupal\preview_link\Entity\PreviewLink::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()

1 call to PreviewLink::baseFieldDefinitions()

PreviewLinkEntityTest::testDefaultSettings in tests/src/Kernel/PreviewLinkEntityTest.php

Test default settings.

File

src/Entity/PreviewLink.php, line 114

Class

PreviewLink

Defines the node entity class.

Namespace

Drupal\preview_link\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['token'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Preview Token'))
    ->setDescription(t('A token that allows any user to view a preview of this entity.'))
    ->setRequired(TRUE);
  $fields['entities'] = BaseFieldDefinition::create('dynamic_entity_reference')
    ->setLabel(t('Entities'))
    ->setDescription(t('The associated entities this preview link unlocks.'))
    ->setRequired(TRUE)
    ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
    ->addConstraint('PreviewLinkEntitiesUniqueConstraint', [])
    ->setSettings(static::entitiesDefaultFieldSettings())
    ->setDisplayOptions('form', [
    'type' => 'preview_link_entities_widget',
    'weight' => 10,
  ]);
  $fields['generated_timestamp'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Generated Timestamp'))
    ->setDescription(t('The time the link was generated'))
    ->setRequired(TRUE);
  return $fields;
}