@blog.justoneplanet.info » ZendFramework

Zend_Validateをつかってみる

admin — Fri, 06 Aug 2010 17:10:43 +0000

■使用方法

以下のようにしてバリデートする。

$validator = Zend_Validate_EmailAddress();
if($validator->isValid($str)){
    //success
}
else{//falure
    $this->view->error = $validator->getMessages();//array
}

エラーメッセージの変更

以下のようにするとエラーメッセージを変更することができる。

$validator = new Zend_Validate_StringLength(8);
$validator->setMessage(
    'コラァ=3',
    Zend_Validate_StringLength::TOO_SHORT
);
if($validator->isValid($str)){
    //success
}
else{
    $this->view->error = $validator->getMessages();//array
}

以下のように数パターンエラーメッセージを指定することも考えられる。

$validator = new Zend_Validate_StringLength(array(
    'min' => 2,
    'max' => 10
));
$validator->setMessage(
    Zend_Validate_StringLength::TOO_SHORT => 'コラァ=3',
    Zend_Validate_StringLength::TOO_LONG => 'ゴルァ=3'
);
if($validator->isValid($str)){
    //success
}
else{
    $this->view->error = $validator->getMessages();//array
}

■静的に扱う

以下のようにZend_Validateクラスの静的メソッドを用いてバリデートすることもできる。

if(Zend_Validate::is($str, 'EmailAddress')){
    //success
}

if(Zend_Validate::is($str, 'StringLength', array('min' => 10, 'max' => 20))){
    //success
}

■多言語対応

デフォルトのメッセージはベタ＆英語なのでパンチの利いたセリフが必要だ。

$validator = new Zend_Validate_EmailAddress();
$validator->setTranslator(new Zend_Translate(
    'array',
    array(
        Zend_Validate_Hostname::UNKNOWN_TLD => 'そんなトップレベルドメインしらねーぜぃ'
    ),
    'en'
));
if($validator->isValid()){
    //success
}
else{
    //failure
}

以下のようにして一度に適用できる。

Zend_Validate::setDefaultTranslator(new Zend_Translate(
    'array',
    array(
        Zend_Validate_Hostname::UNKNOWN_TLD => 'そんなトップレベルドメインしらねーぜぃ'
    ),
    'en'
));

バリデートのクラスはすごくいっぱい。

http://framework.zend.com/manual/ja/zend.validate.set.html

■バリデータチェーン

以下のようにして1つのインスタンスに複数のルールを付加できる。

$validator = new Zend_Validate();
$validator->addValidator(new Zend_Validate_Alnum());
$validator->addValidator(new Zend_Validate_StringLength(array(
    'min' => 10,
    'max' => 20
)));

■自作バリデータ

めんどくさいけど作ってみる。以下のようにZend_Validate_Abstractを継承して自作バリデータを作ることができる。

class MyValidate_Array extends Zend_Validate_Abstract
{
    const ARRAY = 'array';
    protected $_messageTemplates = array(
        self::ARRAY = "'%value'は配列を入れてね！"
    );
    public function isValid($value)
    {
        if(!is_array($value)){
            $this->_error(self::ARRAY);
            return false;
        }
        else{
            return true;
        }
    }
}

Zend_Layoutを触ってみる

admin — Sat, 24 Jul 2010 19:55:54 +0000

■フロントコントローラ

大枠（レイアウト部分）が置いてあるディレクトリのパスはここで指定してもよいと思う。

/public_html/index.php

Zend_Layout::startMvc(array(
    'layout'     => 'layout',// layout.phtml
    'layoutPath' => '../application/modules/admin/views/layouts/'// path
));
$front = Zend_Controller_Front::getInstance();

■コントローラ

まぁ大体一つのコントローラ内でレイアウトが変わるなんて事はないから、initで設定してイイよね。

    /**
     * init
     * @return void
     */
    public function init()
    {
        $this->_helper->layout->setLayout('layout');// layout.phtml
        //$this->_helper->layout->setLayoutPath('../application');// path
        $this->_helper->layout->assign('menu', $this->view->render('menu.phtml'));
    }

こんな感じにしておけば、以下の様な感じでイケる！

■ビュー

/application/modules/admin/views/scripts/index/index.phtmlの部分は$this->layout()->contentに出力される。

/application/modules/admin/views/layouts/layout.phtml


