Zend Framework入門（7）：抽象化レイヤによるデータベースアクセス手法 - Zend_Db（後編） -

Zend Frameworkによる実践的なPHPアプリケーション開発 7

テーブルクラスにメソッドを追加する

　次は、テーブルクラスにメソッドを追加する例を取り上げます。テーブルに格納するデータに固有の処理を行う際、テーブルクラスのメソッドとして実装すれば、データの操作や参照を行う箇所でこれを利用できます。テーブルに格納するデータに固有の処理があれば、テーブルクラスのメソッドとして実装しておくとよいでしょう。

　Permissionsテーブルを例に用います。「入室許可の有効期限は最長でも翌年度末まで」というルールがあったとします。この場合、レコードの追加または変更をする際にterm列に入れる値をチェックすることになります。このチェックの処理を入れてPermissionsテーブルのクラスを作ります。

table/Permissions.php

<?php
require_once 'Zend/Db/Table.php';

// 日付の処理にZend_Dateを使います
require_once 'Zend/Date.php';

// Permissionsテーブルに対応するクラスを定義します
class Permissions extends Zend_Db_Table_Abstract {
    // テーブルを含むデータベース名を指定します
    protected $_schema = 'db_zend_sample';
    // 主キーの列名を指定します
    protected $_primary = array('member_id', 'room_id');

    // 参照先テーブルを指定します
    protected $_referenceMap =
        array('ref_members' =>
                array('columns'       => 'member_id',
                      'refTableClass' => 'Members',
                      'refColumns'    => 'member_id'),
              'ref_office' =>
                array('columns'       => 'office_id',
                      'refTableClass' => 'Offices',
                      'refColumns'    => 'office_id'));

    // 有効期限をチェックするメソッド
    // 引数$termで指定した日付が翌年度末より後の場合、
       例外をスローします
    private static function _check_term($term) {
        // 現在の日付を取得します
        $now = new Zend_Date();

        // 現在が何月かで分岐し、翌々年度の4/1のオブジェクト
           を作ります
        if ($now->compare(3, Zend_Date::MONTH) > 0) {
            // 4月以降の場合、翌々年の4/1が翌々年度末になります
            $limit = new Zend_Date($now->add(2, Zend_Date::YEAR) .
                     '/4/1');
        } else {
            // 3月までの場合、翌年の4/1が翌々年度末になります
            $limit = new Zend_Date($now->add(1, Zend_Date::YEAR) .
                     '/4/1');
        }

        // 引数の日付が翌年度までに入っているか調べます
        if (!$limit->isLater(new Zend_Date($term))) {
            // 引数の日付が翌年度より後なので、例外をスローします
            throw new Exception('翌年度末より後の日付が
                                 指定されました。');
        }
    }

    // テーブルクラスのinsertメソッドをオーバーライドします
    public function insert($value_array) {
        // 有効期限のチェックを行います
        self::_check_term($value_array['term']);

        // 有効期限の指定に問題がなければ、
        // 親クラスのinsertメソッドを呼び出します
        parent::insert($value_array);
    }

    // テーブルクラスのupdateメソッドをオーバーライドします
    public function update($value_array, $condition) {
        // 有効期限のチェックを行います
        self::_check_term($value_array['term']);

        // 有効期限の指定に問題がなければ、
        // 親クラスのupdateメソッドを呼び出します
        parent::update($value_array, $condition);
    }
}

　日付が翌年度末までの期間に入っているか調べるため、_check_termメソッドを作りました。日付の処理にはZend FrameworkのZend_Dateコンポーネントを使いました。もしも引数で指定された日付が翌年度末より後であれば、例外をスローします。

　レコードの追加と更新の際にチェックを行うため、insertメソッドとupdateメソッドをオーバーライドしました。まずterm列に入れる値を_check_termメソッドでチェックします。問題があれば親クラスのinsertメソッドまたはupdateメソッドを呼び出さずに、_check_termメソッドからスローされた例外をそのままスローします。