public static function BlockContent::baseFieldDefinitions in Zircon Profile 8

Same name and namespace in other branches

8.0 core/modules/block_content/src/Entity/BlockContent.php \Drupal\block_content\Entity\BlockContent::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/block_content/src/Entity/BlockContent.php, line 151: Contains \Drupal\block_content\Entity\BlockContent.

Class

BlockContent: Defines the custom block entity class.

Namespace

Drupal\block_content\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Custom block ID'))
    ->setDescription(t('The custom block ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The custom block UUID.'))
    ->setReadOnly(TRUE);
  $fields['revision_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Revision ID'))
    ->setDescription(t('The revision ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['langcode'] = BaseFieldDefinition::create('language')
    ->setLabel(t('Language'))
    ->setDescription(t('The custom block language code.'))
    ->setTranslatable(TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('view', array(
    'type' => 'hidden',
  ))
    ->setDisplayOptions('form', array(
    'type' => 'language_select',
    'weight' => 2,
  ));
  $fields['info'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Block description'))
    ->setDescription(t('A brief description of your block.'))
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE)
    ->setRequired(TRUE)
    ->setDisplayOptions('form', array(
    'type' => 'string_textfield',
    'weight' => -5,
  ))
    ->setDisplayConfigurable('form', TRUE)
    ->addConstraint('UniqueField', []);
  $fields['type'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Block type'))
    ->setDescription(t('The block type.'))
    ->setSetting('target_type', 'block_content_type');
  $fields['revision_log'] = BaseFieldDefinition::create('string_long')
    ->setLabel(t('Revision log message'))
    ->setDescription(t('The log entry explaining the changes in this revision.'))
    ->setRevisionable(TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the custom block was last edited.'))
    ->setTranslatable(TRUE)
    ->setRevisionable(TRUE);
  $fields['revision_translation_affected'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Revision translation affected'))
    ->setDescription(t('Indicates if the last edit of a translation belongs to current revision.'))
    ->setReadOnly(TRUE)
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE);
  return $fields;
}

You are here