public static function PathAlias::baseFieldDefinitions in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/path_alias/src/Entity/PathAlias.php \Drupal\path_alias\Entity\PathAlias::baseFieldDefinitions()
2. 9 core/modules/path_alias/src/Entity/PathAlias.php \Drupal\path_alias\Entity\PathAlias::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/path_alias/src/Entity/PathAlias.php, line 54

Class

PathAlias

Defines the path_alias entity class.

Namespace

Drupal\path_alias\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['path'] = BaseFieldDefinition::create('string')
    ->setLabel(new TranslatableMarkup('System path'))
    ->setDescription(new TranslatableMarkup('The path that this alias belongs to.'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE)
    ->addPropertyConstraints('value', [
    'Regex' => [
      'pattern' => '/^\\//i',
      'message' => new TranslatableMarkup('The source path has to start with a slash.'),
    ],
  ])
    ->addPropertyConstraints('value', [
    'ValidPath' => [],
  ]);
  $fields['alias'] = BaseFieldDefinition::create('string')
    ->setLabel(new TranslatableMarkup('URL alias'))
    ->setDescription(new TranslatableMarkup('An alias used with this path.'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE)
    ->addPropertyConstraints('value', [
    'Regex' => [
      'pattern' => '/^\\//i',
      'message' => new TranslatableMarkup('The alias path has to start with a slash.'),
    ],
  ]);
  $fields['langcode']
    ->setDefaultValue(LanguageInterface::LANGCODE_NOT_SPECIFIED);

  // Add the published field.
  $fields += static::publishedBaseFieldDefinitions($entity_type);
  $fields['status']
    ->setTranslatable(FALSE);
  return $fields;
}