BlockContent::baseFieldDefinitions

public static BlockContent::baseFieldDefinitions(EntityTypeInterface $entity_type)

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/block_content/src/Entity/BlockContent.php, line 153

Class

BlockContent: Defines the custom block entity class.

Namespace

Drupal\block_content\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
  $fields = parent::baseFieldDefinitions($entity_type);

  $fields['id']->setLabel(t('Custom block ID'))
    ->setDescription(t('The custom block ID.'));

  $fields['uuid']->setDescription(t('The custom block UUID.'));

  $fields['revision_id']->setDescription(t('The revision ID.'));

  $fields['langcode']->setDescription(t('The custom block language code.'));

  $fields['type']->setLabel(t('Block type'))
    ->setDescription(t('The block type.'));

  $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['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_created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Revision create time'))
    ->setDescription(t('The time that the current revision was created.'))
    ->setRevisionable(TRUE);

  $fields['revision_user'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Revision user'))
    ->setDescription(t('The user ID of the author of the current revision.'))
    ->setSetting('target_type', 'user')
    ->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;
}

Links:

https://api.drupal.org/api/drupal/core%21modules%21block_content%21src%21Entity%21BlockContent.php/function/BlockContent%3A%3AbaseFieldDefinitions/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments