public static function Badge::baseFieldDefinitions in User Badges 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/Badge.php, line 116: Contains \Drupal\user_badges\Entity\Badge.

Class

Badge: Defines the Badge entity.

Namespace

Drupal\user_badges\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The name of the Badge entity.'))
    ->setSettings(array(
    'max_length' => 50,
    'text_processing' => 0,
  ))
    ->setDefaultValue('')
    ->setDisplayOptions('view', array(
    'label' => 'above',
    'type' => 'string',
    'weight' => -4,
  ))
    ->setDisplayOptions('form', array(
    'type' => 'string_textfield',
    'weight' => -4,
  ))
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['weight'] = BaseFieldDefinition::create('list_integer')
    ->setLabel(t('Badge Weight'))
    ->setDescription(t('The weight of badge that allows to display badges as per weight order.'))
    ->setSetting('unsigned', TRUE)
    ->setRequired(TRUE)
    ->setSetting('allowed_values', range(-10, 10))
    ->setDisplayOptions('form', array(
    'type' => 'options_select',
    'weight' => -2,
  ))
    ->setDisplayConfigurable('form', TRUE);
  $fields['image'] = BaseFieldDefinition::create('image')
    ->setLabel(t('Image'))
    ->setDescription(t('The badge image'))
    ->setDisplayOptions('view', array(
    'type' => 'image',
    'weight' => 1,
    'label' => 'hidden',
    'settings' => array(
      'image_style' => 'thumbnail',
    ),
  ))
    ->setDisplayOptions('form', array(
    'type' => 'image_image',
    'weight' => 1,
  ))
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['role_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Role ID'))
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setDescription(t('The ID of the Role entity.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user_role')
    ->setSetting('handler', 'default')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('view', array(
    'label' => 'hidden',
    'type' => 'string',
    '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);
  return $fields;
}

You are here