リレーションを検出する

前に見たようにDoctrineはdetect\_relationsオプションを指定する機能を提供します。この機能はカラムの名前に基づいてリレーションを自動的に構築します。contact_idを持つUserモデルとContactという名前を持つクラスが存在する場合、2つの間のリレーションが自動的に作成されます。

リレーションをカスタマイズする

Doctrineは外部キーが存在している側のリレーションを指定することのみを要求します。リレーションの反対側は反映されもう一方側に基づいてビルドされます。スキーマ構文はリレーションのエイリアスと反対側の型をカスタマイズする機能を提供します。すべての関連するリレーションを一箇所で維持できるのでこれはよいニュースです。下記の内容はエイリアスと反対側のリレーションの型をカスタマイズする方法です。これはUserが1つのContactを持ちContactは1つのUserをUserModelとして持つというリレーションを示しています。通常は自動生成されたUserは1つのContactを持ちContactは複数のUserを持ちます。foreignTypeとforeignAliasオプションによって反対側のリレーションをカスタマイズできます。

User: columns: id: type: integer(4) primary: true autoincrement: true

contact_id: type: integer(4) username: type: string(255) password: type: string(255) relations: Contact: foreignType: one foreignAlias: UserModel

Contact: columns: id: type: integer(4) primary: true autoincrement: true name: type: string(255)

次のようにthe detect_relationsオプションを持つ2つのモデルの間のリレーションを見つけて作成できます。

detect_relations: true

User: columns: id: type: integer(4) primary: true autoincrement: true avatar_id: type: integer(4) username: type: string(255) password: type: string(255)

Avatar: columns: id: type: integer(4) primary: true autoincrement: true name: type: string(255) image_file: type: string(255)

結果のリレーションはUserは1つのAvatarを持ちAvatarは複数のUserを持ちます。

一対一

User: columns: id: type: integer(4) primary: true autoincrement: true

contact_id: type: integer(4) username: type: string(255) password: type: string(255) relations: Contact: foreignType: one

Contact: columns: id: type: integer(4) primary: true autoincrement: true name: type: string(255)

一対多

User: columns: id: type: integer(4) primary: true autoincrement: true

contact_id: type: integer(4) username: type: string(255) password: type: string(255)

Phonenumber: columns: id: type: integer(4) primary: true autoincrement: true name: type: string(255) user_id: type: integer(4) relations: User: foreignAlias: Phonenumbers

多対多

User: columns: id: type: integer(4) autoincrement: true primary: true

username: type: string(255) password: type: string(255) attributes: export: all validate: true

Group: tableName: group_table columns: id: type: integer(4) autoincrement: true primary: true name: type: string(255) relations: Users: foreignAlias: Groups class: User refClass: GroupUser

GroupUser: columns: group_id: type: integer(4) primary: true user_id: type: integer(4) primary: true relations: Group: foreignAlias: GroupUsers User: foreignAlias: GroupUsers

この場合Userは複数のGroupsを持ち、Groupは複数のUsersを持ち、GroupUserは1つのUserを持ちGroupUserは1つのGroupを持つモデルのセットが作られます。

接続バインディング

モデルを管理するためにスキーマファイルを使わないのであれば、通常は次のコードのようにコンポーネントを接続名にバインドするために使います:

下記のように接続を作成します:

Doctrine_Manager::connection('mysql://jwage:pass@localhost/connection1', 'connection1');

Doctrineのブートストラップスクリプトでモデルをその接続にバインドします:

Doctrine_Manager::connection()->bindComponent('User', 'conn1');

スキーマファイルは接続パラメータを指定することでこれを特定の接続にバインドする機能を提供します。接続を指定しなければモデルはDoctrine_Managerインスタンスにセットあれた現在の接続を使います。

User: connection: connection1 columns: id: type: integer(4) primary:

true autoincrement: true contact_id: type: integer(4) username: type: string(255) password: type: string(255)

属性

Doctrine_Record子クラスを手作業で書いたのと同じようにDoctrineはスキーマファイルで生成モデル用の属性を直接設定する手段を提供します。

User: connection: connection1 columns: id: type: integer(4) primary:

true autoincrement: true contact_id: type: integer(4) username: type: string(255) password: type: string(255) attributes: export: none validate: false

列挙型

