public static function Store::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/store/src/Entity/Store.php, line 259

Class

Store

Defines the store entity class.

Namespace

Drupal\commerce_store\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields += static::ownerBaseFieldDefinitions($entity_type);
  $fields['type'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Type'))
    ->setDescription(t('The store type.'))
    ->setSetting('target_type', 'commerce_store_type')
    ->setReadOnly(TRUE);
  $fields['uid']
    ->setLabel(t('Owner'))
    ->setDescription(t('The store owner.'))
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The store name.'))
    ->setRequired(TRUE)
    ->setTranslatable(TRUE)
    ->setSettings([
    'default_value' => '',
    'max_length' => 255,
  ])
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['mail'] = BaseFieldDefinition::create('email')
    ->setLabel(t('Email'))
    ->setDescription(t('Store email notifications are sent from this address.'))
    ->setRequired(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'email_default',
    'weight' => 1,
  ])
    ->setSetting('display_description', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['default_currency'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Default currency'))
    ->setDescription(t('The default currency of the store.'))
    ->setCardinality(1)
    ->setRequired(TRUE)
    ->setSetting('target_type', 'commerce_currency')
    ->setSetting('handler', 'default')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'options_select',
    'weight' => 2,
  ])
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['timezone'] = BaseFieldDefinition::create('list_string')
    ->setLabel(t('Timezone'))
    ->setDescription(t('Used when determining promotion and tax availability.'))
    ->setCardinality(1)
    ->setRequired(TRUE)
    ->setDefaultValueCallback('Drupal\\commerce_store\\Entity\\Store::getSiteTimezone')
    ->setSetting('allowed_values_function', [
    '\\Drupal\\commerce_store\\Entity\\Store',
    'getTimezones',
  ])
    ->setDisplayOptions('form', [
    'type' => 'options_select',
    'weight' => 3,
  ])
    ->setSetting('display_description', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['address'] = BaseFieldDefinition::create('address')
    ->setLabel(t('Address'))
    ->setDescription(t('The store address.'))
    ->setCardinality(1)
    ->setRequired(TRUE)
    ->setSetting('field_overrides', [
    AddressField::GIVEN_NAME => [
      'override' => FieldOverride::HIDDEN,
    ],
    AddressField::ADDITIONAL_NAME => [
      'override' => FieldOverride::HIDDEN,
    ],
    AddressField::FAMILY_NAME => [
      'override' => FieldOverride::HIDDEN,
    ],
    AddressField::ORGANIZATION => [
      'override' => FieldOverride::HIDDEN,
    ],
  ])
    ->setDisplayOptions('form', [
    'type' => 'address_default',
    'weight' => 4,
  ])
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['billing_countries'] = BaseFieldDefinition::create('list_string')
    ->setLabel(t('Supported billing countries'))
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
    ->setSetting('allowed_values_function', [
    '\\Drupal\\commerce_store\\Entity\\Store',
    'getAvailableCountries',
  ])
    ->setDisplayOptions('form', [
    'type' => 'options_select',
    'weight' => 5,
  ])
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['path'] = BaseFieldDefinition::create('path')
    ->setLabel(t('URL alias'))
    ->setDescription(t('The store URL alias.'))
    ->setTranslatable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'path',
    'weight' => 30,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setCustomStorage(TRUE);

  // 'default' is a reserved SQL word, hence the 'is_' prefix.
  $fields['is_default'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Default'))
    ->setDescription(t('Whether this is the default store.'))
    ->setDefaultValue(FALSE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
    'settings' => [
      'display_label' => TRUE,
    ],
    'weight' => 90,
  ])
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  return $fields;
}