public static function ProductVariation::bundleFieldDefinitions in Commerce Core 8.2

Provides field definitions for a specific bundle.

This function can return definitions both for bundle fields (fields that are not defined in $base_field_definitions, and therefore might not exist on some bundles) as well as bundle-specific overrides of base fields (fields that are defined in $base_field_definitions, and therefore exist for all bundles). However, bundle-specific base field overrides can also be provided by 'base_field_override' configuration entities, and that is the recommended approach except in cases where an entity type needs to provide a bundle-specific base field override that is decoupled from configuration. Note that for most entity types, the bundles themselves are derived from configuration (e.g., 'node' bundles are managed via 'node_type' configuration entities), so decoupling bundle-specific base field overrides from configuration only makes sense for entity types that also decouple their bundles from configuration. In cases where both this function returns a bundle-specific override of a base field and a 'base_field_override' configuration entity exists, the latter takes precedence.

@todo WARNING: This method will be changed in https://www.drupal.org/node/2346347.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type definition. Useful when a single class is used for multiple, possibly dynamic entity types.

string $bundle: The bundle.

\Drupal\Core\Field\FieldDefinitionInterface[] $base_field_definitions: The list of base field definitions.

Return value

\Drupal\Core\Field\FieldDefinitionInterface[] An array of bundle field definitions, keyed by field name.

Overrides ContentEntityBase::bundleFieldDefinitions

File

modules/product/src/Entity/ProductVariation.php, line 549

Class

ProductVariation: Defines the product variation entity class.

Namespace

Drupal\commerce_product\Entity

Code

public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {

  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
  $fields = [];

  /** @var \Drupal\commerce_product\Entity\ProductVariationTypeInterface $variation_type */
  $variation_type = ProductVariationType::load($bundle);

  // $variation_type could be NULL if the method is invoked during uninstall.
  if ($variation_type && $variation_type
    ->shouldGenerateTitle()) {

    // The title is always generated, the field needs to be hidden.
    // The widget is hidden in commerce_product_field_widget_form_alter()
    // since setDisplayOptions() can't affect existing form displays.
    $fields['title'] = clone $base_field_definitions['title'];
    $fields['title']
      ->setRequired(FALSE);
    $fields['title']
      ->setDisplayConfigurable('form', FALSE);
  }
  return $fields;
}

You are here