layout()->menu ?>


layout()->content ?>

■その他の設定

    /**
     * init
     * @return void
     */
    public function init()
    {
        $this->_helper->layout->setLayout('layout');// layout.phtml
        $this->_helper->layout->assign('menu', $this->view->render('menu.phtml'));
        $this->_helper->layout->disableLayout();// レイアウトを無効化できる
        $this->_helper->layout->setContentKey('main');// デフォルト名$this->layout()->contentを$this->layout()->mainに変更できる
    }

Zend_Formをもっと触ってみる

admin — Fri, 23 Jul 2010 18:22:47 +0000

特定の要素をグルーピングしたい時だってある。

view->form = $this->_createForm();
    }
    public function registerAction()
    {
        $form = $this->createForm();
        if(!form->isValid($this->_getAllParams())){// error
            $this->view->assign('form', $form);
            return $this->render('index');
        }
        else{// success
            $this->_dbh->register($form->getValues());
        }
    }
    private function _createForm()
    {
        $form = new Zend_Form();
        $form->setAction('/admin/index/register/')->setMethod('post');
        $form->addElement(
            'text',
            'name',
            array(
                'validators' => array(
                    array('Regex', false, array('/^[a-z]/i'))
                ),
                'label'      => 'Name : ',
                'required'   => true
            )
        );
        $form->addElement(
            'password',
            'pass',
            array(
                'validators' => array(
                    'Alnum'
                ),
                'label'      => 'Password : ',
                'required'   => true
            )
        );
        $form->addDisplayGroup(
            array(
                'name',
                'pass'
            ),
            'login',
            array(
                'disableLoadDefaultDecorators' => false
            )
        );
        $form->addElement('hash', 'checkHash');
        $form->addElement('submit', '送信');
        return $form;
    }
}
?>

上述のようにしてグループ毎にfieldsetで括ることができる。addDisplayGroupは要素を定義した直後にコールしないとフォームの要素の順序が変わってしまうので注意が必要である。

出力html



 


Name :

Password :

なかなか構造化された綺麗なHTMLが出力される！

Zend_Form::addElement(string $type, string $name, array $options);: 第一引数でtype属性を指定、第二引数でname属性、第三引数でバリデータやフィルタのオプション設定をする
Zend_Form::addDisplayGroup(array $elementNames, string $fieldsetName, array options);: 第一引数で要素のname属性を配列で指定、第二引数でfieldsetの任意の名前、第三引数でオプション設定をする

■フォームのデコレータ

勝手にタグがついて全体をfieldsetで括ってくれて便利なんだが余計なお世話になるときだってある。そこでデフォルトでフォームに付加されるHTMLタグを変更する。

view->form = $this->_createForm();
    }
    public function registerAction()
    {
        $form = $this->createForm();
        if(!form->isValid($this->_getAllParams())){// error
            $this->view->assign('form', $form);
            return $this->render('index');
        }
        else{// success
            $this->_dbh->register($form->getValues());
        }
    }
    private function _createForm()
    {
        $form = new Zend_Form();
        $form->setAction('/admin/index/register/')->setMethod('post');
        $form->addElement(
            'text',
            'name',
            array(
                'validators' => array(
                    array('Regex', false, array('/^[a-z]/i'))
                ),
                'label'      => 'Name : ',
                'required'   => true
            )
        );
        $form->addElement(
            'password',
            'pass',
            array(
                'validators' => array(
                    'Alnum'
                ),
                'label'      => 'Password : ',
                'required'   => true
            )
        );
        $form->addElement('hash', 'checkHash');
        $form->addElement('submit', '送信');
        $form->clearDecorators();
        $form->addDecorator('FormElements')->addDecorator('HtmlTag', array('tag' => 'ul', 'class' => 'form'))->addDecorator('Form');
        $form->setElementDecorators(array('ViewHelper', 'Label', array('HtmlTag', array('tag' => 'li'))));
        return $form;
    }
}
?>

出力コード



Name :
Password :

送信

Zend_Form::addDecorator(string $className, , array $options = null);
Zend_Form::addDecorators(array $decorators);

