public static function UcWishlist::baseFieldDefinitions in UC Wish List 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/UcWishlist.php, line 71

Class

UcWishlist: Defines the user entity class.

Namespace

Drupal\uc_wishlist\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['wid'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Wishlist ID'))
    ->setDescription(t('The Wishlist ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The user UUID.'))
    ->setReadOnly(TRUE);
  $fields['title'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Title'))
    ->setRequired(TRUE)
    ->setSetting('max_length', 255)
    ->setDefaultValue('');
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Authored by'))
    ->setDescription(t('The username of the content author.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setDefaultValueCallback('Drupal\\uc_wishlist\\Entity\\UcWishlist::getCurrentUserId')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'author',
    'weight' => 0,
  ])
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'weight' => 5,
    'settings' => [
      'match_operator' => 'CONTAINS',
      'size' => '60',
      'placeholder' => '',
    ],
  ])
    ->setDisplayConfigurable('form', TRUE);
  $fields['expiration'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Expiration'))
    ->setDescription(t('Timestamp for when the wish list expires.'));
  $fields['address'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Address'))
    ->setDescription(t('Address for shipping items on the wish list.'));
  $fields['private'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Private'))
    ->setDescription(t('Whether the wishlist is private or not.'))
    ->setDefaultValue(FALSE);
  $fields['description'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Description'))
    ->setDescription(t('The description of the wish list.'));
  return $fields;
}

You are here