False

Validates that a value is false. Specifically, this checks to see if the value is exactly false, exactly the integer 0, or exactly the string “0”.

Also see True.

Applies to	property or method
Options	message
Class	False
Validator	FalseValidator

Basic Usage

The False constraint can be applied to a property or a “getter” method, but is most commonly useful in the latter case. For example, suppose that you want to guarantee that some state property is not in a dynamic invalidStates array. First, you’d create a “getter” method:

protected $state;

protected $invalidStates = array();

public function isStateInvalid()
{
    return in_array($this->state, $this->invalidStates);
}

In this case, the underlying object is only valid if the isStateInvalid method returns false:

• YAML

  # src/Acme/BlogBundle/Resources/config/validation.yml
  Acme\BlogBundle\Entity\Author
      getters:
          stateInvalid:
              - 'False':
                  message: You've entered an invalid state.
  

• Annotations

  // src/Acme/BlogBundle/Entity/Author.php
  namespace Acme\BlogBundle\Entity;
  
  use Symfony\Component\Validator\Constraints as Assert;
  
  class Author
  {
      /**
       * @Assert\False(
       *     message = "You've entered an invalid state."
       * )
       */
       public function isStateInvalid()
       {
          // ...
       }
  }
  

• 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="Acme\BlogBundle\Entity\Author">
          <getter property="stateInvalid">
              <constraint name="False">
                  <option name="message">You've entered an invalid state.</option>
              </constraint>
          </getter>
      </class>
  </constraint-mapping>
  

• PHP

  // src/Acme/BlogBundle/Entity/Author.php
  namespace Acme\BlogBundle\Entity;
  
  use Symfony\Component\Validator\Mapping\ClassMetadata;
  use Symfony\Component\Validator\Constraints as Assert;
  
  class Author
  {
      public static function loadValidatorMetadata(ClassMetadata $metadata)
      {
          $metadata->addGetterConstraint('stateInvalid', new Assert\False());
      }
  }
  

警告

When using YAML, be sure to surround False with quotes ('False') or else YAML will convert this into a false Boolean value.

Options

message

type: string default: This value should be false.

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