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

Class

Synonym

Defines the Synonym entity.

Namespace

Drupal\search_api_synonym\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {

  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */

  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['sid'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the Synonym entity.'))
    ->setReadOnly(TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the Synonym entity.'))
    ->setReadOnly(TRUE);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Authored by'))
    ->setDescription(t('The user ID of author of the Synonym entity.'))
    ->setSettings([
    'target_type' => 'user',
    'handler' => 'default',
    'required' => TRUE,
  ])
    ->setDefaultValueCallback('Drupal\\node\\Entity\\Node::getDefaultEntityOwner')
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'author',
    'weight' => 0,
  ])
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'weight' => 5,
    'settings' => [
      'match_operator' => 'CONTAINS',
      'size' => '60',
      'autocomplete_type' => 'tags',
      'placeholder' => '',
    ],
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['type'] = BaseFieldDefinition::create('list_string')
    ->setLabel(t('Type'))
    ->setDescription(t('The type of synonym.'))
    ->setSettings([
    'max_length' => 50,
    'allowed_values' => array(
      'synonym' => 'Synonym',
      'spelling_error' => 'Spelling error',
    ),
  ])
    ->setRequired(TRUE)
    ->setDefaultValue('')
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'string',
    'weight' => -3,
  ])
    ->setDisplayOptions('form', [
    'type' => 'options_buttons',
    'weight' => -3,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['word'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Word'))
    ->setDescription(t('The word we are defining synonyms for.'))
    ->setSettings([
    'max_length' => 128,
    'text_processing' => 0,
  ])
    ->setRequired(TRUE)
    ->setDefaultValue('')
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'string',
    'weight' => -4,
  ])
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -4,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['synonyms'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Synonyms'))
    ->setDescription(t('The synonyms to the word. Separate multiple by comma.'))
    ->setSettings([
    'max_length' => 1024,
    'text_processing' => 0,
  ])
    ->setRequired(TRUE)
    ->setDefaultValue('')
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'string',
    'weight' => -3,
  ])
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -3,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Activate synonym'))
    ->setDescription(t('Only active synonyms will be used.'))
    ->setDefaultValue(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'boolean',
    'weight' => -2,
  ])
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
    'weight' => -2,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['langcode'] = BaseFieldDefinition::create('language')
    ->setLabel(t('Language'))
    ->setDescription(t('The language for the Synonym entity.'))
    ->setDisplayOptions('form', [
    'type' => 'language_select',
    'weight' => 10,
  ])
    ->setDisplayConfigurable('form', 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.'));
  return $fields;
}