Doctrineで関連レコードにアクセスするのは簡単です: レコードプロパティに関してまったく同じゲッターとセッターを使うことができます。

3つの方法はどれでも使えますが、配列のポータビリティを目的にするなら最後の方法がお勧めです。

// test.php

// ...
$user = new User();
$user['username'] = 'jwage';
$user-['password'] = 'changeme';

$email = $user->Email;

$email = $user->get('Email');

$email = $user['Email'];

存在しない一対一の関連レコードにアクセスするとき、Doctrineは自動的にオブジェクトを作成します。That is why the above

// test.php

// ...
$user->Email->address = 'jonwage@gmail.com';
$user->save();

一対多の関連レコードにアクセスするとき、Doctrineは関連コンポーネント用のDoctrine_Collectionを作成します。リレーションが一対多であるusersとphonenumbersを考えてみましょう。上記で示されるようにphonenumbersを簡単に追加できます:

// test.php

// ...
$user->Phonenumbers[]->phonenumber = '123 123';
$user->Phonenumbers[]->phonenumber = '456 123';
$user->Phonenumbers[]->phonenumber = '123 777';

ユーザーと関連の電話番号を簡単に保存できます:

// test.php

// ...
$user->save();

2つの関連コンポーネントの間でリンクを簡単に作る別の方法はDoctrine_Record::link()を使うことです。既存の2つのレコードをお互いに関連づける(もしくはリンクする)ことはよくあります。この場合、関わるレコードクラスの間で定義されたリレーションがある場合、関連レコードの識別子だけが必要です:

新しい Phonenumberオブジェクトを作成し新しい電話番号の識別子を追跡しましょう:

// test.php

// ...
$phoneIds = array();

$phone1 = new Phonenumber();
$phone1['phonenumber'] = '555 202 7890';
$phone1->save();

$phoneIds[] = $phone1['id'];

$phone2 = new Phonenumber();
$phone2['phonenumber'] = '555 100 7890';
$phone2->save();

$phoneIds[] = $phone2['id'];

Userレコード用に存在するので電話番号をユーザーにリンクしましょう。

// test.php

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

$user->link('Phonenumbers', $phoneIds);

UserレコードクラスへのリレーションがPhonenumberレコードクラスに対して定義された場合、次のようにもできます:

最初に連携するユーザーを作ります:

// test.php

// ...
$user = new User();
$user['username'] = 'jwage';
$user['password'] = 'changeme';
$user->save();

新しいPhonenumberインスタンスを作成します:

// test.php

// ...
$phone1 = new Phonenumber();
$phone1['phonenumber'] = '555 202 7890';
$phone1->save();

UserをPhonenumberにリンクできます:

// test.php

// ...
$phone1->link('User', array($user['id']));

別の電話番号を作成できます:

// test.php

// ...
$phone2 = new Phonenumber();
$phone2['phonenumber'] = '555 100 7890';

このPhonenumberもUserにリンクしましょう:

// test.php

// ...
$phone2->link('User', array($user['id']));

前の節とまったく同じなDoctrine_Recordメソッドで関連レコードを読み取ることができます。既にロードされていない関連コンポーネントにアクセスするときDoctrineが取得に1つのSELECT文を使用することに注意してください。次の例では3つのSQL SELECTが実行されます。

// test.php

// ...
$user = Doctrine_Core::getTable('User')->find(1);

echo $user->Email['address'];

echo $user->Phonenumber[0]->phonenumber;

これをもっと効率的に行うにはDQLを使います。次の例では関連コンポーネントの読み取りに1つのSQLクエリのみを使用します。

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->leftJoin('u.Email e')
    ->leftJoin('u.Phonenumber p')
    ->where('u.id = ?', 1);

$user = $q->fetchOne();

echo $user->Email['address'];

echo $user->Phonenumber[0]['phonenumber'];

それぞれの関連オブジェクト/コレクションに対してsaveを個別に呼び出すもしくは他のオブジェクトを所有するオブジェクトでsave()を呼び出すことで関連レコードを更新できます。すべての追加オブジェクトを保存するDoctrine_Connection::flushを呼び出すこともできます。

