public static function Task::baseFieldDefinitions in Search API 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/Task.php, line 159

Class

Task

Defines the Search API task entity class.

Namespace

Drupal\search_api\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {

  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['type'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Task type'))
    ->setSetting('max_length', 50)
    ->setRequired(TRUE)
    ->setReadOnly(TRUE);
  $fields['server_id'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Server ID'))
    ->setSetting('max_length', 50)
    ->setReadOnly(TRUE);
  $fields['index_id'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Index ID'))
    ->setSetting('max_length', 50)
    ->setReadOnly(TRUE);
  $fields['data'] = BaseFieldDefinition::create('string_long')
    ->setLabel(t('Task data'))
    ->setReadOnly(TRUE);
  return $fields;
}