いろんなデコレータ

    private function _createForm()
    {
        $form = new Zend_Form();
        $form->setAction('/admin/index/register/')->setMethod('post');
        $form->addElement(
            'text',
            'name',
            array(
                'validators' => array(
                    array('Regex', false, array('/^[a-z]/i'))
                ),
                'label'      => 'Name : ',
                'required'   => true
            )
        );
        $form->addElement(
            'password',
            'pass',
            array(
                'validators' => array(
                    'Alnum'
                ),
                'label'      => 'Password : ',
                'required'   => true
            )
        );

        $name = $form->getElement('name');
        $name->setDescription('名前をいれる感じで');
        $name->addDecorator(//
            'description',
            array(
                'class'  => 'descrition',
                'escape' => false
            )
        );

        $form->addElement('hash', 'checkHash');
        $form->addElement('submit', '送信');
        $form->clearDecorators();
        $form->addDecorator('FormElements')->addDecorator('HtmlTag', array('tag' => 'ul', 'class' => 'form'))->addDecorator('Form');
        $form->setElementDecorators(array('ViewHelper', 'Label', array('HtmlTag', array('tag' => 'li'))));
        return $form;
    }

出力HTML



Name :

名前をいれる感じで
Password :


送信

■自作デコレータ

以下のようにZend_Form_Decorator_Abstractを継承してあげればオリジナルデコレータができる！

../application/decorators/Original.php

{$content}";
    }
}
?>

以下のようにして使用する。

    private function _createForm()
    {
        $form = new Zend_Form();
        $form->setAction('/admin/index/register/')->setMethod('post');
        $form->addPrefixPath('Jop_Decorator', '../application/decorators', 'decorator');
        //追加したフォーム要素に登録
        //$form->addElementPrefixPath('Jop_Decorator', 'path', 'decorator');
        $form->addElement(
            'text',
            'name',
            array(
                'validators' => array(
                    array('Regex', false, array('/^[a-z]/i'))
                ),
                'label'      => 'Name : ',
                'required'   => true
            )
        );
        $form->addElement(
            'password',
            'pass',
            array(
                'validators' => array(
                    'Alnum'
                ),
                'label'      => 'Password : ',
                'required'   => true
            )
        );

        $name = $form->getElement('name');
        //個別のフォーム要素に加える
        $name->addPrefixPath('Jop_Decorator', '../applications/decorators', 'decorator');
        $name->addDecorator('Original');

        $form->addElement('hash', 'checkHash');
        $form->addElement('submit', '送信');
        return $form;
    }

以下のようにspanで括られて出力される。



Name :

Password :

■エラーメッセージの日本語化

以下のようにすると対応するエラーメッセージを日本語化できる。

    private function _createForm()
    {
        $form = new Zend_Form();
        $form->setAction('/admin/index/register/')->setMethod('post');
        $form->addElement(
            'text',
            'name',
            array(
                'validators' => array(
                    array('Regex', false, array('/^[a-z]/i'))
                ),
                'label'      => 'Name : ',
                'required'   => true
            )
        );
        $form->addElement(
            'password',
            'pass',
            array(
                'validators' => array(
                    'Alnum'
                ),
                'label'      => 'Password : ',
                'required'   => true
            )
        );
        $form->addElement('hash', 'checkHash');
        $form->addElement('submit', '送信');
        $adapter = new Zend_Translate(
            'array',
            array(
                "'%value%' has not only alphabetic and digit characters" => "'%value%' に英数字以外の文字が含まれています",
                "'%value%' does not match against pattern '%pattern%'"   => "'%value%' は '%pattern%' にマッチしません。"
            )
        );
        $form->setTranslator($adapter);
        return $form;
    }

全てのフォームに適用する場合は以下のようにする。

Zend_Form::setDefaultTranslator($adapter);

Zend_Formを触ってみる

admin — Wed, 21 Jul 2010 14:44:15 +0000

■結論

コントローラ

createForm();
        $this->view->form = $form;
    }
    public function registerAction()
    {
        $form = $this->createForm();
        if(!$form->isValid($this->_getAllParams())){// error
            $this->view->assign('form', $form);
            return $this->render('index');
        }
        else{// success
            $this->_dbh->register($form->getValues());
        }
    }
    private function createForm()
    {
        $form = new Zend_Form();
        $form->addElement(
            'text',
            'name',
            array(
                'validators' => array(
                    array('Regex', false, array('/^[a-z]/i'))
                ),
                'label'      => 'Name : ',
                'required'   => true
                'filters'    => array(
                    'StringToLower',
                    'StripTags'
                )
            )
        );
        $form->addElement('hash', 'checkHash');
        $form->addElement('submit', '送信');
        return $form;
    }
}
?>

