public static function Individual::baseFieldDefinitions in CRM Core 8.2

Same name and namespace in other branches

1. 8.3 modules/crm_core_contact/src/Entity/Individual.php \Drupal\crm_core_contact\Entity\Individual::baseFieldDefinitions()
2. 8 modules/crm_core_contact/src/Entity/Individual.php \Drupal\crm_core_contact\Entity\Individual::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 FieldableEntityInterface::baseFieldDefinitions

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()

File

modules/crm_core_contact/src/Entity/Individual.php, line 74

Class

Individual

CRM Individual Entity Class.

Namespace

Drupal\crm_core_contact\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time that the individual was created.'))
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'datetime_timestamp',
    'weight' => -5,
  ])
    ->setDisplayConfigurable('form', TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the individual was last edited.'))
    ->setRevisionable(TRUE);
  $fields['uid'] = EntityOwnerTrait::getOwnerFieldDefinition()
    ->setDescription(t('The user that is the individual owner.'));
  $fields['name'] = BaseFieldDefinition::create('name')
    ->setLabel(t('Name'))
    ->setDescription(t('Name of the individual.'))
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'name_default',
    'weight' => 0,
  ])
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'name_default',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['sex'] = BaseFieldDefinition::create('list_string')
    ->setLabel(t('Sex'))
    ->setDescription(t('Sex of the individual.'))
    ->setSetting('allowed_values', [
    'unknown' => t('Unknown'),
    'female' => t('Female'),
    'male' => t('Male'),
    'other' => t('Other'),
  ])
    ->setDefaultValue('unknown')
    ->setDisplayOptions('form', [
    'type' => 'options_select',
    'weight' => 1,
  ]);
  $fields['birth_date'] = BaseFieldDefinition::create('datetime')
    ->setLabel(t('Birth date'))
    ->setDescription(t('Birth date of the individual.'))
    ->setRevisionable(TRUE)
    ->setSetting('datetime_type', [
    'datetime_type' => 'date',
  ])
    ->setDisplayOptions('form', [
    'type' => 'datetime_datelist',
    'weight' => 2,
  ]);
  $fields['email'] = BaseFieldDefinition::create('email_with_type')
    ->setLabel(t('Email'))
    ->setDescription(t('Email of the individual.'))
    ->setRevisionable(TRUE)
    ->setCardinality(FieldStorageConfigInterface::CARDINALITY_UNLIMITED)
    ->setSetting('email_types', [
    'private' => t('Private'),
    'corporate' => t('Corporate'),
  ])
    ->setDisplayOptions('form', [
    'type' => 'email_with_type',
    'weight' => 3,
  ]);
  return $fields;
}