public static function ReplicationLog::baseFieldDefinitions in Replication 8.2

Same name and namespace in other branches

1. 8 src/Entity/ReplicationLog.php \Drupal\replication\Entity\ReplicationLog::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/ReplicationLog.php, line 96

Class

ReplicationLog

The replication log entity type.

Namespace

Drupal\replication\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the replication log entity.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the replication log entity.'))
    ->setReadOnly(TRUE);
  $fields['revision_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Revision ID'))
    ->setDescription(t('The local revision ID of the replication log entity.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['history'] = BaseFieldDefinition::create('replication_history')
    ->setLabel(t('Replication log history'))
    ->setDescription(t('The version id of the test entity.'))
    ->setRevisionable(TRUE)
    ->setReadOnly(TRUE)
    ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
  $fields['session_id'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('Replication session ID'))
    ->setDescription(t('The unique session ID of the last replication. Shortcut to the session_id in the last history item.'))
    ->setRevisionable(TRUE)
    ->setReadOnly(TRUE);
  $fields['source_last_seq'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Last processed checkpoint'))
    ->setDescription(t('The last processed checkpoint. Shortcut to the source_last_seq in the last history item.'))
    ->setRevisionable(TRUE)
    ->setReadOnly(TRUE);
  $fields['ok'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('ok'))
    ->setDescription(t('Replication status'))
    ->setRevisionable(TRUE)
    ->setDefaultValue(TRUE)
    ->setReadOnly(TRUE);
  return $fields;
}