You are here

public static function RemoteMapping::baseFieldDefinitions in Translation Management Tool 8

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/RemoteMapping.php, line 31

Class

RemoteMapping
Entity class for the tmgmt_remote entity.

Namespace

Drupal\tmgmt\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['trid'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Remote mapping ID'))
    ->setReadOnly(TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The node UUID.'))
    ->setReadOnly(TRUE);
  $fields['tjid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Job reference'))
    ->setSetting('target_type', 'tmgmt_job');
  $fields['tjiid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Job item reference'))
    ->setSetting('target_type', 'tmgmt_job_item');
  $fields['data_item_key'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Data Item Key'));
  $fields['remote_identifier_1'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Remote identifier 1'));
  $fields['remote_identifier_2'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Remote identifier 2'));
  $fields['remote_identifier_3'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Remote identifier 3'));
  $fields['remote_url'] = BaseFieldDefinition::create('uri')
    ->setLabel(t('Remote URL'));
  $fields['word_count'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Word count'))
    ->setDescription(t('Word count provided by the remote service.'));
  $fields['tags_count'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Tags count'))
    ->setDescription(t('HTML tags count provided by the remote service.'));
  $fields['amount'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Amount'))
    ->setDescription(t('Amount charged for the remote translation job.'));
  $fields['currency'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Currency'));
  $fields['remote_data'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Remote data'));
  return $fields;
}