public static function ConfigPages::baseFieldDefinitions in Config Pages 8.2

Same name and namespace in other branches

1. 8.3 src/Entity/ConfigPages.php \Drupal\config_pages\Entity\ConfigPages::baseFieldDefinitions()
2. 8 src/Entity/ConfigPages.php \Drupal\config_pages\Entity\ConfigPages::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

src/Entity/ConfigPages.php, line 105

Class

ConfigPages

Defines the config page entity class.

Namespace

Drupal\config_pages\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Config page ID'))
    ->setDescription(t('The config page ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The config page UUID.'))
    ->setReadOnly(TRUE);
  $fields['label'] = BaseFieldDefinition::create('string')
    ->setLabel(t('ConfigPage description'))
    ->setDescription(t('A brief description of your config page.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'region' => 'hidden',
  ])
    ->setDisplayConfigurable('form', TRUE);
  $fields['type'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('ConfigPage type'))
    ->setDescription(t('The config page type.'))
    ->setSetting('target_type', 'config_pages_type');
  $fields['context'] = BaseFieldDefinition::create('string_long')
    ->setLabel(t('Context'))
    ->setDescription(t('The Config Page context.'))
    ->setRevisionable(FALSE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the config page was last edited.'))
    ->setTranslatable(TRUE)
    ->setRevisionable(TRUE);
  return $fields;
}