public static function Profile::baseFieldDefinitions in Profile 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 EditorialContentEntityBase::baseFieldDefinitions

File

src/Entity/Profile.php, line 302

Class

Profile: Defines the profile entity class.

Namespace

Drupal\profile\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields += static::ownerBaseFieldDefinitions($entity_type);
  $fields['uid']
    ->setRevisionable(TRUE)
    ->setLabel(t('Owner'))
    ->setDescription(t('The user that owns this profile.'))
    ->setSetting('handler', 'default');
  $fields['status']
    ->setLabel(t('Active'))
    ->setDescription(t('Whether the profile is active.'))
    ->setTranslatable(FALSE);
  $fields['is_default'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Default'))
    ->setDescription(t('Whether this is the default profile.'))
    ->setDefaultValue(FALSE)
    ->setRevisionable(TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['data'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Data'))
    ->setDescription(t('A serialized array of additional data.'))
    ->setRevisionable(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time when the profile was created.'))
    ->setRevisionable(TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time when the profile was last edited.'))
    ->setRevisionable(TRUE);
  return $fields;
}

You are here