スキーマファイルでenumカラムを使うために型をenumとして指定し可能なenumの値として値の配列を指定しなければなりません。

TvListing: tableName: tv_listing actAs: [Timestampable] columns:

notes: type: string taping: type: enum length: 4 values: ['live', 'tape'] region: type: enum length: 4 values: ['US', 'CA']

ActAsビヘイビア

actAsオプションでモデルにビヘイビアを取り付けることができます:

User: connection: connection1 columns: id: type: integer(4) primary:

true autoincrement: true contact_id: type: integer(4) username: type: string(255) password: type: string(255) actAs: Timestampable: Sluggable: fields: [username] name: slug # defaults to 'slug' type: string # defaults to 'clob' length: 255 # defaults to null. clob doesn't require a length

NOTE

何も指定しない場合デフォルトの値が使われるのでSluggableビヘイビアで指定されたオプションはオプションです。これらはデフォルトなので毎回入力する必要はありません。

User: connection: connection1 columns: # ... actAs: [Timestampable,

Sluggable]

リスナー

モデルに取り付けたいリスナーがある場合、同じようにYAMLファイルで直接これらを指定できます。

User: listeners: [ MyCustomListener ] columns: id: type: integer(4)

primary: true autoincrement: true contact_id: type: integer(4) username: type: string(255) password: type: string(255)

上記の構文で次のような基底クラスが生成されます:

class BaseUser extends Doctrine_Record { // ...

public setUp() { // ... $this->addListener(new MyCustomListener()); } }

オプション

テーブル用のオプションを指定するとDoctrineがモデルからテーブルを作成するときにオプションはcreate tableステートメントに設定されます。

User: connection: connection1 columns: id: type: integer(4) primary:

true autoincrement: true contact_id: type: integer(4) username: type: string(255) password: type: string(255) options: type: INNODB collate: utf8_unicode_ci charset: utf8

インデックス

インデックスとオプションの詳細情報は[doc defining-models chapter]の[doc defining-models:indexes :name]セクションを参照してくださるようお願いします。

UserProfile: columns: user_id: type: integer length: 4 primary: true

autoincrement: true first_name: type: string length: 20 last_name: type: string length: 20 indexes: name_index: fields: first_name: sorting: ASC length: 10 primary: true last_name: [] type: unique

インデックスの定義用のモデルクラスのsetTableDefinition()で自動生成されたPHPコードは次の通りです:

$this->index('name_index', array( 'fields' => array( 'first_name' =>

array( 'sorting' => 'ASC',

'length' => '10', 'primary' => true ), 'last_name' => array()), 'type'

=> 'unique' ) );

継承

下記のコードはYAMLスキーマファイルを使用して異なるタイプの継承をセットアップする方法を示しています。

カスタムのエイリアス

データベースのカラム名以外のカラム名のエイリアスを作成したい場合、Doctrineでこれを実現するのは簡単です。カラムの名前でcolumn\_name as field\_nameの構文を使います:

User: columns: login: name: login as username type: string(255)

password: type: string(255)

上記の例ではusernameエイリアスからカラム名のloginにアクセスできます。

パッケージ

Doctrineはサブフォルダでモデルを生成するpackageパラメータを提供します。大きなスキーマファイルによってフォルダの内外でスキーマをよりよく編成できます。

User: package: User columns: username: string(255)

このスキーマファイルからのモデルファイルはUserという名前のフォルダに設置されます。package: User.Modelsとさらにサブフォルダを指定すればモデルはUser/Modelsになります。

グローバルスキーマの情報

Doctrineスキーマによってスキーマファイルで定義されたすべてのモデルに適用する特定のパラメータを指定できます。スキーマファイル用に設定できるグローバルパラメータの例が見つかります。

グローバルパラメータのリストは次の通りです:

|

上記のグローバルパラメータをいつか使ったスキーマの例は次の通りです:

connection: conn_name1 actAs: [Timestampable] options: type: INNODB

package: User detect_relations: true

User: columns: id: type: integer(4) primary: true autoincrement: true contact_id: type: integer(4) username: type: string(255) password: type: string(255)

Contact: columns: id: type: integer(4) primary: true autoincrement: true name: type: string(255)

トップレベルのすべての設定はYAMLで定義されたすべてのモデルに適用されます。