public static function PriceList::baseFieldDefinitions in Commerce Pricelist 8.2

Same name and namespace in other branches

1. 8 src/Entity/PriceList.php \Drupal\commerce_pricelist\Entity\PriceList::baseFieldDefinitions()

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

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()

File

src/Entity/PriceList.php, line 299

Class

PriceList

Defines the Price list entity.

Namespace

Drupal\commerce_pricelist\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields += static::ownerBaseFieldDefinitions($entity_type);
  $fields['uid']
    ->setLabel(t('Owner'))
    ->setDescription(t('The user that owns this price list.'));
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The name of the price list.'))
    ->setRequired(TRUE)
    ->setSettings([
    'max_length' => 50,
    'text_processing' => 0,
  ])
    ->setDefaultValue('')
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => 1,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['stores'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Stores'))
    ->setDescription(t('The stores for which the price list is valid.'))
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setRequired(TRUE)
    ->setSetting('target_type', 'commerce_store')
    ->setSetting('handler', 'default')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'commerce_entity_select',
    'weight' => 2,
  ]);
  $fields['customers'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Customers'))
    ->setDescription(t('The customers for which the price list is valid.'))
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'settings' => [
      'match_operator' => 'CONTAINS',
      'size' => '60',
      'placeholder' => '',
    ],
  ]);
  $fields['customer_roles'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Customer roles'))
    ->setDescription(t('The customer roles for which the price list is valid.'))
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setSetting('target_type', 'user_role')
    ->setDisplayOptions('form', [
    'type' => 'options_buttons',
  ]);
  $fields['start_date'] = BaseFieldDefinition::create('datetime')
    ->setLabel(t('Start date'))
    ->setDescription(t('The date the price list becomes valid.'))
    ->setRequired(TRUE)
    ->setSetting('datetime_type', 'datetime')
    ->setDefaultValueCallback('Drupal\\commerce_pricelist\\Entity\\PriceList::getDefaultStartDate')
    ->setDisplayOptions('form', [
    'type' => 'commerce_store_datetime',
    'weight' => 5,
  ]);
  $fields['end_date'] = BaseFieldDefinition::create('datetime')
    ->setLabel(t('End date'))
    ->setDescription(t('The date after which the price list is invalid.'))
    ->setRequired(FALSE)
    ->setSetting('datetime_type', 'datetime')
    ->setSetting('datetime_optional_label', t('Provide an end date'))
    ->setDisplayOptions('form', [
    'type' => 'commerce_store_datetime',
    'weight' => 6,
  ]);
  $fields['weight'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Weight'))
    ->setDescription(t('The weight of this price list in relation to other price lists.'))
    ->setDefaultValue(0);
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Status'))
    ->setDescription(t('Whether the price list is enabled.'))
    ->setDefaultValue(TRUE)
    ->setRequired(TRUE)
    ->setSettings([
    'on_label' => t('Enabled'),
    'off_label' => t('Disabled'),
  ])
    ->setDisplayOptions('form', [
    'type' => 'options_buttons',
  ]);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time when the price list was last edited.'));
  return $fields;
}