public static function Shipment::baseFieldDefinitions in Commerce Shipping 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

src/Entity/Shipment.php, line 548

Class

Shipment

Defines the shipment entity class.

Namespace

Drupal\commerce_shipping\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);

  // The order backreference.
  $fields['order_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Order'))
    ->setDescription(t('The parent order.'))
    ->setSetting('target_type', 'commerce_order')
    ->setRequired(TRUE)
    ->setReadOnly(TRUE);
  $fields['package_type'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Package type'))
    ->setDescription(t('The package type.'))
    ->setRequired(TRUE)
    ->setDefaultValue('')
    ->setSetting('max_length', 255)
    ->setDisplayConfigurable('view', TRUE);
  $fields['shipping_method'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Shipping method'))
    ->setRequired(TRUE)
    ->setDescription(t('The shipping method'))
    ->setSetting('target_type', 'commerce_shipping_method')
    ->setDisplayOptions('form', [
    'type' => 'commerce_shipping_rate',
    'weight' => 0,
  ])
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'commerce_shipping_method',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['shipping_service'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Shipping service'))
    ->setRequired(TRUE)
    ->setDescription(t('The shipping service.'))
    ->setDefaultValue('')
    ->setSetting('max_length', 255);
  $fields['shipping_profile'] = BaseFieldDefinition::create('entity_reference_revisions')
    ->setLabel(t('Shipping information'))
    ->setRequired(TRUE)
    ->setSetting('target_type', 'profile')
    ->setSetting('handler', 'default')
    ->setSetting('handler_settings', [
    'target_bundles' => [
      'customer' => 'customer',
    ],
  ])
    ->setDisplayOptions('form', [
    'type' => 'commerce_shipping_profile',
    'weight' => -10,
    'settings' => [],
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['title'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Title'))
    ->setDescription(t('The shipment title.'))
    ->setRequired(TRUE)
    ->setSettings([
    'default_value' => '',
    'max_length' => 255,
  ])
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -20,
  ])
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['items'] = BaseFieldDefinition::create('commerce_shipment_item')
    ->setLabel(t('Items'))
    ->setRequired(TRUE)
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['weight'] = BaseFieldDefinition::create('physical_measurement')
    ->setLabel(t('Weight'))
    ->setRequired(TRUE)
    ->setSetting('measurement_type', 'weight')
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['original_amount'] = BaseFieldDefinition::create('commerce_price')
    ->setLabel(t('Original amount'))
    ->setDescription(t('The original amount.'))
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['amount'] = BaseFieldDefinition::create('commerce_price')
    ->setLabel(t('Amount'))
    ->setDescription(t('The amount.'))
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['adjustments'] = BaseFieldDefinition::create('commerce_adjustment')
    ->setLabel(t('Adjustments'))
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', FALSE);
  $fields['tracking_code'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Tracking code'))
    ->setDescription(t('The shipment tracking code.'))
    ->setDefaultValue('')
    ->setSetting('max_length', 255)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => 50,
  ]);
  $fields['state'] = BaseFieldDefinition::create('state')
    ->setLabel(t('State'))
    ->setDescription(t('The shipment state.'))
    ->setRequired(TRUE)
    ->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_shipping\\Entity\\Shipment',
    'getWorkflowId',
  ]);
  $fields['data'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Data'))
    ->setDescription(t('A serialized array of additional data.'));
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time when the shipment was created.'))
    ->setRequired(TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time when the shipment was last updated.'))
    ->setRequired(TRUE);
  $fields['shipped'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Shipped'))
    ->setDescription(t('The time when the shipment was shipped.'));
  return $fields;
}