class IsTrue

Same name in this branch

11.1.x vendor/phpunit/phpunit/src/Framework/Constraint/Boolean/IsTrue.php \PHPUnit\Framework\Constraint\IsTrue

Validates that a value is true.

@author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

class \Symfony\Component\Validator\Constraint
- class \Symfony\Component\Validator\Constraints\IsTrue extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of IsTrue

File

vendor/symfony/validator/Constraints/IsTrue.php, line 21

Namespace

Symfony\Component\Validator\Constraints

View source

class IsTrue extends Constraint {
    public const NOT_TRUE_ERROR = '2beabf1c-54c0-4882-a928-05249b26e23b';
    protected const ERROR_NAMES = [
        self::NOT_TRUE_ERROR => 'NOT_TRUE_ERROR',
    ];
    public string $message = 'This value should be true.';
    
    /**
     * @param array<string,mixed>|null $options
     * @param string[]|null            $groups
     */
    public function __construct(?array $options = null, ?string $message = null, ?array $groups = null, mixed $payload = null) {
        parent::__construct($options ?? [], $groups, $payload);
        $this->message = $message ?? $this->message;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
Constraint::$groups	public	property	The groups that the constraint belongs to.
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.		2
Constraint::CLASS_CONSTRAINT	public	constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP	public	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.		28
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getRequiredOptions	public	function	Returns the name of the required options.		22
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.		8
Constraint::normalizeOptions	protected	function
Constraint::PROPERTY_CONSTRAINT	public	constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.		9
Constraint::__get	public	function	Returns the value of a lazily initialized option.		2
Constraint::__isset	public	function			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.
IsTrue::$message	public	property
IsTrue::ERROR_NAMES	protected	constant	Maps error codes to the names of their constants.	Overrides Constraint::ERROR_NAMES
IsTrue::NOT_TRUE_ERROR	public	constant
IsTrue::__construct	public	function		Overrides Constraint::__construct