public static function WorkspaceAssociation::baseFieldDefinitions in Workspace 8.2

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/WorkspaceAssociation.php, line 45

Class

WorkspaceAssociation

Defines the Workspace association entity.

Namespace

Drupal\workspace\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['workspace'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(new TranslatableMarkup('workspace'))
    ->setDescription(new TranslatableMarkup('The workspace of the referenced content.'))
    ->setSetting('target_type', 'workspace')
    ->setRequired(TRUE)
    ->setRevisionable(TRUE)
    ->addConstraint('workspace', []);
  $fields['target_entity_type_id'] = BaseFieldDefinition::create('string')
    ->setLabel(new TranslatableMarkup('Content entity type ID'))
    ->setDescription(new TranslatableMarkup('The ID of the content entity type associated with this workspace.'))
    ->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH)
    ->setRequired(TRUE)
    ->setRevisionable(TRUE);
  $fields['target_entity_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(new TranslatableMarkup('Content entity ID'))
    ->setDescription(new TranslatableMarkup('The ID of the content entity associated with this workspace.'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE);
  $fields['target_entity_revision_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(new TranslatableMarkup('Content entity revision ID'))
    ->setDescription(new TranslatableMarkup('The revision ID of the content entity associated with this workspace.'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE);
  return $fields;
}