Home | Symfony2Doc »リファレンスドキュメント »バリデータリファレンス »True

このページのコンテンツ

前のドキュメント

Null

次のドキュメント

False

ソース



クイックリンク


コメントリスト

Powered by Disqus

ご質問や翻訳不備等お気軽にコメントください。


ご注意

Symfony2日本語翻訳ドキュメントは内容が古くなっております。公式サイトの英語ドキュメントを参照してください。

True

Note

  • 対象バージョン:2.3
  • 翻訳更新日:2013/6/7

値が true であることを検証します。 つまり、値が厳密に true、または整数値の 1、または文字列の “1” であるかどうかをチェックします。

False も参照してください。

適用先 プロパティまたはメソッド
オプション
Class True
Validator TrueValidator

基本的な使い方

この制約はプロパティ(たとえば登録モデルの termsAccepted プロパティ)および “ゲッター” メソッドに適用できます。 ゲッターメソッドの戻り値が true であることを確かめる場合に威力を発揮します。 たとえば、次のようなメソッドがあるとします。

// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;

class Author
{
    protected $token;

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

isTokenValid() メソッドの戻り値が True であることを保証するには、次のように設定します。

  • YAML
    # src/Acme/BlogBundle/Resources/config/validation.yml
    Acme\BlogBundle\Entity\Author:
        getters:
            tokenValid:
                - "True": { message: "The token is invalid." }
    
  • Annotations
    // src/Acme/BlogBundle/Entity/Author.php
    namespace Acme\BlogBundle\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Author
    {
        protected $token;
    
        /**
         * @Assert\True(message = "The token is invalid")
         */
        public function isTokenValid()
        {
            return $this->token == $this->generateToken();
        }
    }
    
  • XML
    <!-- src/Acme/Blogbundle/Resources/config/validation.xml -->
    <class name="Acme\BlogBundle\Entity\Author">
        <getter property="tokenValid">
            <constraint name="True">
                <option name="message">The token is invalid.</option>
            </constraint>
        </getter>
    </class>
    
  • PHP
    // src/Acme/BlogBundle/Entity/Author.php
    namespace Acme\BlogBundle\Entity;
    
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    use Symfony\Component\Validator\Constraints\True;
    
    class Author
    {
        protected $token;
    
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addGetterConstraint('tokenValid', new True(array(
                'message' => 'The token is invalid.',
            )));
        }
    
        public function isTokenValid()
        {
            return $this->token == $this->generateToken();
        }
    }
    

isTokenValid() の戻り値が false だった場合、バリデーションに失敗します。

オプション

message

タイプ: string デフォルト: This value should be true

検証するデータが true ではなかった場合にこのメッセージが表示されます。

blog comments powered by Disqus