index.phtml

form; ?>

最初にZend_Formのインスタンスを作成する。

他のモジュールとの連携

バリデート（Zend_Validate）
フィルタリング（Zend_Filter）

■Zend_Form

コントローラ

$form = new Zend_Form();
$form->setAction('/admin/index/register/')->setMethod('post');
$this->view->form = $form;

ビュー

form; ?>

出力

■ 要素を作る

簡単。（コントローラ）

$name = $form->createElement('text', 'name');

addElement がもっと簡単（コントローラ）

$form->addElement('text', 'name');

バリデートもフィルタリングも一緒に追加できちゃう。（コントローラ）

$form->addElement(
    'text',
    'name',
    array(
        'validators' => array(
            array('Regex', false, array('/^[a-z]/i'))
        ),
        'label'      => 'Name : ',
        'required'   => true,
        'filters'    => array(
            'StringToLower',
            'StripTags'
        )
    )
);

こんなんもある。めんどー。（コントローラ）

require_once 'Zend/Form/Element/Text.php';
$name = new Zend_Form_Element_Text('name');

■ バリデータを作る

addValidator(mixed $nameOrValidator, bool $breakChainOnFailure, array $options)

$name = new Zend_Form_Element_Text('name');
$name->addValidator('Alnum', false, array(true))
    ->addValidator('Regex', false, array('/^[a-zA-Z\s]+/'))
    ->setLabel('Name : ')
    ->setRequired(true);

Zend_Form_Element::addValidator(string $class, bool $is_next, array $options);: 第一引数で指定したバリデータを要素に付加する。

バリデータ一覧

http://framework.zend.com/manual/ja/zend.validate.set.html

■フィルターを作る

addFilter(mixed $nameOrFilter, array $options)

$name = new Zend_Form_Element_Text('name');
$name->addFilter('StringToLower');

フィルタ一覧

http://zendframework.com/manual/1.5/ja/zend.filter.set.html

Zend_Viewをもっと触ってみる

admin — Tue, 20 Jul 2010 16:31:55 +0000

■パーシャルビュー

scripts配下から指定する。

partial('index/edit.phtml'); ?>

他のビュースクリプトを呼び出すための仕組みだ。

partial(
    'index/edit.phtml',
    array(
        'val' => $this->val
    )
);
?>

上述のように、変数は明示的して引数で渡す必要がある。

■プレイスホルダ

コントローラ

$this->view->HeadScript()->appendFile('/admin/js/init.js');

ビュー

HeadScript(); ?>

出力

■Zend_Translate

その名の通り多言語サイトをつくるときに使うやつ。

Zend_Registry::set(
    'Zend_Translate',
    new Zend_Translate(
        'array',
        array(
            'submit' => '送信'
        ),
        'ja'
    )
);

ビュー

formSubmit('', $this->translate('submit')); ?>

出力

なんかファイルフォーマットのアダプタがいっぱいある。

■自作ビューヘルパー

クラスを定義

application/modules/admin/views/helpers/Br.php

view = $view;
    }
    public function br()
    {
        return "
\n";
    }
}
?>

コントローラ

$this->view->addHelperPath('application/modules/admin/views/helpers', 'Zend_View_Helper_');

ビュー

br(); ?>

どっちかというと命名規則が重要である。

自作クラス名: Zend_View_Helper_ + Br
自作クラス名(メソッド): br
ビュー: echo $this->br();

Zend_Viewを触ってみる

admin — Mon, 19 Jul 2010 09:13:02 +0000

$this->_viewで色々設定できるらしー。

■パスの指定

class IndexController extends Zend_Controller_Action
{
    public function init()
    {
        $this->_session    = new Zend_Session_Namespace('global');
        $this->view->module     = $this->_getParam('module');
        $this->view->controller = $this->_getParam('controller');
        $this->view->action     = $this->_getParam('action');
    }

