WARNING: You are browsing the documentation for Symfony 3.2 which is not maintained anymore. Consider upgrading your projects to Symfony 4.3.

IsTrue

3.2 version

Maintained

3.4 4.2 4.3 current 4.4 master

Unmaintained

2.3 2.7 2.8 3.0 3.1 3.3 4.0 4.1

IsTrue
- Basic Usage
- Options
  - message
  - payload

IsTrue¶

Validates that a value is true. Specifically, this checks to see if the value is exactly true, exactly the integer 1, or exactly the string "1".

Also see IsFalse.

Applies to	property or method
Options	message payload
Class	`True`
Validator	`TrueValidator`

Basic Usage¶

This constraint can be applied to properties (e.g. a termsAccepted property on a registration model) or to a "getter" method. It's most powerful in the latter case, where you can assert that a method returns a true value. For example, suppose you have the following method:

// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;

class Author
{
    protected $token;

    public function isTokenValid()
    {
        return $this->token == $this->generateToken();
    }
}

Then you can constrain this method with IsTrue.

Annotations

// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    protected $token;

    /**
     * @Assert\IsTrue(message = "The token is invalid")
     */
    public function isTokenValid()
    {
        return $this->token == $this->generateToken();
    }
}

YAML

# src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Author:
    getters:
        tokenValid:
            - 'IsTrue':
                message: The token is invalid.

XML

<!-- src/Acme/Blogbundle/Resources/config/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="AppBundle\Entity\Author">
        <getter property="tokenValid">
            <constraint name="IsTrue">
                <option name="message">The token is invalid.</option>
            </constraint>
        </getter>
    </class>
</constraint-mapping>

PHP

// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints\IsTrue;

class Author
{
    protected $token;

    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addGetterConstraint('tokenValid', new IsTrue(array(
            'message' => 'The token is invalid.',
        )));
    }

    public function isTokenValid()
    {
        return $this->token == $this->generateToken();
    }
}

If the isTokenValid() returns false, the validation will fail.

Options¶

message¶

type: string default: This value should be true.

This message is shown if the underlying data is not true.

payload¶

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.