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

File

src/Entity/Profile.php, line 64: Contains \Drupal\profile\Entity\Profile.

Class

Profile: Defines the profile entity class.

Namespace

Drupal\profile\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['pid'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Profile ID'))
    ->setDescription(t('The profile ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The profile UUID.'))
    ->setReadOnly(TRUE);
  $fields['vid'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Revision ID'))
    ->setDescription(t('The profile revision ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['type'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Profile type'))
    ->setDescription(t('The profile type.'))
    ->setSetting('target_type', 'profile_type')
    ->setSetting('max_length', EntityTypeInterface::BUNDLE_MAX_LENGTH);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('User ID'))
    ->setDescription(t('The user ID of the user associated with the profile.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setTranslatable(TRUE);
  $fields['langcode'] = BaseFieldDefinition::create('language')
    ->setLabel(t('Language code'))
    ->setDescription(t('The profile language code.'))
    ->setRevisionable(TRUE);
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Active status'))
    ->setDescription(t('A boolean indicating whether the profile is active.'))
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time that the profile was created.'))
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the profile was last edited.'))
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE);
  return $fields;
}

You are here