    public function indexAction()
    {
        // view 関連のディレクトリのパス（helpers,filters,scriptsが含まれる）
        $this->view->setBasePath('../views');
        // filters関連のディレクトリのパス
        $this->view->setFilterPath('../views/filters');
        // helpers関連のディレクトリのパス
        $this->view->setHelperPath('../views/helpers');
        // scripts関連のディレクトリのパス
        $this->view->setScriptPath('../views/scripts');
        // view 関連のディレクトリのパス（helpers,filters,scriptsが含まれる）
        $this->view->addBasePath('../views');
        // filters関連のディレクトリのパス
        $this->view->addFilterPath('../views/filters');
        // helpers関連のディレクトリのパス
        $this->view->addHelperPath('../views/helpers');
        // scripts関連のディレクトリのパス
        $this->view->addScriptPath('../views/scripts');
        $this->view->title = 'ページのタイトル';
    }
}

■エンコードとエスケープ

ガラパゴス携帯だからsjisとか。

class IndexController extends Zend_Controller_Action
{
    public function init()
    {
        $this->_session    = new Zend_Session_Namespace('global');
        $this->view->module     = $this->_getParam('module');
        $this->view->controller = $this->_getParam('controller');
        $this->view->action     = $this->_getParam('action');
    }

    public function indexAction()
    {
        $this->view->encoding('Shift_JIS');// 文字コードを指定
        $this->view->escape('htmlentities');// escapeで使う関数を指定
        $this->view->title = 'ページのタイトル';
    }
}

■フィルタ

class IndexController extends Zend_Controller_Action
{
    public function init()
    {
        $this->_session    = new Zend_Session_Namespace('global');
        $this->view->module     = $this->_getParam('module');
        $this->view->controller = $this->_getParam('controller');
        $this->view->action     = $this->_getParam('action');
    }

    public function indexAction()
    {
        $this->view->setFilter('hogeFilter');
        $this->view->title = 'ページのタイトル';
    }
}

views/filters配下に設置。

