public function BaseFieldOverride::__construct in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php \Drupal\Core\Field\Entity\BaseFieldOverride::__construct()

Constructs a BaseFieldOverride object.

In most cases, base field override entities are created via BaseFieldOverride::createFromBaseFieldDefinition($definition, 'bundle')

Parameters

array $values: An array of base field bundle override properties, keyed by property name. The field to override is specified by referring to an existing field with:

• field_name: The field name.
• entity_type: The entity type.

Additionally, a 'bundle' property is required to indicate the entity bundle to which the bundle field override is attached to. Other array elements will be used to set the corresponding properties on the class; see the class property documentation for details.

string $entity_type: (optional) The type of the entity to create. Defaults to 'base_field_override'.

Throws

\Drupal\Core\Field\FieldException Exception thrown if $values does not contain a field_name, entity_type or bundle value.

Overrides ConfigEntityBase::__construct

File

core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php, line 94

Class

BaseFieldOverride

Defines the base field override entity.

Namespace

Drupal\Core\Field\Entity

Code

public function __construct(array $values, $entity_type = 'base_field_override') {
  if (empty($values['field_name'])) {
    throw new FieldException('Attempt to create a base field bundle override of a field without a field_name');
  }
  if (empty($values['entity_type'])) {
    throw new FieldException("Attempt to create a base field bundle override of field {$values['field_name']} without an entity_type");
  }
  if (empty($values['bundle'])) {
    throw new FieldException("Attempt to create a base field bundle override of field {$values['field_name']} without a bundle");
  }
  parent::__construct($values, $entity_type);
}