public static function Workspace::baseFieldDefinitions in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/workspaces/src/Entity/Workspace.php \Drupal\workspaces\Entity\Workspace::baseFieldDefinitions()
2. 9 core/modules/workspaces/src/Entity/Workspace.php \Drupal\workspaces\Entity\Workspace::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

core/modules/workspaces/src/Entity/Workspace.php, line 74

Class

Workspace

The workspace entity class.

Namespace

Drupal\workspaces\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields += static::ownerBaseFieldDefinitions($entity_type);
  $fields['id'] = BaseFieldDefinition::create('string')
    ->setLabel(new TranslatableMarkup('Workspace ID'))
    ->setDescription(new TranslatableMarkup('The workspace ID.'))
    ->setSetting('max_length', 128)
    ->setRequired(TRUE)
    ->addConstraint('UniqueField')
    ->addConstraint('DeletedWorkspace')
    ->addPropertyConstraints('value', [
    'Regex' => [
      'pattern' => '/^[a-z0-9_]+$/',
    ],
  ]);
  $fields['label'] = BaseFieldDefinition::create('string')
    ->setLabel(new TranslatableMarkup('Workspace name'))
    ->setDescription(new TranslatableMarkup('The workspace name.'))
    ->setRevisionable(TRUE)
    ->setSetting('max_length', 128)
    ->setRequired(TRUE);
  $fields['uid']
    ->setLabel(new TranslatableMarkup('Owner'))
    ->setDescription(new TranslatableMarkup('The workspace owner.'))
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'weight' => 5,
  ])
    ->setDisplayConfigurable('form', TRUE);
  $fields['parent'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(new TranslatableMarkup('Parent'))
    ->setDescription(new TranslatableMarkup('The parent workspace.'))
    ->setSetting('target_type', 'workspace')
    ->setReadOnly(TRUE)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayOptions('form', [
    'type' => 'options_select',
    'weight' => 10,
  ]);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(new TranslatableMarkup('Changed'))
    ->setDescription(new TranslatableMarkup('The time that the workspace was last edited.'))
    ->setRevisionable(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(new TranslatableMarkup('Created'))
    ->setDescription(new TranslatableMarkup('The time that the workspace was created.'));
  return $fields;
}