class Zend_Filter_HogeFilter extends Zend_Filter
{
    public function filter($value)
    {
        $value = preg_replace('//', '
', $value);
        return $value;
    }
}

■ヘルパー

よく使われる要素のビューヘルパはZend Frameworkで標準的に準備されてるらしー。

フォーム

第三引数でフォームの内容を指定できる。falseを指定すると開始タグしか出力されない。

form( 'form', array( 'action' => '/index/register', 'method' => 'post' ), $this->formText('dateTime', '', array('size' => '30')) . $this->formSubmit('', $this->translate('submit')) ); ?>

URL

有用性が良く分からん。

url(array( 'controller' => 'Index', 'action' => 'index' )); ?>

Zend Frameworkでテーブルを左結合する

admin — Sat, 05 Jun 2010 18:51:43 +0000

$select->joinLeft( 'child', "parent.`id` = child.`id_parent`", array( 'id', 'column' ) );

以上。

Zend_Controller_Router_Route_Regexで正規表現によるルーティング設定を行う

admin — Sun, 21 Feb 2010 16:35:35 +0000

以下のように、Zend_Controller_Router_Route_Regexを使用する。

$front->getRouter()->addRoute( 'page', new Zend_Controller_Router_Route_Regex( 'page_(\d+)\.html', array( 'controller' => 'Index', 'action' => 'page' ), array( 1 => 'pageid' ) ) );

Actionからは以下のコードでマッチした部分を参照できる。

$this->_getParam('pageid');

但し、URLヘルパーやこのクラスのメソッドを使用する場合は第4引数が必要となる。

$front->getRouter()->addRoute( 'page', new Zend_Controller_Router_Route_Regex( 'page_(\d+)\.html', array( 'controller' => 'Index', 'action' => 'page' ), array( 1 => 'pageid' ), 'page_%d.html' ) );

参考

http://framework.zend.com/manual/ja/zend.controller.router.html

http://codezine.jp/article/detail/2226?p=2

ZendFrameworkでコマンドラインからアクションを実行する

admin — Sun, 14 Feb 2010 14:56:47 +0000

コマンドラインにおけるオプションの設定・取得。|の後がエイリアス名、=の後の文字列で型を指定できる。

try { $options = new Zend_Console_Getopt( array( 'help|h' => 'help.', 'zfm|m=s' => 'module', 'zfc|c=s' => 'controller', 'zfa|a=s' => 'action' ) ); $options->parse(); } catch(Zend_Console_Getopt_Exception $e){ die($e->getMessage() . ' : ' . $e->getUsageMessage()); }

Zend_Controller_Request_Simpleがポイント。アクション、コントローラ、モジュールを引数に指定してリクエストオブジェクトを取得する。

if(isset($options->zfa) && isset($options->zfc) && isset($options->zfm)){ $request = new Zend_Controller_Request_Simple( $options->zfa, $options->zfc, $options->zfm ); $front = Zend_Controller_Front::getInstance(); $front->setRequest($request); $front->setRouter(new Custom_Controller_Router_Cli()); $front->setResponse(new Zend_Controller_Response_Cli()); $front->throwExceptions(true); $front->addModuleDirectory(dirname(__FILE__) . '/application/modules'); $front->dispatch(); }

Custom_Controller_Router_Cliはこんな感じ。

基本的には以上で実行できるが

■アクセスコントロールの設定

アクセスコントロールを行っている場合は上述のコードよりも先にアクセスできるようにしなければならない。以下は一例。

$sesion = new Zend_Session_Namespace('global'); $sesion->userLevel = 'admin'; $acl = new Zend_Acl(); $acl->addRole(new Zend_Acl_Role('guest')); $acl->addRole(new Zend_Acl_Role('admin'), 'guest'); $acl->add(new Zend_Acl_Resource('guestPage')); $acl->add(new Zend_Acl_Resource('adminPage')); $acl->allow('guest'); $acl->allow('admin'); $acl->deny('guest', 'adminPage'); $acl->allow('admin', 'adminPage'); Zend_Registry::set('acl', $acl);

基本的には一般ユーザが閲覧（実行）できる場所に、このファイルを配置するのは良くない。

ZendFrameworkビュースクリプトでのbodyタグ

admin — Mon, 11 Jan 2010 17:19:59 +0000

以下のように記述するとcssで装飾しやすい気がする。

■コントローラ

public function init(){ $this->_view->module = $this->_getParam('module'); $this->_view->controller = $this->_getParam('controller'); $this->_view->action = $this->_getParam('action'); }

■ビュー

ちなみに以下のようになっている。

print($this->module);//モジュール名 print($this->controller);//コントローラ名 print($this->action);//アクション名

出力例

参考

以下の例の場合を考えてみる。

出力例

一見素晴らしいが、IEが以下のセレクタに対応していないため使用できない。

body.admin.category.register { background-color: red; } body.register { background-color: blue; }

上述のように記述するとIE6のみbodyの背景色がblueになるはずだ。

Zend_Exceptionのメソッド

admin — Sat, 09 Jan 2010 18:48:48 +0000

以下の通り。

array(10) { [0] => &object(ReflectionMethod)#54 (2) { ["name"] => string(7) "__clone" ["class"] => string(9) "Exception" } [1] => &object(ReflectionMethod)#55 (2) { ["name"] => string(11) "__construct" ["class"] => string(9) "Exception" } [2] => &object(ReflectionMethod)#56 (2) { ["name"] => string(10) "getMessage" ["class"] => string(9) "Exception" } [3] => &object(ReflectionMethod)#57 (2) { ["name"] => string(7) "getCode" ["class"] => string(9) "Exception" } [4] => &object(ReflectionMethod)#58 (2) { ["name"] => string(7) "getFile" ["class"] => string(9) "Exception" } [5] => &object(ReflectionMethod)#59 (2) { ["name"] => string(7) "getLine" ["class"] => string(9) "Exception" } [6] => &object(ReflectionMethod)#60 (2) { ["name"] => string(8) "getTrace" ["class"] => string(9) "Exception" } [7] => &object(ReflectionMethod)#61 (2) { ["name"] => string(11) "getPrevious" ["class"] => string(9) "Exception" } [8] => &object(ReflectionMethod)#62 (2) { ["name"] => string(16) "getTraceAsString" ["class"] => string(9) "Exception" } [9] => &object(ReflectionMethod)#63 (2) { ["name"] => string(10) "__toString" ["class"] => string(9) "Exception" } }

ZendFramework Zend_Uri

admin — Mon, 28 Sep 2009 13:52:38 +0000

以下のようにすると文字列がURIとして妥当かどうか検証できる。

各メソッドについて

bool Zend_Uri::check(string $url)

与えられた文字列がURIとして適当か判定する。