public static function Workspace::baseFieldDefinitions in Multiversion 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

File

src/Entity/Workspace.php, line 55

Class

Workspace: The workspace entity class.

Namespace

Drupal\multiversion\Entity

Code

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

  // Add the published field.
  $fields += static::publishedBaseFieldDefinitions($entity_type);
  $fields['label'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Workspace name'))
    ->setDescription(t('The workspace name.'))
    ->setRevisionable(TRUE)
    ->setSetting('max_length', 128)
    ->setRequired(TRUE);
  $fields['machine_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Workspace ID'))
    ->setDescription(t('The workspace machine name.'))
    ->setRevisionable(TRUE)
    ->setSetting('max_length', 128)
    ->setRequired(TRUE)
    ->addPropertyConstraints('value', [
    'Regex' => [
      'pattern' => '/^[\\da-z_$()+-\\/]*$/',
    ],
  ]);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Owner'))
    ->setDescription(t('The workspace owner.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setDefaultValueCallback('Drupal\\multiversion\\Entity\\Workspace::getCurrentUserId');
  $fields['type'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Type'))
    ->setDescription(t('The workspace type.'))
    ->setSetting('target_type', 'workspace_type')
    ->setReadOnly(TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the workspace was last edited.'))
    ->setRevisionable(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The UNIX timestamp of when the workspace has been created.'));
  $fields['published']
    ->addConstraint('UnpublishWorkspace');
  $fields['queued_for_delete'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Queued for delete'))
    ->setDescription(t('A flag that specifies if the entity has been queued for delete on next cron run.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setRequired(FALSE)
    ->setDefaultValue(FALSE)
    ->setInitialValue(FALSE);
  return $fields;
}

You are here