IsTrue ====== Validates that a value is ``true``. Specifically, this checks if the value is exactly ``true``, exactly the integer ``1``, or exactly the string ``"1"``. Also see :doc:`IsFalse `. ========== =================================================================== Applies to :ref:`property or method ` Options - `groups`_ - `message`_ - `payload`_ Class :class:`Symfony\\Component\\Validator\\Constraints\\IsTrue` Validator :class:`Symfony\\Component\\Validator\\Constraints\\IsTrueValidator` ========== =================================================================== Basic Usage ----------- This constraint can be applied to properties (e.g. a ``termsAccepted`` property on a registration model) and methods. 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/Entity/Author.php namespace App\Entity; class Author { protected $token; public function isTokenValid() { return $this->token == $this->generateToken(); } } Then you can validate this method with ``IsTrue`` as follows: .. configuration-block:: .. code-block:: php-annotations // src/Entity/Author.php namespace App\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(); } } .. code-block:: yaml # config/validator/validation.yaml App\Entity\Author: getters: tokenValid: - 'IsTrue': message: The token is invalid. .. code-block:: xml .. code-block:: php // src/Entity/Author.php namespace App\Entity; use Symfony\Component\Validator\Constraints\IsTrue; use Symfony\Component\Validator\Mapping\ClassMetadata; class Author { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addGetterConstraint('tokenValid', new IsTrue([ 'message' => 'The token is invalid.', ])); } public function isTokenValid() { return $this->token == $this->generateToken(); } } If the ``isTokenValid()`` returns false, the validation will fail. Options ------- .. include:: /reference/constraints/_groups-option.rst.inc ``message`` ~~~~~~~~~~~ **type**: ``string`` **default**: ``This value should be true.`` This message is shown if the underlying data is not true. You can use the following parameters in this message: =============== ============================================================== Parameter Description =============== ============================================================== ``{{ value }}`` The current (invalid) value =============== ============================================================== .. include:: /reference/constraints/_payload-option.rst.inc