// test.php

// ...
$user->Email['address'] = 'koskenkorva@drinkmore.info';

$user->Phonenumber[0]['phonenumber'] = '123123';

$user->save();

上記の例では$user->save()を呼び出すことでemailとphonenumberが保存されます。

オブジェクトから関連レコードリファレンスをクリアすることができます。これはこれらのオブジェクトが関連しているという事実を変更することはなく、また保存するのであればデータベースでこれを変更することはありません。これはPHPの1つのオブジェクトの参照を別のものにクリアするだけです。

次のコードを実行することですべてのリファレンスをクリアできます:

// test.php

// ...
$user->clearRelated();

もしくは特定のリレーションシップをクリアすることもできます:

// test.php

// ...
$user->clearRelated('Email');

これは次のようなことをしたい場合に便利です:

// test.php

// ...
if ($user->Email->exists()) {
    // ユーザーがメールを持つ
} else {
    // ユーザーがメールを持たない
}

$user->clearRelated('Email');

Emailオブジェクトが存在しない場合Doctrineが新しいEmailオブジェクトを自動的に作成するので、あたかも$user->save()を呼び出しUserの空白のEmailレコードを保存しないように、この参照をクリアする必要があります。

relatedExists()メソッドを使うことで上記のシナリオを簡略化できます。これで上記のチェックはより短いコードになり後で不必要な参照をクリアすることにわずらわずに済みます。

if ($user->relatedExists('Email')) {
    // ユーザーがメールを持つ
} else {
    // ユーザーがメールを持たない
}

レコードもしくはコレクション上でdelete()を呼び出すことで関連レコードを個別に削除できます。

個別の関連レコードを削除できます:

// test.php

// ...
$user->Email->delete();

レコードのコレクションの範囲から個別のレコードを削除できます:

// test.php

// ...
$user->Phonenumber[3]->delete();

望むのであればコレクション全体を削除できます:

// test.php

// ...
$user->Phonenumbers->delete();

もしくはユーザー全体とすべての関連オブジェクトを削除できます:

// test.php

// ...
$user->delete();

典型的なウェブアプリケーションでは削除される関連オブジェクトの主キーはフォームからやってきます。この場合関連レコードの最も効率的な削除はDQLのDELETEステートメントを使用することです。リレーションが一対多であるUsersとPhonenumbersを再度考えてみましょう。与えられたユーザーidに対してPhonenumbersを削除することは次のように実現できます:

// test.php

// ...
$q = Doctrine_Query::create()
    ->delete('Phonenumber')
    ->addWhere('user_id = ?', 5)
    ->whereIn('id', array(1, 2, 3));

$numDeleted = $q->execute();

ときにPhonenumberレコードを削除したくないが外部キーをnullに設定することでリレーションのリンクを解除したいことがあります。もちろんこれはDQLを使えば実現できますが最もエレガントな方法はDoctrine_Record::unlink()を使う方法です。

unlink()メソッドが非常にスマートであることに留意してください。このメソッドは関連するPhonenumbers用の外部キーをnullにする設定するだけでなく{User}}オブジェクトからPhonenumberのすべての参照も削除します。

Userが3つのPhonenumbers(識別子は1、2と3)を持つことを考えましょう。Phonenumbers 1と3のリンク解除は次のように実現できます:

// test.php

// ...
$user->unlink('Phonenumber', array(1, 3));

echo $user->Phonenumbers->count(); // 1

UserとGroupの2つのクラスを考えてみましょう。これらはGroupUserアソシエーションクラスを通してリンクされます。一時的な(新しい)レコードを扱うときにUserとGroupsの組を追加するための最速の方法は次の通りです:

// test.php

// ...
$user = new User();
$user->username = 'Some User';
$user->Groups[0]->username = 'Some Group';
$user->Groups[1]->username = 'Some Other Group';
$user->save();

しかしながら実際の世界のシナリオではユーザーを追加したい既存のグループがあることはよくあります、これを行う最も効率的な方法は次の通りです:

