public static function Shortcut::baseFieldDefinitions in Zircon Profile 8

Same name and namespace in other branches

8.0 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 FieldableEntityInterface::baseFieldDefinitions

File

core/modules/shortcut/src/Entity/Shortcut.php, line 112: Contains \Drupal\shortcut\Entity\Shortcut.

Class

Shortcut: Defines the shortcut entity class.

Namespace

Drupal\shortcut\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the shortcut.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the shortcut.'))
    ->setReadOnly(TRUE);
  $fields['shortcut_set'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Shortcut set'))
    ->setDescription(t('The bundle of the shortcut.'))
    ->setSetting('target_type', 'shortcut_set')
    ->setRequired(TRUE);
  $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', array(
    'type' => 'string_textfield',
    'weight' => -10,
    'settings' => array(
      '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(array(
    'link_type' => LinkItemInterface::LINK_INTERNAL,
    'title' => DRUPAL_DISABLED,
  ))
    ->setDisplayOptions('form', array(
    'type' => 'link_default',
    'weight' => 0,
  ))
    ->setDisplayConfigurable('form', TRUE);
  $fields['langcode'] = BaseFieldDefinition::create('language')
    ->setLabel(t('Language'))
    ->setDescription(t('The language code of the shortcut.'))
    ->setTranslatable(TRUE)
    ->setDisplayOptions('view', array(
    'type' => 'hidden',
  ))
    ->setDisplayOptions('form', array(
    'type' => 'language_select',
    'weight' => 2,
  ));
  return $fields;
}

You are here