public static function Heartbeat::baseFieldDefinitions in Heartbeat 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 RevisionableContentEntityBase::baseFieldDefinitions

See also

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

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

File

src/Entity/Heartbeat.php, line 276

Class

Heartbeat

Namespace

Drupal\heartbeat\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Authored by'))
    ->setDescription(t('The user ID of author of the Heartbeat entity.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('view', array(
    'label' => 'hidden',
    'type' => 'author',
    'weight' => 0,
  ))
    ->setDisplayOptions('form', array(
    'type' => 'entity_reference_autocomplete',
    'weight' => 5,
    'settings' => array(
      'match_operator' => 'CONTAINS',
      'size' => '60',
      'autocomplete_type' => 'tags',
      'placeholder' => '',
    ),
  ))
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['nid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Node'))
    ->setDescription(t('The content associated with this Heartbeat'))
    ->setSetting('target_type', 'node')
    ->setSetting('handler', 'default')
    ->setDisplayOptions('view', array(
    'label' => 'hidden',
    'type' => 'content',
    'weight' => 0,
  ))
    ->setDisplayConfigurable('view', TRUE)
    ->setRevisionable(TRUE);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The name of the Heartbeat entity.'))
    ->setRevisionable(TRUE)
    ->setSettings(array(
    'max_length' => 128,
    'text_processing' => 0,
  ))
    ->setDefaultValue('')
    ->setDisplayOptions('view', array(
    'label' => 'above',
    'type' => 'string',
    'weight' => -4,
  ))
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['message'] = BaseFieldDefinition::create('string_long')
    ->setLabel(t('Message'))
    ->setDescription(t('The message of the Heartbeat entity.'))
    ->setRevisionable(TRUE)
    ->setDisplayOptions('view', array(
    'label' => 'above',
    'type' => 'full_html',
    'weight' => -4,
  ))
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['comments'] = BaseFieldDefinition::create('comment')
    ->setLabel(t('Kommentare'))
    ->setDescription(t('Kommentare.'))
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setSettings(array(
    'default_mode' => 1,
    'per_page' => 50,
    'anonymous' => 0,
    'form_location' => 1,
    'preview' => 1,
    'comment_type' => 'heartbeat_comment',
    'locked' => false,
  ))
    ->setDefaultValue(array(
    'status' => 2,
    'cid' => 0,
    'last_comment_timestamp' => 0,
    'last_comment_name' => null,
    'last_comment_uid' => 0,
    'comment_count' => 0,
  ))
    ->setDisplayOptions('form', array(
    'type' => 'comment_default',
    'settings' => array(
      'form_location' => 1,
      'default_mode' => 1,
      'per_page' => 50,
      'anonymous' => 0,
      'preview' => 1,
      'comment_type' => 'heartbeat_comment',
      'locked' => false,
    ),
    'weight' => 1,
  ))
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Publishing status'))
    ->setDescription(t('A boolean indicating whether the Heartbeat is published.'))
    ->setRevisionable(TRUE)
    ->setDefaultValue(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.'));
  $fields['revision_timestamp'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Revision timestamp'))
    ->setDescription(t('The time that the current revision was created.'))
    ->setQueryable(FALSE)
    ->setRevisionable(TRUE);
  $fields['revision_uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Revision user ID'))
    ->setDescription(t('The user ID of the author of the current revision.'))
    ->setSetting('target_type', 'user')
    ->setQueryable(FALSE)
    ->setRevisionable(TRUE);
  $fields['revision_translation_affected'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Revision translation affected'))
    ->setDescription(t('Indicates if the last edit of a translation belongs to current revision.'))
    ->setReadOnly(TRUE)
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE);
  return $fields;
}