// test.php

// ...
$groupUser = new GroupUser();
$groupUser->user_id = $userId;
$groupUser->group_id = $groupId;
$groupUser->save();

多対多の関連レコード間のリンクを削除する正しい方法はDQL DELETEステートメントを使うことです。DQL DELETEを利用する際に便利で推奨される方法はQuery APIを通して行われます。

// test.php

// ...
$q = Doctrine_Query::create()
    ->delete('UserGroup')
    ->addWhere('user_id = ?', 5)
    ->whereIn('group_id', array(1, 2));

$deleted = $q->execute();

関連オブジェクトの間のリレーションをunlinkする別の方法はDoctrine_Record::unlinkメソッドを通したものです。しかしながら、こｎメソッドは最初にデータベースにクエリを行うので親モデルが既に存在しない限りこのメソッドは避けるべきです。

// test.php

// ...
$user = Doctrine_Core::getTable('User')->find(5);
$user->unlink('Group', array(1, 2));
$user->save();

2番目の引数を省略することでGroupへのすべてのリレーションのリンクを解除することもできます:

// test.php

// ...
$user->unlink('Group');

UserとGroupの間のリンクを削除する明確で便利な方法が次であるとしても、これを行うべきでは*ありません*:

// test.php

// ...
$user = Doctrine_Core::getTable('User')->find(5);
$user->GroupUser->remove(0)->remove(1);
$user->save();

この方法は$user->GroupUserへの呼び出しは与えられたUserに対するすべてのGroupリンクをロードしているからです。Userが多くのGroupsに所属している場合この方法が時間のかかるタスクになる可能性があります。ユーザーがわずかなgroupsに所属する場合でも、これが不要なSELECTステートメントを実行します。

リレーションに対してレコードの数をカウントする:

// test.php

// ...
$q = Doctrine_Query::create()
    ->select('u.*, COUNT(DISTINCT p.id) AS num_phonenumbers')
    ->from('User u')
    ->leftJoin('u.Phonenumbers p')
    ->groupBy('u.id');

$users = $q->fetchArray();

echo $users[0]['Phonenumbers'][0]['num_phonenumbers'];

ユーザーとユーザーが所属するグループを読み取る:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->leftJoin('u.Groups g');

$users = $q->fetchArray();

foreach ($users[0]['Groups'] as $group) {
    echo $group['name'];
}

1つのパラメータの値を持つシンプルなWHERE:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->where('u.username = ?', 'jwage');

$users = $q->fetchArray();

複数のパラメータの値を持つマルチプルWHERE:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->leftJoin('u.Phonenumbers p')
    ->where('u.username = ? AND p.id = ?', array(1, 1));

$users = $q->fetchArray();

オプションとして既存のwhere部分に追加するためにandWhere()メソッドを使うこともできます。

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->leftJoin('u.Phonenumbers p')
    ->where('u.username = ?', 1)
    ->andWhere('p.id = ?', 1);

$users = $q->fetchArray();

whereIn()コンビニエンスメソッドを使用する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->whereIn('u.id', array(1, 2, 3));

$users = $q->fetchArray();

次のコードは上記と同じ:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->where('u.id IN (1, 2, 3)');

$users = $q->fetchArray();

WHEREでDBMS関数を使う:

// test.php

// ...
$userEncryptedKey = 'a157a558ac00449c92294c7fab684ae0';
$q = Doctrine_Query::create()
    ->from('User u')
    ->where("MD5(CONCAT(u.username, 'secret_key')) = ?", $userEncryptedKey);

$user = $q->fetchOne();

$q = Doctrine_Query::create()
    ->from('User u')
    ->where('LOWER(u.username) = LOWER(?)', 'jwage');

$user = $q->fetchOne();

集約関数を使用して結果セットを制限する。1つ以上の電話番号を持つユーザーに制限する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->select('u.*, COUNT(DISTINCT p.id) AS num_phonenumbers')
    ->from('User u')
    ->leftJoin('u.Phonenumbers p')
    ->having('num_phonenumbers > 1')
    ->groupBy('u.id');

