Zend Framework - Zend

■ 概要

送られてくるデータは、期待した形式で入力されてくるとは限りません。
期待した形式と違えば、処理を続行せずにエラー画面を表示する必要があります。

もしそのまま処理を続行してしまえば、場合によってはその後の処理で保存データが読み取れなくなりアプリケーションの挙動がおかしくなる原因にもなります。

その他にも意図的に悪意のあるリクエストデータを送ってアプリケーションの弱点を突いてこられることも考えられます。

なので送られてきたデータはすべて期待する形式で無害なものなのかをきっちりチェックすることが必要です。このチェック作業を検証（Validation: バリデーション）と言います。

■ 標準バリデータを使ってみる

標準で用意されているバリデータがいくつかあるので使ってみます。

テストデータとして、わざと先頭ドットのやくざなメールアドレスを指定して、エラー内容を見てみます。

エラー内容

emailAddressDotAtom: '.foo' can not be matched against dot-atom format
emailAddressQuotedString: '.foo' can not be matched against quoted-string format
emailAddressInvalidLocalPart: '.foo' is no valid local part for email address '.foo@example.com'

こんなにしゃかりきに出さなくても　ってぐらいずらりと表示されました。

これをエラーとしてそのまま表示してもなんだかなので、チェックだけをしてメッセージは自前で簡潔なものにすれば十分だと思います。

そのために、もっと簡潔な記述法として静的メソッドis()を使うことができます。

is()の使い方はこんな感じです。

これだとZend_Validateクラス１つ呼べばいろんなタイプの検証ができるので楽だと思います。

上記以外の標準のバリデーションは以下のとおり

require_once 'Zend/Validate.php';
if (!Zend_Validate::is($value,    'Alnum')) echo '英数字ではありません。';
if (!Zend_Validate::is($value,    'Alpha')) echo '英字ではありません。';
if (!Zend_Validate::is($value,   'Digits')) echo '数字ではありません。';
if (!Zend_Validate::is($value,     'Date')) echo 'YYYY-MM-DD形式日付ではありません。';
if (!Zend_Validate::is($value,    'Float')) echo '浮動小数点値ではありません。';
if (!Zend_Validate::is($value, 'Hostname')) echo 'ホストネームではありません。';
if (!Zend_Validate::is($value,      'Int')) echo '整数値ではありません。';
if (!Zend_Validate::is($value,       'Ip')) echo 'IPアドレスではありません。';
if (!Zend_Validate::is($value, 'NotEmpty')) echo '空ではありません。';
if (!Zend_Validate::is($value,     'GreaterThan', array(10))) echo '10より大きくありません。';
if (!Zend_Validate::is($value,        'LessThan', array(10))) echo '10より小さくありません。';
if (!Zend_Validate::is($value,    'Regex', array('/^foo$/'))) echo 'パターンにマッチしません。';
if (!Zend_Validate::is($value, 'StringLength', array(4, 10))) echo '4～10文字の範囲内ではありません。';

■ バリデータの自作

バリデータを自作するには、Zend_Validate_Abstractを継承したサブクラスを作ります。

[Hoge_Check.php]

"hoge"以外は認めないバリデータです。

自作バリデータも標準バリデータと同様、クラスを呼び出してisValid()で検証する方法と、静的メソッドis()を使って検証する方法が使えます。

is()を使った場合は、エラーメッセージを使えないので直書きするしかないです。

次はいくつかの検証を複合して特化させたバリデータの自作に挑戦してみます。

SJISコード（＋アスキーコード）の文字列長を検証するバリデータです。

[SjisLength.php]

<?php
require_once 'Zend/Validate/Abstract.php';

