public static function Activity::baseFieldDefinitions in CRM Core 8

Same name and namespace in other branches

1. 8.3 modules/crm_core_activity/src/Entity/Activity.php \Drupal\crm_core_activity\Entity\Activity::baseFieldDefinitions()
2. 8.2 modules/crm_core_activity/src/Entity/Activity.php \Drupal\crm_core_activity\Entity\Activity::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_activity/src/Entity/Activity.php, line 79

Class

Activity

CRM Activity Entity Class.

Namespace

Drupal\crm_core_activity\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['uid'] = EntityOwnerTrait::getOwnerFieldDefinition()
    ->setDescription(t('The user that created the activity.'));
  $fields['type'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Type'))
    ->setDescription(t('The activity type.'))
    ->setSetting('target_type', 'crm_core_activity_type')
    ->setReadOnly(TRUE);
  $fields['title'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Title'))
    ->setDescription(t('The title of this activity.'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE)
    ->setSetting('default_value', '')
    ->setSetting('max_length', 255)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'string',
    'weight' => -5,
  ])
    ->setDisplayOptions('form', [
    'type' => 'text_textfield',
    'weight' => -5,
  ])
    ->setDisplayConfigurable('form', TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time that the activity 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 activity was last edited.'))
    ->setRevisionable(TRUE);
  $fields['activity_participants'] = BaseFieldDefinition::create('dynamic_entity_reference')
    ->setLabel(t('Participants'))
    ->setSetting('exclude_entity_types', FALSE)
    ->setSetting('entity_type_ids', [
    'crm_core_individual',
    'crm_core_organization',
  ])
    ->setCardinality(-1)
    ->setRequired(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'settings' => [
      'link' => TRUE,
    ],
    'type' => 'dynamic_entity_reference_label',
    'weight' => 0,
  ])
    ->setDisplayOptions('form', [
    'type' => 'dynamic_entity_reference_default',
    'settings' => [
      'match_operator' => 'CONTAINS',
    ],
    'weight' => 0,
  ]);

  // @todo Check settings.
  $fields['activity_date'] = BaseFieldDefinition::create('datetime')
    ->setLabel(t('Date'))
    ->setDefaultValue([
    'default_date' => 'now',
  ])
    ->setDisplayOptions('view', [
    'label' => 'above',
    'settings' => [
      'format_type' => 'long',
    ],
    'type' => 'datetime_default',
    'weight' => 1,
  ])
    ->setDisplayOptions('form', [
    'type' => 'datetime_default',
    'weight' => 2,
  ]);

  // @todo Check settings.
  $fields['activity_notes'] = BaseFieldDefinition::create('text_long')
    ->setLabel(t('Notes'))
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'text_default',
    'weight' => 2,
  ])
    ->setDisplayOptions('form', [
    'type' => 'text_textarea',
    'weight' => 3,
    'settings' => [
      'rows' => 5,
    ],
  ]);
  return $fields;
}