$users = $q->fetchArray();

WITHを使用して最初の電話番号のみをJOINする:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->leftJoin('u.Phonenumbers p WITH p.primary_num = ?', true);

$users = $q->fetchArray();

最適化用に特定のカラムを選択する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->select('u.username, p.phone')
    ->from('User u')
    ->leftJoin('u.Phonenumbers p');

$users = $q->fetchArray();

1つのPhonenumberカラムのみ以外のすべてのUserカラムを選択するためにワイルドカードを使用する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->select('u.*, p.phonenumber')
    ->from('User u')
    ->leftJoin('u.Phonenumbers p');

$users = $q->fetchArray();

シンプルなWHEREでDQLのdeleteを実行する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->delete('Phonenumber')
    ->addWhere('user_id = 5');

$deleted = $q->execute();

1つのカラムに対してシンプルなDQLのupdateを実行する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->update('User u')
    ->set('u.is_active', '?', true)
    ->where('u.id = ?', 1);

$updated = $q->execute();

DBMSの関数でDQL updateを実行する。すべてのユーザー名を小文字にする:

// test.php

// ...
$q = Doctrine_Query::create()
  ->update('User u')
  ->set('u.username', 'LOWER(u.username)');

$updated = $q->execute();

レコードを検索するためにMySQLのLIKEを使用する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->where('u.username LIKE ?', '%jwage%');

$users = $q->fetchArray();

レコードエントリのキーが割り当てたカラムの名前であるデータをハイドレイトするためにINDEXBYキーワードを使用する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u INDEXBY u.username');

$users = $q->fetchArray();

jwageのユーザー名を持つユーザーを表示できます:

// test.php

// ...
print_r($users['jwage']);

位置パラメータを使用する

$q = Doctrine_Query::create()
    ->from('User u')
    ->where('u.username = ?', array('Arnold'));

$users = $q->fetchArray();

名前付きパラメータを使用する

$q = Doctrine_Query::create()
    ->from('User u')
    ->where('u.username = :username', array(':username' => 'Arnold'));

$users = $q->fetchArray();

WHEREでサブクエリを使用する。Group 2という名前のグループに存在しないユーザーを見つける:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->where('u.id NOT IN (SELECT u.id FROM User u2 INNER JOIN u2.Groups g WHERE g.name = ?)', 'Group 2');

$users = $q->fetchArray();

サブクエリなしでこれを実現できます。下記の2つの例は上記の例と同じ結果が得られます。

グループを持つユーザーを読み取るためにINNER JOINを使用する

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->innerJoin('u.Groups g WITH g.name != ?', 'Group 2')

$users = $q->fetchArray();

グループを持つユーザーを読み取るためにWHERE条件を使用する

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u')
    ->leftJoin('u.Groups g')
    ->where('g.name != ?', 'Group 2');

$users = $q->fetchArray();

Doctrineはクエリを実行してデータを読み取るための多くの方法を持ちます。下記のコードはクエリを実行する異なるすべての方法の例です:

最初にテストするサンプルクエリを作成する:

// test.php

// ...
$q = Doctrine_Query::create()
    ->from('User u');

fetchArray()メソッドで配列のハイドレーションを実行できます:

$users = $q->fetchArray();

execute()メソッドの2番目の引数でハイドレーションメソッドを指定することでも配列のハイドレーションを利用できます:

// test.php

// ...
$users = $q->execute(array(), Doctrine::HYDRATE_ARRAY)

setHydrationMethod()メソッドを利用することでもハイドレーションメソッドを指定できます:

$users = $q->setHydrationMode(Doctrine::HYDRATE_ARRAY)->execute(); // So is this

ときにはハイドレーションを完全に回避してPDOが返す生のデータが欲しいことがあります:

// test.php

// ...
$users = $q->execute(array(), Doctrine::HYDRATE_NONE);

クエリから1つのレコードだけを取得したい場合:

// test.php

// ...
$user = $q->fetchOne();

