public static function EntityOwnerTrait::ownerBaseFieldDefinitions in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/user/src/EntityOwnerTrait.php \Drupal\user\EntityOwnerTrait::ownerBaseFieldDefinitions()
2. 9 core/modules/user/src/EntityOwnerTrait.php \Drupal\user\EntityOwnerTrait::ownerBaseFieldDefinitions()

Returns an array of base field definitions for entity owners.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type to add the owner field to.

Return value

\Drupal\Core\Field\BaseFieldDefinition[] An array of base field definitions.

Throws

\Drupal\Core\Entity\Exception\UnsupportedEntityTypeDefinitionException Thrown when the entity type does not implement EntityOwnerInterface or if it does not have an "owner" entity key.

3 calls to EntityOwnerTrait::ownerBaseFieldDefinitions()

File::baseFieldDefinitions in core/modules/file/src/Entity/File.php

Provides base field definitions for an entity type.

Media::baseFieldDefinitions in core/modules/media/src/Entity/Media.php

Provides base field definitions for an entity type.

Workspace::baseFieldDefinitions in core/modules/workspaces/src/Entity/Workspace.php

Provides base field definitions for an entity type.

File

core/modules/user/src/EntityOwnerTrait.php, line 28

Class

EntityOwnerTrait

Provides a trait for entities that have an owner.

Namespace

Drupal\user

Code

public static function ownerBaseFieldDefinitions(EntityTypeInterface $entity_type) {
  if (!is_subclass_of($entity_type
    ->getClass(), EntityOwnerInterface::class)) {
    throw new UnsupportedEntityTypeDefinitionException('The entity type ' . $entity_type
      ->id() . ' does not implement \\Drupal\\user\\EntityOwnerInterface.');
  }
  if (!$entity_type
    ->hasKey('owner')) {
    throw new UnsupportedEntityTypeDefinitionException('The entity type ' . $entity_type
      ->id() . ' does not have an "owner" entity key.');
  }
  return [
    $entity_type
      ->getKey('owner') => BaseFieldDefinition::create('entity_reference')
      ->setLabel(new TranslatableMarkup('User ID'))
      ->setSetting('target_type', 'user')
      ->setTranslatable($entity_type
      ->isTranslatable())
      ->setDefaultValueCallback(static::class . '::getDefaultEntityOwner'),
  ];
}