function FieldConfigBase::setPropertyConstraints

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::setPropertyConstraints()
  2. 10 core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::setPropertyConstraints()
  3. 11.x core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::setPropertyConstraints()

Sets constraints for a given field item property.

Note: this overwrites any existing property constraints. If you need to add to the existing constraints, use \Drupal\Core\Field\FieldConfigInterface::addPropertyConstraints()

Note that constraints added via this method are not stored in configuration and as such need to be added at runtime using hook_entity_bundle_field_info_alter().

Parameters

string $name: The name of the property to set constraints for.

array $constraints: The constraints to set.

Return value

static The object itself for chaining.

Overrides FieldConfigInterface::setPropertyConstraints

File

core/lib/Drupal/Core/Field/FieldConfigBase.php, line 563

Class

FieldConfigBase
Base class for configurable field definitions.

Namespace

Drupal\Core\Field

Code

public function setPropertyConstraints($name, array $constraints) {
    $this->propertyConstraints[$name] = $constraints;
    // Reset the field item definition so the next time it is instantiated it
    // will receive the new constraints.
    $this->itemDefinition = NULL;
    return $this;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.