ContentModerationState::baseFieldDefinitions

public static ContentModerationState::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/content_moderation/src/Entity/ContentModerationState.php, line 47

Class

ContentModerationState: Defines the Content moderation state entity.

Namespace

Drupal\content_moderation\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);

  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('User'))
    ->setDescription(t('The username of the entity creator.'))
    ->setSetting('target_type', 'user')
    ->setDefaultValueCallback('Drupal\content_moderation\Entity\ContentModerationState::getCurrentUserId')
    ->setTranslatable(TRUE)
    ->setRevisionable(TRUE);

  $fields['moderation_state'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Moderation state'))
    ->setDescription(t('The moderation state of the referenced content.'))
    ->setSetting('target_type', 'moderation_state')
    ->setRequired(TRUE)
    ->setTranslatable(TRUE)
    ->setRevisionable(TRUE)
    ->addConstraint('ModerationState', []);

  $fields['content_entity_type_id'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Content entity type ID'))
    ->setDescription(t('The ID of the content entity type this moderation state is for.'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE);

  $fields['content_entity_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Content entity ID'))
    ->setDescription(t('The ID of the content entity this moderation state is for.'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE);

  // @todo https://www.drupal.org/node/2779931 Add constraint that enforces
  //   unique content_entity_type_id, content_entity_id and
  //   content_entity_revision_id.

  $fields['content_entity_revision_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Content entity revision ID'))
    ->setDescription(t('The revision ID of the content entity this moderation state is for.'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE);

  return $fields;
}

Links:

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

doc_Drupal

2016-10-29 08:58:01

Comments