doctrine_testという名前のデータベースとuserという名前の単独のテーブルがある場合を考えてみましょう。userテーブルは次のSQL文で作成されます:

CREATE TABLE user (
   id bigint(20) NOT NULL auto_increment,
   first_name varchar(255) default NULL,
   last_name varchar(255) default NULL,
   username varchar(255) default NULL,
   password varchar(255) default NULL,
   type varchar(255) default NULL,
   is_active tinyint(1) default '1',
   is_super_admin tinyint(1) default '0',
   created_at TIMESTAMP,
   updated_at TIMESTAMP,
   PRIMARY KEY  (id)
) ENGINE=InnoDB

これをDoctrine_Recordクラスに変換することを考えます。Doctrineによってこれは簡単です！Getting Started章で作成したテストスクリプトを覚えていますか？これを利用してモデルを生成します。

最初にSQLiteのメモリの代わりにMySQLデータベースを使うためにbootstrap.phpを修正する必要があります:

// bootstrap.php

// ...
$conn = Doctrine_Manager::connection('mysql://root:mys3cr3et@localhost/doctrine_test', 'doctrine');
// ...

データベースがまだ存在せず接続ユーザーがデータベースを作成するパーミッションを持つ場合データベースを作成するために$conn->createDatabase()メソッドを使うことができます。テーブルを作成するためにCREATE TABLE文を使用します。

生成クラスを置く場所が必要なのでdoctrine_testディレクトリの中でmodelsという名前のディレクトリを作りましょう:

$ mkdir doctrine_test/models

モデルクラスを生成するにはtest.phpスクリプトにコードを追加することだけが必要です:

// test.php

// ...
Doctrine_Core::generateModelsFromDb('models', array('doctrine'), array('generateTableClasses' => true));

generateModelsFromDbメソッドは1つのパラメータのみを必要としこのパラメータはディレクトリです(生成レコードが書き込まれるディレクトリ)。2番目の引数はモデルを生成するためのデータベースの接続名の配列で、3番目はモデルのビルド用のオプションの配列です。

これだけです！doctrine_test/models/generatedディレクトリでBaseUser.phpという名前のファイルがあります。ファイルは次のようになります:

// models/generated/BaseUser.php

/**
 * This class has been auto-generated by the Doctrine ORM Framework
 */
abstract class BaseUser extends Doctrine_Record
{
  public function setTableDefinition()
  {
    $this->setTableName('user');
    $this->hasColumn('id', 'integer', 8, array('type' => 'integer', 'length' => 8, 'primary' => true, 'autoincrement' => true));
    $this->hasColumn('first_name', 'string', 255, array('type' => 'string', 'length' => 255));
    $this->hasColumn('last_name', 'string', 255, array('type' => 'string', 'length' => 255));
    $this->hasColumn('username', 'string', 255, array('type' => 'string', 'length' => 255));
    $this->hasColumn('password', 'string', 255, array('type' => 'string', 'length' => 255));
    $this->hasColumn('type', 'string', 255, array('type' => 'string', 'length' => 255));
    $this->hasColumn('is_active', 'integer', 1, array('type' => 'integer', 'length' => 1, 'default' => '1'));
    $this->hasColumn('is_super_admin', 'integer', 1, array('type' => 'integer', 'length' => 1, 'default' => '0'));
    $this->hasColumn('created_at', 'timestamp', null, array('type' => 'timestamp', 'notnull' => true));
    $this->hasColumn('updated_at', 'timestamp', null, array('type' => 'timestamp', 'notnull' => true));
  }
}

doctrine_test/modelsディレクトリでUser.phpという名前のファイルもあります。ファイルは次のようになります:

// models/User.php

/**
 * This class has been auto-generated by the Doctrine ORM Framework
 */
class User extends BaseUser
{

}

Doctrineはdoctrine_test/models/UserTable.phpでDoctrine_Tableスケルトンクラスを自動生成します。trueの値を持つgenerateTableClassesオプションを渡したからです。ファイルは次のようになります:

// models/UserTable.php

/**
 * This class has been auto-generated by the Doctrine ORM Framework
 */
class UserTable extends Doctrine_Table
{

}

モデルの機能をカスタマイズするためにUserとUserTableクラスの中でカスタムメソッドを設置できます。下記のコードは例です:

// models/User.php

// ...
class User extends BaseUser
{
    public function setPassword($password)
    {
        return $this->_set('password', md5($password));
    }
}

適切に動作させるためにpasswordアクセサをオーバーライドするにはbootstrap.phpファイルでauto_accessor_override属性を有効にしなければなりません。

// bootstrap.php

// ...
$manager->setAttribute(Doctrine_Core::ATTR_AUTO_ACCESSOR_OVERRIDE, true);

ユーザーパスワードを設定しようとするとmd5に暗号化されます。最初にmodelsディレクトリからモデルをオートロードするために次のようにbootstrap.phpファイルを修正する必要があります:

// bootstrap.php

// ...
Doctrine_Core::loadModels('models');

モデルのロードはこの章の[doc introduction-to-models:autoloading-models :name]セクションで説明されます。

Userモデルに行った変更をテストするコードを含めるためにtest.phpを修正します:

// test.php

// ...

$user = new User();
$user->username = 'jwage';
$user->password = 'changeme';

echo $user->password; // changemeではなくmd5ハッシュを出力する

ターミナルからtest.phpを実行するとき次の内容が表示されます:

$ php test.php
4cb9c8a8048fd02294477fcb1a41191a

UserTableクラスに追加するカスタムメソッドの例は次の通りです:

// models/UserTable.php

// ...
class UserTable extends Doctrine_Table
{
    public function getCreatedToday()
    {
        $today = date('Y-m-d h:i:s', strtotime(date('Y-m-d')));
        return $this->createQuery('u')
            ->where('u.created_at > ?', $today)
            ->execute();
    }
}

カスタムのDoctrine_Tableクラスをロードするにはbootstrap.phpファイルでautoload_table_classes属性を有効にしなければなりません。

// boostrap.php

// ...
$manager->setAttribute(Doctrine_Core::ATTR_AUTOLOAD_TABLE_CLASSES, true);

UserTableインスタンスを扱っているときにこのメソッドにアクセスできます:

// test.php

// ...
$usersCreatedToday = Doctrine_Core::getTable('User')->getCreatedToday();