class ValidReferenceConstraint in Zircon Profile 8

Entity Reference valid reference constraint.

Verifies that referenced entities are valid.

Plugin annotation

@Constraint(
  id = "ValidReference",
  label = @Translation("Entity Reference valid reference", context = "Validation")
)

Hierarchy

• class \Symfony\Component\Validator\Constraint
  • class \Drupal\Core\Entity\Plugin\Validation\Constraint\ValidReferenceConstraint

File

core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/ValidReferenceConstraint.php, line 22

Contains \Drupal\Core\Entity\Plugin\Validation\Constraint\ValidReferenceConstraint.

Namespace

Drupal\Core\Entity\Plugin\Validation\Constraint

class ValidReferenceConstraint extends Constraint {

  /**
   * The default violation message.
   *
   * @var string
   */
  public $message = 'This entity (%type: %id) cannot be referenced.';

  /**
   * Violation message when the entity does not exist.
   *
   * @var string
   */
  public $nonExistingMessage = 'The referenced entity (%type: %id) does not exist.';

  /**
   * Violation message when a new entity ("autocreate") is invalid.
   *
   * @var string
   */
  public $invalidAutocreateMessage = 'This entity (%type: %label) cannot be referenced.';

  /**
   * Violation message when the target_id is empty.
   *
   * @var string
   */
  public $nullMessage = 'This value should not be null.';

}

Members

Name	Modifiers	Type	Description	Overrides
Constraint::$errorNames	protected static	property	Maps error codes to the names of their constants.	16
Constraint::$payload	public	property	Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName	public	function	Adds the given group if this constraint is in the Default group.	1
Constraint::CLASS_CONSTRAINT		constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP		constant	The name of the group given to all constraints with no explicit group.
Constraint::getDefaultOption	public	function	Returns the name of the default option.	18
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getRequiredOptions	public	function	Returns the name of the required options.	11
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.	11
Constraint::PROPERTY_CONSTRAINT		constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.	11
Constraint::__construct	public	function	Initializes the constraint with options.	11
Constraint::__get	public	function	Returns the value of a lazily initialized option.	1
Constraint::__set	public	function	Sets the value of a lazily initialized option.	1
Constraint::__sleep	public	function	Optimizes the serialized value to minimize storage space.
ValidReferenceConstraint::$invalidAutocreateMessage	public	property	Violation message when a new entity ("autocreate") is invalid.
ValidReferenceConstraint::$message	public	property	The default violation message.
ValidReferenceConstraint::$nonExistingMessage	public	property	Violation message when the entity does not exist.
ValidReferenceConstraint::$nullMessage	public	property	Violation message when the target_id is empty.