public static function AvatarPreview::baseFieldDefinitions in Avatar Kit 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/AvatarPreview.php, line 123

Class

AvatarPreview: Defines the avatar preview entity.

Namespace

Drupal\avatars\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Preview ID'))
    ->setDescription(t('The preview ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['avatar_generator'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Avatar generator'))
    ->setDescription(t('The avatar generator for the associated avatar.'))
    ->setReadOnly(TRUE)
    ->setRequired(TRUE);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('The user who owns this avatar.'))
    ->setSetting('target_type', 'user')
    ->setCardinality(1)
    ->setReadOnly(TRUE)
    ->setRequired(TRUE);
  $fields['avatar'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Reference to a file entity containing an avatar.'))
    ->setSetting('target_type', 'file')
    ->setCardinality(1)
    ->setReadOnly(TRUE)
    ->setRequired(FALSE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Date of creation'))
    ->setDescription(t('The date the avatar preview was created.'))
    ->setRequired(TRUE);
  $fields['scope'] = BaseFieldDefinition::create('integer')
    ->setSetting('unsigned', FALSE)
    ->setSetting('size', 'tiny')
    ->setLabel(t('Preference scope'))
    ->setDescription(t('Which preference caused this avatar to be generated.'))
    ->setDefaultValue(static::SCOPE_TEMPORARY)
    ->setRequired(TRUE);
  return $fields;
}

You are here