public static function Shortcut::baseFieldDefinitions in Drupal 9

Same name and namespace in other branches

8 core/modules/shortcut/src/Entity/Shortcut.php \Drupal\shortcut\Entity\Shortcut::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

File

core/modules/shortcut/src/Entity/Shortcut.php, line 114

Class

Shortcut: Defines the shortcut entity class.

Namespace

Drupal\shortcut\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {

  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['id']
    ->setDescription(t('The ID of the shortcut.'));
  $fields['uuid']
    ->setDescription(t('The UUID of the shortcut.'));
  $fields['shortcut_set']
    ->setLabel(t('Shortcut set'))
    ->setDescription(t('The bundle of the shortcut.'));
  $fields['langcode']
    ->setDescription(t('The language code of the shortcut.'));
  $fields['title'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The name of the shortcut.'))
    ->setRequired(TRUE)
    ->setTranslatable(TRUE)
    ->setSetting('max_length', 255)
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -10,
    'settings' => [
      'size' => 40,
    ],
  ]);
  $fields['weight'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Weight'))
    ->setDescription(t('Weight among shortcuts in the same shortcut set.'));
  $fields['link'] = BaseFieldDefinition::create('link')
    ->setLabel(t('Path'))
    ->setDescription(t('The location this shortcut points to.'))
    ->setRequired(TRUE)
    ->setSettings([
    'link_type' => LinkItemInterface::LINK_INTERNAL,
    'title' => DRUPAL_DISABLED,
  ])
    ->setDisplayOptions('form', [
    'type' => 'link_default',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE);
  return $fields;
}

You are here