public static function Contact::baseFieldDefinitions in RedHen CRM 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

modules/redhen_contact/src/Entity/Contact.php, line 313

Class

Contact

Defines the Contact entity.

Namespace

Drupal\redhen_contact\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $config = \Drupal::config('redhen_contact.settings');
  $fields = parent::baseFieldDefinitions($entity_type);
  $required_names = $config
    ->get('required_properties');
  $fields['first_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('First Name'))
    ->setSettings([
    'max_length' => 255,
    'text_processing' => 0,
  ])
    ->setDefaultValue('')
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -10,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setRequired($required_names['first_name'])
    ->setRevisionable(TRUE);
  $fields['middle_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Middle Name'))
    ->setSettings([
    'max_length' => 255,
    'text_processing' => 0,
  ])
    ->setDefaultValue('')
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -9,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setRequired($required_names['middle_name'])
    ->setRevisionable(TRUE);
  $fields['last_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Last Name'))
    ->setSettings([
    'max_length' => 255,
    'text_processing' => 0,
  ])
    ->setDefaultValue('')
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -8,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setRequired($required_names['last_name'])
    ->setRevisionable(TRUE);
  $fields['email'] = BaseFieldDefinition::create('email')
    ->setLabel(t('Email'))
    ->setDefaultValue('')
    ->addConstraint('ContactEmailUnique')
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'email_mailto',
    'weight' => -4,
  ])
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -4,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setRevisionable(TRUE)
    ->setRequired($config
    ->get('valid_email'));
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Linked user'))
    ->setDescription(t('The Drupal user this contact is linked to.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setTranslatable(FALSE)
    ->setRequired(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'entity_reference_label',
    'settings' => [
      'link' => TRUE,
    ],
    '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['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Active'))
    ->setDescription(t('A boolean indicating whether the Contact is active.'))
    ->setDefaultValue(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
    'settings' => [
      'display_label' => TRUE,
    ],
    'weight' => 16,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time that the contact was created.'))
    ->setRevisionable(TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the contact was last edited.'))
    ->setRevisionable(TRUE);
  return $fields;
}