public static function Order::baseFieldDefinitions in Commerce Core 8.2

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

modules/order/src/Entity/Order.php, line 739

Class

Order

Defines the order entity class.

Namespace

Drupal\commerce_order\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['order_number'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Order number'))
    ->setDescription(t('The order number displayed to the customer.'))
    ->setRequired(TRUE)
    ->setDefaultValue('')
    ->setSetting('max_length', 255)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['version'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Version'))
    ->setDescription(t('The order version number, it gets incremented on each save.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE)
    ->setDefaultValue(0);
  $fields['store_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Store'))
    ->setDescription(t('The store to which the order belongs.'))
    ->setCardinality(1)
    ->setRequired(TRUE)
    ->setSetting('target_type', 'commerce_store')
    ->setSetting('handler', 'default')
    ->setTranslatable(TRUE)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Customer'))
    ->setDescription(t('The customer.'))
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setDefaultValueCallback('Drupal\\commerce_order\\Entity\\Order::getCurrentUserId')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'author',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['mail'] = BaseFieldDefinition::create('email')
    ->setLabel(t('Contact email'))
    ->setDescription(t('The email address associated with the order.'))
    ->setDefaultValue('')
    ->setSetting('max_length', 255)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'string',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['ip_address'] = BaseFieldDefinition::create('string')
    ->setLabel(t('IP address'))
    ->setDescription(t('The IP address of the order.'))
    ->setDefaultValue('')
    ->setSetting('max_length', 128)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'string',
    'weight' => 0,
  ])
    ->setDisplayOptions('form', [
    'region' => 'hidden',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['billing_profile'] = BaseFieldDefinition::create('entity_reference_revisions')
    ->setLabel(t('Billing information'))
    ->setDescription(t('Billing profile'))
    ->setSetting('target_type', 'profile')
    ->setSetting('handler', 'default')
    ->setSetting('handler_settings', [
    'target_bundles' => [
      'customer' => 'customer',
    ],
  ])
    ->setTranslatable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'commerce_billing_profile',
    'weight' => 0,
    'settings' => [],
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['order_items'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Order items'))
    ->setDescription(t('The order items.'))
    ->setRequired(TRUE)
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setSetting('target_type', 'commerce_order_item')
    ->setSetting('handler', 'default')
    ->setDisplayOptions('form', [
    'type' => 'inline_entity_form_complex',
    'weight' => 0,
    'settings' => [
      'override_labels' => TRUE,
      'label_singular' => t('order item'),
      'label_plural' => t('order items'),
    ],
  ])
    ->setDisplayOptions('view', [
    'type' => 'commerce_order_item_table',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['adjustments'] = BaseFieldDefinition::create('commerce_adjustment')
    ->setLabel(t('Adjustments'))
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setDisplayOptions('form', [
    'type' => 'commerce_adjustment_default',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', FALSE);
  $fields['total_price'] = BaseFieldDefinition::create('commerce_price')
    ->setLabel(t('Total price'))
    ->setDescription(t('The total price of the order.'))
    ->setReadOnly(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'commerce_order_total_summary',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['total_paid'] = BaseFieldDefinition::create('commerce_price')
    ->setLabel(t('Total paid'))
    ->setDescription(t('The total paid price of the order.'))
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['balance'] = BaseFieldDefinition::create('commerce_price')
    ->setLabel(t('Order balance'))
    ->setDescription(t('The order balance.'))
    ->setReadOnly(TRUE)
    ->setComputed(TRUE)
    ->setClass(OrderBalanceFieldItemList::class)
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['state'] = BaseFieldDefinition::create('state')
    ->setLabel(t('State'))
    ->setDescription(t('The order state.'))
    ->setRequired(TRUE)
    ->setSetting('max_length', 255)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'state_transition_form',
    'settings' => [
      'require_confirmation' => TRUE,
      'use_modal' => TRUE,
    ],
    'weight' => 10,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setSetting('workflow_callback', [
    '\\Drupal\\commerce_order\\Entity\\Order',
    'getWorkflowId',
  ]);
  $fields['data'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Data'))
    ->setDescription(t('A serialized array of additional data.'));
  $fields['locked'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Locked'))
    ->setSettings([
    'on_label' => t('Yes'),
    'off_label' => t('No'),
  ])
    ->setDefaultValue(FALSE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time when the order was created.'));
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time when the order was last edited.'))
    ->setDisplayConfigurable('view', TRUE);
  $fields['placed'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Placed'))
    ->setDescription(t('The time when the order was placed.'))
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'timestamp',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('view', TRUE);
  $fields['completed'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Completed'))
    ->setDescription(t('The time when the order was completed.'))
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'timestamp',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('view', TRUE);
  return $fields;
}