public static function Relation::baseFieldDefinitions in CRM Core 8

Same name and namespace in other branches

1. 8.3 modules/crm_core_user_sync/src/Entity/Relation.php \Drupal\crm_core_user_sync\Entity\Relation::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

modules/crm_core_user_sync/src/Entity/Relation.php, line 113

Class

Relation

Defines the relation entity class.

Namespace

Drupal\crm_core_user_sync\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
    ->setRequired(TRUE)
    ->setCardinality(1)
    ->addConstraint('UniqueReference')
    ->setLabel(t('User'))
    ->setDescription(t('The user ID of the relation.'))
    ->setSetting('target_type', 'user')
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'settings' => [
      'match_operator' => 'CONTAINS',
      'size' => 60,
      'placeholder' => '',
    ],
    'weight' => 10,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'entity_reference_label',
    'weight' => 10,
  ])
    ->setDisplayConfigurable('view', TRUE);
  $fields['individual_id'] = BaseFieldDefinition::create('entity_reference')
    ->setRequired(TRUE)
    ->setCardinality(1)
    ->addConstraint('UniqueReference')
    ->setLabel(t('Individual'))
    ->setDescription(t('The individual ID of the relation.'))
    ->setSetting('target_type', 'crm_core_individual')
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'settings' => [
      'match_operator' => 'CONTAINS',
      'size' => 60,
      'placeholder' => '',
    ],
    'weight' => 15,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'entity_reference_label',
    'weight' => 15,
  ])
    ->setDisplayConfigurable('view', TRUE);
  return $fields;
}