Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ConstraintViolation.php

class ConstraintViolation

Default implementation of {@ConstraintViolationInterface}.

@author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

  • class \Symfony\Component\Validator\ConstraintViolation implements \Symfony\Component\Validator\ConstraintViolationInterface

Expanded class hierarchy of ConstraintViolation

11 files declare their use of ConstraintViolation
CKEditor5.php in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
ConstraintValidatorTestCase.php in vendor/symfony/validator/Test/ConstraintValidatorTestCase.php
ConstraintViolationBuilder.php in vendor/symfony/validator/Violation/ConstraintViolationBuilder.php
ConstraintViolationBuilder.php in core/lib/Drupal/Core/Validation/ConstraintViolationBuilder.php
EntityConstraintViolationList.php in core/lib/Drupal/Core/Entity/EntityConstraintViolationList.php

... See full list

File

vendor/symfony/validator/ConstraintViolation.php, line 19

Namespace

Symfony\Component\Validator
View source
class ConstraintViolation implements ConstraintViolationInterface {
    
    /**
     * Creates a new constraint violation.
     *
     * @param string|\Stringable $message         The violation message as a string or a stringable object
     * @param string|null        $messageTemplate The raw violation message
     * @param array              $parameters      The parameters to substitute in the
     *                                            raw violation message
     * @param mixed              $root            The value originally passed to the
     *                                            validator
     * @param string|null        $propertyPath    The property path from the root
     *                                            value to the invalid value
     * @param mixed              $invalidValue    The invalid value that caused this
     *                                            violation
     * @param int|null           $plural          The number for determining the plural
     *                                            form when translating the message
     * @param string|null        $code            The error code of the violation
     * @param Constraint|null    $constraint      The constraint whose validation
     *                                            caused the violation
     * @param mixed              $cause           The cause of the violation
     */
    public function __construct(string|\Stringable $message, ?string $messageTemplate, array $parameters, mixed $root, ?string $propertyPath, mixed $invalidValue, ?int $plural = null, ?string $code = null, ?Constraint $constraint = null, mixed $cause = null) {
    }
    public function __toString() : string {
        if (\is_object($this->root)) {
            $class = 'Object(' . $this->root::class . ')';
        }
        elseif (\is_array($this->root)) {
            $class = 'Array';
        }
        else {
            $class = (string) $this->root;
        }
        $propertyPath = (string) $this->propertyPath;
        if ('' !== $propertyPath && '[' !== $propertyPath[0] && '' !== $class) {
            $class .= '.';
        }
        if (null !== ($code = $this->code) && '' !== $code) {
            $code = ' (code ' . $code . ')';
        }
        return $class . $propertyPath . ":\n    " . $this->getMessage() . $code;
    }
    public function getMessageTemplate() : string {
        return (string) $this->messageTemplate;
    }
    public function getParameters() : array {
        return $this->parameters;
    }
    public function getPlural() : ?int {
        return $this->plural;
    }
    public function getMessage() : string|\Stringable {
        return $this->message;
    }
    public function getRoot() : mixed {
        return $this->root;
    }
    public function getPropertyPath() : string {
        return (string) $this->propertyPath;
    }
    public function getInvalidValue() : mixed {
        return $this->invalidValue;
    }
    
    /**
     * Returns the constraint whose validation caused the violation.
     */
    public function getConstraint() : ?Constraint {
        return $this->constraint;
    }
    
    /**
     * Returns the cause of the violation.
     */
    public function getCause() : mixed {
        return $this->cause;
    }
    public function getCode() : ?string {
        return $this->code;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ConstraintViolation::getCause public function Returns the cause of the violation. Overrides ConstraintViolationInterface::getCause
ConstraintViolation::getCode public function Returns a machine-digestible error code for the violation. Overrides ConstraintViolationInterface::getCode
ConstraintViolation::getConstraint public function Returns the constraint whose validation caused the violation. Overrides ConstraintViolationInterface::getConstraint
ConstraintViolation::getInvalidValue public function Returns the value that caused the violation. Overrides ConstraintViolationInterface::getInvalidValue
ConstraintViolation::getMessage public function Returns the violation message. Overrides ConstraintViolationInterface::getMessage
ConstraintViolation::getMessageTemplate public function Returns the raw violation message. Overrides ConstraintViolationInterface::getMessageTemplate
ConstraintViolation::getParameters public function Returns the parameters to be inserted into the raw violation message. Overrides ConstraintViolationInterface::getParameters
ConstraintViolation::getPlural public function Returns a number for pluralizing the violation message. Overrides ConstraintViolationInterface::getPlural
ConstraintViolation::getPropertyPath public function Returns the property path from the root element to the violation. Overrides ConstraintViolationInterface::getPropertyPath
ConstraintViolation::getRoot public function Returns the root element of the validation. Overrides ConstraintViolationInterface::getRoot
ConstraintViolation::__construct public function Creates a new constraint violation.
ConstraintViolation::__toString public function Converts the violation into a string for debugging purposes. Overrides ConstraintViolationInterface::__toString

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal