Programmer's Reference Guide
| 導入 |
標準のバリデーションクラス群
Zend Framework には、すぐに使える標準のバリデーションクラス群が同梱されています。
Alnum
$value がアルファベットおよび数字のみで構成されているときにのみ TRUE を返します。
このバリデータでは、オプションとして空白文字を認めることもできます。
注意: アルファベットとは各言語で単語を構成する文字を意味します。 ただし、以下の言語では英語のアルファベットをアルファベットとして扱います:中国語、日本語、韓国語。 言語はZend_Localeで指定されます。
Alpha
$value がアルファベットのみで構成されているときにのみ TRUE を返します。
このバリデータでは、オプションとして空白文字を認めることもできます。
Barcode
このバリデータのインスタンスを作成する際には、検証したいバーコードの形式を指定します。
現在サポートしているバーコード形式は "UPC-A" (Universal Product Code) と
"EAN-13" (European Article Number) です。
isValid() メソッドは、
指定した型のバーコードの検証アルゴリズムで入力が検証できた場合に
true を返します。このバリデータに入力を渡す前に、
数字の 0 から 9 まで (0-9) 以外の文字はすべて取り除いておかなければなりません。
Between
$value が最小値と最大値の間にある場合にのみ TRUE を返します。
デフォルトでは、両端の値も含めて比較します
($value が境界値と等しくてもかまいません)
が、strict オプションを変更して、$value が最小値より大きくて最大値より小さい
(最小値と最大値は含まない) とすることもできます。
Ccnum
$value が Luhn アルゴリズム (10 で割ったあまりのチェックサム)
を満たすクレジットカード番号である場合にのみ TRUE を返します。
Date
$value が YYYY-MM-DD 形式の日付である場合にのみ
TRUE を返します。オプションの locale
を設定すると、そのロケールに応じた検証を行います。
オプションの format を設定すると、
そのフォーマットを使用して検証を行います。オプションパラメータの詳細は
Zend_Date::isDate()
を参照ください。
Db_RecordExists および Db_NoRecordExists
Zend_Validate_Db_RecordExists および Zend_Validate_Db_NoRecordExists は、 データベースのテーブル上に 指定した値のレコードが存在するかどうかを調べる手段を提供します。
基本的な使用法
このバリデータの基本的な使用例です。
- // メールアドレスがデータベース内に存在するかどうかを調べます
- $validator = new Zend_Validate_Db_RecordExists(
- 'table' => 'users',
- 'field' => 'emailaddress'
- )
- );
- if ($validator->isValid($emailaddress)) {
- // メールアドレスは有効なようです
- } else {
- // メールアドレスが無効なので、その理由を表示します
- foreach ($validator->getMessages() as $message) {
- echo "$message\n";
- }
- }
上の例は、指定したメールアドレスがデータベースのテーブル内に存在するかどうかを調べます。 指定したカラムの値が $emailaddress に一致するレコードがなければ、 エラーメッセージが表示されます。
- // ユーザ名がデータベースに存在しないことを調べます
- $validator = new Zend_Validate_Db_NoRecordExists(
- 'table' => 'users',
- 'field' => 'username'
- )
- );
- if ($validator->isValid($username)) {
- // ユーザ名は有効なようです
- } else {
- // ユーザ名が無効なので、その理由を表示します
- $messages = $validator->getMessages();
- foreach ($messages as $message) {
- echo "$message\n";
- }
- }
上の例は、指定したユーザ名がデータベースのテーブル上に存在しないことを確認します。 指定したカラムの値が $username に一致するレコードが見つかれば、 エラーメッセージが表示されます。
レコードの除外
Zend_Validate_Db_RecordExists および Zend_Validate_Db_NoRecordExists には、 テーブルの一部を除外してその内容を調べる方法があります。 where 句を文字列で指定するか、あるいはキー "field" および "value" を含む配列を指定します。
除外条件を配列で指定すると、!= 演算子を使用します。
つまり、テーブル内の残りのレコードの内容を確認してからレコードを変更できるのです
(たとえばユーザ情報のフォームなどで使用します)。
- // そのユーザ名のユーザがほかにいないことを調べます
- $user_id = $user->getId();
- $validator = new Zend_Validate_Db_NoRecordExists(
- 'table' => 'users',
- 'field' => 'username',
- 'field' => 'id',
- 'value' => $user_id
- )
- )
- );
- if ($validator->isValid($username)) {
- // ユーザ名は有効なようです
- } else {
- // ユーザ名が無効なので、その理由を表示します
- $messages = $validator->getMessages();
- foreach ($messages as $message) {
- echo "$message\n";
- }
- }
上の例は、id = $user_id
であるレコードを除いてそのテーブル内に $username
を含むレコードが存在しないことを調べます。
除外条件を文字列で指定することもできるので、
!= 以外の演算子を指定することもできます。
これは、複合キーに対するチェックの際に便利です。
- $post_id = $post->getId();
- $clause = $db->quoteInto('post_id = ?', $category_id);
- $validator = new Zend_Validate_Db_RecordExists(
- 'table' => 'posts_categories',
- 'field' => 'post_id',
- 'exclude' => $clause
- )
- );
- if ($validator->isValid($username)) {
- // ユーザ名は有効なようです
- } else {
- // ユーザ名が無効なので、その理由を表示します
- $messages = $validator->getMessages();
- foreach ($messages as $message) {
- echo "$message\n";
- }
- }
上の例は、posts_categories テーブル内に
post_id の値が
$category_id に一致するレコードがあることを調べます。
データベースアダプタ
アダプタを指定することもできます。 複数のデータベースアダプタを使用している場合や デフォルトのアダプタを設定していない場合などにこれを使用します。 以下に例を示します。
- $validator = new Zend_Validate_Db_RecordExists(
- 'table' => 'users',
- 'field' => 'id',
- 'adapter' => $dbAdapter
- )
- );
データベーススキーマ
データベース内のスキーマを
PostgreSQL や DB/2 のアダプタで指定するには、キー
table および schema を持つ配列を次の例のように渡します。
below:
- $validator = new Zend_Validate_Db_RecordExists(
- 'table' => 'users',
- 'schema' => 'my',
- 'field' => 'id'
- )
- );
Digits
$value が数字のみで構成されている場合にのみ TRUE を返します。
メールアドレス
Zend_Validate_EmailAddress は、メールアドレスの検証を行います。 このバリデータは、まずメールアドレスを local-part @ hostname に分割し、メールアドレスやホスト名の仕様にあわせて検証します。
基本的な使用法
基本的な使用法は、以下のようになります。
- $validator = new Zend_Validate_EmailAddress();
- if ($validator->isValid($email)) {
- // メールアドレスは正しい形式のようです
- } else {
- // 不正な形式なので、理由を表示します
- foreach ($validator->getMessages() as $message) {
- echo "$message\n";
- }
- }
これは、メールアドレス $email を検証し、失敗した場合は
その原因を表す便利なエラーメッセージを
$validator->getMessages() で取得します。
メールアドレス検証のオプション
Zend_Validate_EmailAddress supports several options which can eighter be set at initiation, by giving an array with the related options, or afterwards, by using setOptions(). The following options are supported:
-
allow: Defines which type of domain names are accepted. This option is used in conjunction with the hostname option to set the hostname validator. For more informations about possible values of this option look at Hostname and possible ALLOW* constants. This option defaults to ALLOW_DNS.
-
hostname: Sets the hostname validator with which the domain part of the email address will be validated.
-
mx: Defines if the MX records from the server should be detected. If this option is defined to TRUE then the MX records are used to verify if the server accepts emails. This option defaults to FALSE.
-
deep: Defines if the servers MX records should be verified by a deep check. When this option is set to TRUE then additionally to MX records also the A, A6 and AAAA records are used to verify if the server accepts emails. This option defaults to FALSE.
-
domain: Defines if the domain part should be checked. When this option is set to FALSE, then only the local part of the email address will be checked. In this case the hostname validator will not be called. This option defaults to TRUE.
- $validator = new Zend_Validate_EmailAddress();
複雑なローカルパート
Zend_Validate_EmailAddress は、メールアドレスの検証を
RFC2822 にもとづいて行います。たとえば、妥当な形式のメールアドレスとしては
bob@domain.com、bob+jones@domain.us、
"bob@jones"@domain.com および "bob jones"@domain.com
などがあります。
かつて使われていたものの、現在は有効とはみなされないフォーマットもあります (たとえば、メールアドレスに改行文字や "\" を使用するなど)。
ローカルパートのみの検証
If you need Zend_Validate_EmailAddress to check only the local part of an email address, and want to disable validation of the hostname, you can set the domain option to FALSE. This forces Zend_Validate_EmailAddress not to validate the hostname part of the email address.
- $validator = new Zend_Validate_EmailAddress();
さまざまな形式のホスト名の検証
メールアドレスのホスト名部分の検証は、
Zend_Validate_Hostname
で行います。デフォルトでは、domain.com
形式の DNS ホスト名のみが有効となります。しかし、
IP アドレスやローカルホスト名も有効にしたいこともあるでしょう。
その場合は、Zend_Validate_EmailAddress のインスタンスを作成する際にパラメータを渡さなければなりません。 このパラメータで、認めたいホスト名の形式を指定します。 詳細は Zend_Validate_Hostname を参照ください。 たとえば DNS ホスト名およびローカルホスト名のどちらも許可するには、次のようにします。
- $validator = new Zend_Validate_EmailAddress(
- Zend_Validate_Hostname::ALLOW_DNS |
- Zend_Validate_Hostname::ALLOW_LOCAL);
- if ($validator->isValid($email)) {
- // メールアドレスは正しい形式のようです
- } else {
- // 不正な形式なので、理由を表示します
- foreach ($validator->getMessages() as $message) {
- echo "$message\n";
- }
- }
そのホスト名が実際にメールを受け付けるかどうかのチェック
ただ単にメールアドレスが正しい書式であるというだけでは、 そのアドレスが実際に存在するかどうかはわかりません。 この問題を解決するには、MX の検証を行います。 メールアドレスのホスト名に対応する DNS レコードに、MX (メール) のエントリが存在するかどうかを調べるのです。 これは、そのホストがメールを受け付けているかどうかを教えてはくれますが、 そのメールアドレス自体が正しいものであるかどうかを知ることはできません。
MX のチェックはデフォルトでは無効です。 MX のチェックを有効にするには、Zend_Validate_EmailAddress コンストラクタの 2 番目のパラメータを渡します。
- $validator = new Zend_Validate_EmailAddress(
- 'allow' => Zend_Validate_Hostname::ALLOW_DNS,
- 'mx' => true
- )
- );
注意: WindowsでのMX のチェック
Within Windows environments MX checking is only available when PHP 5.3 or above is used. Below PHP 5.3 MX checking will not be used even if it's activated within the options.
あるいは、TRUE または FALSE を
$validator->setValidateMx() に渡すことで、
MX の検証を有効あるいは無効にすることもできます。
この設定を有効にすると、ネットワーク関数を用いて メールアドレスのホスト名部に対する MX レコードの存在チェックをします。 これにより、スクリプトの処理速度が低下することに気をつけてください。
Sometimes validation for MX records returns false, even if emails are accepted. The reason behind this behaviour is, that servers can accept emails even if they do not provide a MX record. In this case they can provide A, A6 or AAAA records. To allow Zend_Validate_EmailAddress to check also for these other records you need to set deep MX validation. This can be done at initiation by setting the deep option or by using setOptions().
- $validator = new Zend_Validate_EmailAddress(
- 'allow' => Zend_Validate_Hostname::ALLOW_DNS,
- 'mx' => true,
- 'deep' => true
- )
- );
パフォーマンスの警告
You should be aware that enabling MX check will slow down you script because of the used network functions. Enabling deep check will slow down your script even more as it searches the given server for 3 additional types.
注意: 許可されないIPアドレス
You should note that MX validation is only accepted for external servers. When deep MX validation is enabled, then local IP addresses like 192.168.* or 169.254.* are not accepted.
国際化ドメイン名の検証
Zend_Validate_EmailAddress は、ドメインの中に国際文字が使われている場合も処理できます。 このようなドメインは、国際化ドメイン名 (International Domain Name: IDN) と呼ばれています。これはデフォルトで有効になっていますが、無効にすることも可能です。 無効にするには、Zend_Validate_EmailAddress が内部で保持している Zend_Validate_Hostname オブジェクトの設定を変更します。
- $validator->getHostnameValidator()->setValidateIdn(false);
setValidateIdn() の詳細な使用法は、 Zend_Validate_Hostname のドキュメントを参照ください。
IDN の検証は、DNS ホスト名の検証を有効にしている場合にのみ行われることに注意しましょう。
トップレベルドメインの検証
デフォルトでは、ホスト名の検証は既知の TLD の一覧に基づいて行われます。 これはデフォルトで有効になっていますが、無効にすることもできます。無効にするには、 無効にするには、Zend_Validate_EmailAddress が内部で保持している Zend_Validate_Hostname オブジェクトの設定を変更します。
- $validator->getHostnameValidator()->setValidateTld(false);
setValidateTld() の詳細な使用法は、 Zend_Validate_Hostname のドキュメントを参照ください。
TLD の検証は、DNS ホスト名の検証を有効にしている場合にのみ行われることに注意しましょう。
メッセージの設定
Zend_Validate_EmailAddress は、 Zend_Validate_Hostname を使用してメールアドレスのホスト名部分をチェックします。 Zend Framework 1.10 以降、 Zend_Validate_Hostname 用のメッセージを Zend_Validate_EmailAddress から設定できるようになります。
- $validator = new Zend_Validate_EmailAddress();
- $validator->setMessages(array(Zend_Validate_Hostname::UNKNOWN_TLD => 'I don't know the TLD you gave'));
Zend Framework 1.10 より前のバージョンでは、まず Zend_Validate_Hostname にメッセージをアタッチしてからそれを Zend_Validate_EmailAddress に設定しないと独自のメッセージを返せませんでした。
Float
$value が浮動小数点値である場合にのみ TRUE を返します。
Zend Framework 1.8 以降では、このバリデータは
ブラウザや環境変数あるいはアプリケーションで設定されたロケールを考慮するようになります。
もちろん、アクセサ get/setLocale を使用して、
バリデータのインスタンスを作成する際に使用するロケールを変更することもできます。
GreaterThan
$value が最小値よりも大きい場合にのみ TRUE を返します。
Hex
$value が16進文字のみで構成されている場合にのみ TRUE を返します。
ホスト名
Zend_Validate_Hostname は、ホスト名が仕様を満たしているかどうかの検証を行います。 三種類の形式のホスト名、つまりDNS ホスト名 (たとえば domain.com)、IP アドレス (たとえば 1.2.3.4) そしてローカルホスト名 (たとえば localhost) の検証が可能です。 デフォルトでは DNS ホスト名のみが有効となります。
基本的な使用法
基本的な使用法は、以下のようになります。
- $validator = new Zend_Validate_Hostname();
- if ($validator->isValid($hostname)) {
- // ホスト名は正しい形式のようです
- } else {
- // 不正な形式なので、理由を表示します
- foreach ($validator->getMessages() as $message) {
- echo "$message\n";
- }
- }
$validator->getMessages() で取得します。
さまざまな形式のホスト名の検証
IP アドレスやローカルホスト名、あるいはその両方を正しいホスト名として認めたいこともあるでしょう。 その場合は、Zend_Validate_Hostname のインスタンスを作成する際にパラメータを渡します。 このパラメータには、どの形式のホスト名を許可するのかを表す整数値を指定しなければなりません。 できるだけ、Zend_Validate_Hostname の定数を使用するようにしましょう。
Zend_Validate_Hostname の定数は次のとおりです。ALLOW_DNS は DNS ホスト名のみを許可し、 ALLOW_IP は IP アドレスを許可します。また ALLOW_LOCAL はローカルネットワーク名を許可し、ALLOW_ALL はこれら三種類をすべて許可します。 IP アドレスだけをチェックするには、以下の例のようにします。
- $validator = new Zend_Validate_Hostname(Zend_Validate_Hostname::ALLOW_IP);
- if ($validator->isValid($hostname)) {
- // ホスト名は正しい形式のようです
- } else {
- // 不正な形式なので、理由を表示します
- foreach ($validator->getMessages() as $message) {
- echo "$message\n";
- }
- }
ALLOW_ALL を使用してすべての形式を許可するほかに、 これらの形式を組み合わせることもできます。 たとえば、DNS およびローカルホスト名を許可するには、 Zend_Validate_Hostname のインスタンスを次のように作成します。
- $validator = new Zend_Validate_Hostname(Zend_Validate_Hostname::ALLOW_DNS | Zend_Validate_Hostname::ALLOW_IP);
国際化ドメイン名の検証
国別コードトップレベルドメイン (Country Code Top Level Domains: ccTLDs) の一部、たとえば 'de' (ドイツ) などでは、ドメイン名の中に国際化文字の使用をサポートしています。 これは、国際化ドメイン名 (International Domain Names: IDN) といわれるものです。 これらのドメインについても、Zend_Validate_Hostname の検証プロセスで使用する文字を拡張することで検証することができます。
これまでに、50以上の ccTLD が IDN ドメインをサポートします。
IDN ドメインに対するマッチングを行う方法は、通常のホスト名の場合とまったく同じです。
というのも、IDN のマッチングはデフォルトで有効になっているからです。
IDN の検証を無効にしたい場合は、Zend_Validate_Hostname
のコンストラクタにパラメータを渡すか、あるいは
$validator->setValidateIdn() メソッドを使用します。
IDN の検証を無効にするには、Zend_Validate_Hostname のコンストラクタに二番目のパラメータを次のように渡します。
- $validator =
- new Zend_Validate_Hostname(
- 'allow' => Zend_Validate_Hostname::ALLOW_DNS,
- 'idn' => false
- )
- );
$validator->setValidateIdn() に渡すことで、
IDN の検証を有効あるいは無効にすることもできます。
現在サポートされていない IDN ホスト名に対するマッチングを行おうとすると、
国際化文字が含まれている場合に検証に失敗します。
追加の文字を指定した ccTLD ファイルが Zend/Validate/Hostname
に存在しない場合は、通常のホスト名の検証を行います。
IDN の検証は、DNS ホスト名の検証を有効にしている場合にのみ行われることに注意しましょう。
トップレベルドメインの検証
デフォルトでは、ホスト名の検証は既知の TLD の一覧に基づいて行われます。 この機能が不要な場合は、IDN サポートを無効にするのと同じ方法で無効にすることができます。 TLD の検証を無効にするには、Zend_Validate_Hostname のコンストラクタに三番目のパラメータを渡します。 以下の例では、IDN の検証は二番目のパラメータで有効にしています。
- $validator =
- new Zend_Validate_Hostname(
- 'allow' => Zend_Validate_Hostname::ALLOW_DNS,
- 'idn' => true,
- 'tld' => false
- )
- );
$validator->ValidateTld() に渡すことで、
TLD の検証を有効あるいは無効にすることもできます。
TLD の検証は、DNS ホスト名の検証を有効にしている場合にのみ行われることに注意しましょう。
Iban
$value が正しい IBAN
(International Bank Account Number) を含む場合にのみ TRUE を返します。
IBAN 番号の検証は、使用している国に対して行い、チェックサムを使用します。
IBAN 番号の検証方法は 2 通りあります。最初の方法では、国を表すロケールを指定します。 その国に対して、指定した IBAN 番号の検証を行います。
- $validator = new Zend_Validate_Iban('de_AT');
- $iban = 'AT611904300234573201';
- if ($validator->isValid($iban)) {
- // IBAN は有効なようです
- } else {
- // IBAN は無効です
- foreach ($validator->getMessages() as $message) {
- echo "$message\n";
- }
- }
これは、IBAN 番号をひとつの国に対して検証したい場合に使用します。 もっとシンプルな方法としては、この例のようにロケールを指定しないものもあります。
- $validator = new Zend_Validate_Iban();
- $iban = 'AT611904300234573201';
- if ($validator->isValid($iban)) {
- // IBAN は有効なようです
- } else {
- // IBAN は無効です
- }
しかしこれには大きな問題がひとつあります。 たとえばフランスならフランスなど 1 か国だけの IBAN 番号を許可したいときに、 他の国の IBAN 番号も有効となってしまいます。 したがって、特定の国の IBAN 番号を検証したい場合はロケールを指定しなければなりません。 国にこだわらずすべての IBAN 番号を許可したい場合は、 ロケールを省略してシンプルに書くことができます。
Identical
指定したトークンが $value と一致する場合にのみ TRUE
を返します。このバリデータは任意の型を処理することができます。
検証したいトークンは初期化時にパラメータとして設定することもできますし、 setToken() メソッドで設定することもできます。
InArray
"needle" $value が "haystack" 配列に含まれる場合にのみ
TRUE を返します。strict オプションを TRUE
にすると、$value の型も確認します。
Int
$value が整数値である場合にのみ TRUE を返します。
Zend Framework 1.8 以降では、このバリデータは
ブラウザや環境変数あるいはアプリケーションで設定されたロケールを考慮するようになります。
もちろん、アクセサ get/setLocale を使用して、
バリデータのインスタンスを作成する際に使用するロケールを変更することもできます。
Ip
$value が妥当な形式の IP アドレスである場合にのみ TRUE を返します。
LessThan
$value が最大値よりも小さい場合にのみ TRUE を返します。
NotEmpty
$value が空の値でない場合にのみ TRUE を返します。
Regex
$value が正規表現パターンにマッチする場合にのみ TRUE を返します。
サイトマップ・バリデータ
以下のバリデータは、 » サイトマップ XML プロトコル に従います。
Sitemap_Changefreq
文字列がサイトマップ XML 文書で 'changefreq' 要素として 使用できるかどうか検証します。 有効値は、 'always', 'hourly', 'daily', 'weekly', 'monthly', 'yearly' または 'never' です。
値が文字列で、上記で指定される頻度のうちの1つと等しい場合に限り、 TRUEを返します。
Sitemap_Lastmod
文字列がサイトマップ XML 文書で 'lastmod' 要素として 使用できるかどうか検証します。 lastmod 要素は W3C 日付文字列を含まなければなりません。 そして、任意で時間についての情報を無効にします。
値が文字列で、プロトコルに従って妥当な場合に限り、 TRUEを返します。
例1 サイトマップ Lastmod バリデータ
- $validator = new Zend_Validate_Sitemap_Lastmod();
- $validator->isValid('1999-11-11T22:23:52-02:00'); // true
- $validator->isValid('2008-05-12T00:42:52+02:00'); // true
- $validator->isValid('1999-11-11'); // true
- $validator->isValid('2008-05-12'); // true
- $validator->isValid('1999-11-11t22:23:52-02:00'); // false
- $validator->isValid('2008-05-12T00:42:60+02:00'); // false
- $validator->isValid('1999-13-11'); // false
- $validator->isValid('2008-05-32'); // false
- $validator->isValid('yesterday'); // false
Sitemap_Loc
文字列がサイトマップ XML 文書で 'loc' 要素として 使用できるかどうか検証します。 これは内部的に Zend_Form::check()を使います。 詳しくはURI の検証を読んでください。
Sitemap_Priority
文字列がサイトマップ XML 文書で 'priority' 要素として 使用できるかどうか検証します。 値は、0.0と1.0の間の小数でなければなりません。 このバリデータは、数値と文字列値の両方を受け入れます。
例2 サイトマップ 優先度 バリデータ
- $validator = new Zend_Validate_Sitemap_Priority();
- $validator->isValid('0.1'); // true
- $validator->isValid('0.789'); // true
- $validator->isValid(0.8); // true
- $validator->isValid(1.0); // true
- $validator->isValid('1.1'); // false
- $validator->isValid('-0.4'); // false
- $validator->isValid(1.00001); // false
- $validator->isValid(0xFF); // false
- $validator->isValid('foo'); // false
StringLength
文字列 $value の長さが最小値以上、
かつ最大値以下 (最大値が NULL 以外のとき)
の場合にのみ TRUE を返します。
setMin()
で最大値より大きい値を指定したり setMax()
で最小値より小さい値を設定したりした場合に例外をスローします。
このクラスは UTF-8 のほかに
» iconv.internal_encoding
にもとづいたその他の文字エンコーディングもサポートします。
別のエンコーディングを使用したい場合は、アクセサメソッド getEncoding
および setEncoding で設定します。
| 導入 |
