public static function EntityTest::baseFieldDefinitions in Zircon Profile 8

Same name and namespace in other branches

8.0 core/modules/system/tests/modules/entity_test/src/Entity/EntityTest.php \Drupal\entity_test\Entity\EntityTest::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/system/tests/modules/entity_test/src/Entity/EntityTest.php, line 71: Contains \Drupal\entity_test\Entity\EntityTest.

Class

EntityTest: Defines the test entity class.

Namespace

Drupal\entity_test\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the test entity.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the test entity.'))
    ->setReadOnly(TRUE);
  $fields['langcode'] = BaseFieldDefinition::create('language')
    ->setLabel(t('Language code'))
    ->setDescription(t('The language code of the test entity.'))
    ->setTranslatable(TRUE);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The name of the test entity.'))
    ->setTranslatable(TRUE)
    ->setSetting('max_length', 32)
    ->setDisplayOptions('view', array(
    'label' => 'hidden',
    'type' => 'string',
    'weight' => -5,
  ))
    ->setDisplayOptions('form', array(
    'type' => 'string_textfield',
    'weight' => -5,
  ));

  // @todo: Add allowed values validation.
  $fields['type'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Type'))
    ->setDescription(t('The bundle of the test entity.'))
    ->setRequired(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Authored on'))
    ->setDescription(t('Time the entity was created'))
    ->setTranslatable(TRUE);
  $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('User ID'))
    ->setDescription(t('The ID of the associated user.'))
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setDefaultValue(array(
    0 => array(
      'target_id' => 1,
    ),
  ))
    ->setTranslatable(TRUE)
    ->setDisplayOptions('form', array(
    'type' => 'entity_reference_autocomplete',
    'weight' => -1,
    'settings' => array(
      'match_operator' => 'CONTAINS',
      'size' => '60',
      'placeholder' => '',
    ),
  ));
  return $fields;
}

You are here