public static function ImportEntity::baseFieldDefinitions in Content Synchronizer 3.x

Same name and namespace in other branches

1. 8.2 src/Entity/ImportEntity.php \Drupal\content_synchronizer\Entity\ImportEntity::baseFieldDefinitions()
2. 8 src/Entity/ImportEntity.php \Drupal\content_synchronizer\Entity\ImportEntity::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/ImportEntity.php, line 221

Class

ImportEntity

Defines the Import entity.

Namespace

Drupal\content_synchronizer\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Authored by'))
    ->setDescription(t('The user ID of author of the Import entity.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'author',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('view', TRUE);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The name of the Import entity.'))
    ->setSettings([
    'max_length' => 50,
    'text_processing' => 0,
  ])
    ->setDefaultValue('')
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'string',
    'weight' => -4,
  ])
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -4,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Publishing status'))
    ->setDescription(t('A boolean indicating whether the Import is published.'))
    ->setDefaultValue(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time that the entity was created.'));
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the entity was last edited.'));
  $extension = 'gz';
  $validators = [
    'file_validate_extensions' => [
      $extension,
    ],
    'file_validate_size' => [
      Environment::getUploadMaxSize(),
    ],
  ];
  $fields[self::FIELD_ARCHIVE] = BaseFieldDefinition::create('file')
    ->setLabel(t('Archive'))
    ->setDescription(t('The archive'))
    ->setSetting('upload_validators', $validators)
    ->setSetting('file_extensions', $extension)
    ->setRequired(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'file',
    'weight' => -3,
  ])
    ->setDisplayOptions('form', [
    'type' => 'file',
    // doesn't work.
    'description' => [
      // doesn't work.
      'theme' => 'file_upload_help',
      // doesn't work.
      'description' => t('A Gettext Portable Object file.'),
    ],
    'settings' => [
      'upload_validators' => $validators,
    ],
    'weight' => -3,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields[self::FIELD_PROCESSING_STATUS] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Processing status'))
    ->setDescription(t('Processing status'))
    ->setDefaultValue(self::STATUS_NOT_STARTED);
  return $fields;
}