class SjisLength extends Zend_Validate_Abstract
{
    const MSG_USAGE = 'msgUsage';
    const MSG_SJIS  = 'msgSjis';
    const MSG_MIN   = 'msgMin';
    const MSG_MAX   = 'msgMax';
    public $min = 0;
    public $max = 100;
    protected $_messageVariables = array('min' => 'min', 'max' => 'max');
	protected $_messageTemplates = array(
        self::MSG_USAGE => "min指定値'%min%'およびmax指定値'%max%'が適切ではありません",
        self::MSG_SJIS  => "'%value%' はSJISコードではありません",
        self::MSG_MIN   => "'%value%' は '%min%' 文字以上でなければなりません",
        self::MSG_MAX   => "'%value%' は '%max%' 文字以下でなければなりません");
    public function __construct($options=array(), $max='') {
        if (isset($options['min'])) $this->min = $options['min'];
        if (isset($options['max'])) $this->max = $options['max'];
        if (!is_array($options) && is_int($options)) $this->min = $options;
        if (is_int($max)) $this->max = $max;
    }
    public function isValid($value) {
        $this->_setValue($value);
        if (!is_int($this->min) || !is_int($this->max)) {
            $this->_error(self::MSG_USAGE);
            return false;
        }
        mb_internal_encoding("SJIS-win");
        //$result = mb_detect_encoding($value, "SJIS-win,UTF-8,CP51932,JIS", true);
        if (!preg_match('/^(?:[\x81-\x9f\xe0-\xfc][\x40-\x7e\x80-\xfc]|[\x09\x0a\x0d\x20-\x7e\xa1-\xdf])*$/D', $value)) {
            $this->_error(self::MSG_SJIS);
            return false;
        }
        $len = mb_strlen($value);
        if ($len < $this->min) {
            $this->_error(self::MSG_MIN);
            return false;
        }
        if ($len > $this->max) { 
            $this->_error(self::MSG_MAX);
            return false;
        } return true;
    }
}

// isValid()で検証
$v = new SjisLength(4, 12);
if (!$v->isValid("SJISコード検証")) {
    foreach ($v->getMessages() as $key => $value) {
        echo "$key : $value<br />\n";
    }
}

// is()で検証
require_once 'Zend/Validate.php';
if (!Zend_Validate::is("SJISコード検証", 'SjisLength', array(4, 12))) {
    echo "error";
}

PHP組み込みのmb_detect_encoding()関数がポンコツなのでpreg_match()で検証しています。

標準では用意されてないけど自分がよく使う検証を自作しておけば便利になります。

では、もう一つ作ってみましょう。
日本語（SJISコード）が指定文字数連続で入ってないとエラー判定するバリデータを作ってみます。

[SjisIncLength.php]

<?php
require_once 'Zend/Validate/Abstract.php';

class SjisIncLength extends Zend_Validate_Abstract
{
    const MSG_USAGE = 'msgUsage';
    const MSG_SJIS  = 'msgSjis';
    const MSG_LEN   = 'msgLen';
    public $len = 1;
    protected $_messageVariables = array('len' => 'len');
    protected $_messageTemplates = array(
        self::MSG_USAGE => "len指定値'%len%'が適切ではありません",
        self::MSG_SJIS  => "'%value%' はSJISコードではありません",
        self::MSG_LEN   => "'%value%' は '%len%' 文字長を満たしていません");
    public function __construct($options=array()) {
        if (isset($options['len'])) $this->len = $options['len'];
        if (!is_array($options) && is_int($options)) $this->len = $options;
    }
    public function isValid($value) {
        $this->_setValue($value);
        if (!is_int($this->len)) {
            $this->_error(self::MSG_USAGE);
            return false;
        }
        //mb_internal_encoding("SJIS-win");
        if (!preg_match('/^(?:[\x81-\x9f\xe0-\xfc][\x40-\x7e\x80-\xfc]|[\x09\x0a\x0d\x20-\x7e\xa1-\xdf])*$/D', $value)) {
            $this->_error(self::MSG_SJIS);
            return false;
        }
        if (!preg_match("/(?:[\x81-\x9f\xe0-\xfc][\x40-\x7e\x80-\xfc]|[\xa1-\xdf]){{$this->len}}/", $value)) {
            $this->_error(self::MSG_LEN);
            return false;
        }
        return true;
    }
}

// isValid()で検証
$v = new SjisIncLength(4);
if (!$v->isValid("日本語-４連続-検証")) {
    foreach ($v->getMessages() as $key => $value) {
        echo "$key : $value<br />\n";
    }
}

// is()で検証
require_once 'Zend/Validate.php';
if (!Zend_Validate::is("日本語-４連続-検証", 'SjisIncLength', array(4))) {
	echo "error";
}

だいたいこのような感じで作っていくことができます。

Zend Framework - Zend_Validate編

■ 概要

■ 標準バリデータを使ってみる

■ バリデータの自作