// Fetch all and get the first from collection
$user = $q->execute()->getFirst();

データベースからロードされるすべてのフィールドを持たないオブジェクトを取得するときこのオブジェクトの状態はプロキシ(proxy)と呼ばれます。プロキシオブジェクトはまたロードされていないフィールドを遅延ロードできます。

次の例では直接ロードされたusernameフィールドを持つすべてのUsersを取得します。それからpasswordフィールドを遅延ロードします:

// test.php

// ...
$q = Doctrine_Query::create()
    ->select('u.username')
    ->from('User u')
    ->where('u.id = ?', 1)

$user = $q->fetchOne();

次にpasswordフィールドを遅延ロードし値を読み取るために追加のデータベースクエリを実行します:

// test.php

// ...
$user->password;

Doctrineはロードされたフィールドのカウントに基づいてプロキシの評価を行います。フィールドごとにどのフィールドがロードされるのかは評価しません。この理由は単純でパフォーマンスです。PHPの世界ではフィールドの遅延ロードはほとんど必要ないので、どのフィールドがロードされるのかチェックするこの種の変数を導入することは基本的な取得に不要なオーバーロードを持ち込むことになります。

toArray()メソッドはレコードもしくはコレクションの配列表現です。これはオブジェクトが持つリレーションにもアクセスします。デバッグ目的でレコードを表示する必要がある場合オブジェクトの配列表現を取得して出力できます。

// test.php

// ...
print_r($user->toArray());

配列にリレーションを格納したい場合、trueの値を持つ引数$deepを渡す必要があります:

// test.php

// ...
print_r($user->toArray(true));

配列の値がありレコードもしくはコレクションを満たすために使いたい場合、fromArray()メソッドはこの共通のタスクを簡略化します。

// test.php

// ...
$data = array(
  'name' => 'John',
  'age' => '25',
  'Emails' => array(
    array('address' => 'john@mail.com'),
    array('address' => 'john@work.com')
  'Groups' => array(1, 2, 3)
);

$user = new User();
$user->fromArray($data);
$user->save();

次のようにカスタムモデルのミューテータでfromArray()を使うことが可能です:

// models/User.php

class User extends Doctrine_Record
{
    // ...

    public function setEncryptedPassword($password)
    {
        return $this->_set('password', md5($password));
    }
}

fromArray()を使う場合encrypted_passwordという名前の値を渡すことでsetEncryptedPassword()メソッドを使うことができます。

// test.php

// ...
$user->fromArray(array('encrypted_password' => 'changeme'));

synchronizeWithArray()によってレコードと配列を同期できます。モデルの配列表現がありフィールドを修正する場合、リレーションのフィールドを修正もしくはリレーションを削除もしくは作成します。この変更はレコードに適用されます。

// test.php

// ...
$q = Doctrine_Query::create()
    ->select('u.*, g.*')
    ->from('User u')
    ->leftJoin('u.Groups g')
    ->where('id = ?', 1);

$user = $q->fetchOne();

これを配列に変換してプロパティの一部を修正します:

// test.php

// ...
$arrayUser = $user->toArray(true);

$arrayUser['username'] = 'New name';
$arrayUser['Group'][0]['name'] = 'Renamed Group';
$arrayUser['Group'][] = array('name' => 'New Group');

レコードを読み取るために同じクエリを使いレコードと変数$arrayUserを同期します:

// test.php

// ...
$user = Doctrine_Query::create()
    ->select('u.*, g.*')
    ->from('User u')
    ->leftJoin('u.Groups g')
    ->where('id = ?', 1)
    ->fetchOne();

$user->synchronizeWithArray($arrayUser);
$user->save();

レコードをリンクするidの配列を指定することでリレーションをシンクロナイズすることもできます。

$user->synchronizeWithArray(array('Group' => array(1, 2, 3)));
$user->save();

上記のコードは既存のグループを削除しユーザーをグループid 1、2、3にリンクします。

リレーションを一緒にリンクするために内部ではDoctrine_Record::link()とDoctrine_Record::unlink()が使われています。