Doctrine2で多対多のリレーションを処理するための最良で最もクリーンで最も簡単な方法は何だろうと思います。
メタリカのMaster of Puppetsのようないくつかのトラックのアルバムがあるとします。ただし、MetallicaのBatteryのように、1つのトラックが複数のアルバムに表示される場合があることに注意してください。このトラックは3つのアルバムで使用されています。
したがって、必要なのは、いくつかの追加の列(指定されたアルバム内のトラックの位置など)を含む3番目のテーブルを使用して、アルバムとトラックの多対多の関係です。実際、Doctrineのドキュメントが示唆しているように、私はその機能を実現するために二重の1対多の関係を使用する必要があります。
/** @Entity() */
class Album {
/** @Id @Column(type="integer") */
protected $id;
/** @Column() */
protected $title;
/** @OneToMany(targetEntity="AlbumTrackReference", mappedBy="album") */
protected $tracklist;
public function __construct() {
$this->tracklist = new \Doctrine\Common\Collections\ArrayCollection();
}
public function getTitle() {
return $this->title;
}
public function getTracklist() {
return $this->tracklist->toArray();
}
}
/** @Entity() */
class Track {
/** @Id @Column(type="integer") */
protected $id;
/** @Column() */
protected $title;
/** @Column(type="time") */
protected $duration;
/** @OneToMany(targetEntity="AlbumTrackReference", mappedBy="track") */
protected $albumsFeaturingThisTrack; // btw: any idea how to name this relation? :)
public function getTitle() {
return $this->title;
}
public function getDuration() {
return $this->duration;
}
}
/** @Entity() */
class AlbumTrackReference {
/** @Id @Column(type="integer") */
protected $id;
/** @ManyToOne(targetEntity="Album", inversedBy="tracklist") */
protected $album;
/** @ManyToOne(targetEntity="Track", inversedBy="albumsFeaturingThisTrack") */
protected $track;
/** @Column(type="integer") */
protected $position;
/** @Column(type="boolean") */
protected $isPromoted;
public function getPosition() {
return $this->position;
}
public function isPromoted() {
return $this->isPromoted;
}
public function getAlbum() {
return $this->album;
}
public function getTrack() {
return $this->track;
}
}
サンプルデータ:
Album
+----+--------------------------+
| id | title |
+----+--------------------------+
| 1 | Master of Puppets |
| 2 | The Metallica Collection |
+----+--------------------------+
Track
+----+----------------------+----------+
| id | title | duration |
+----+----------------------+----------+
| 1 | Battery | 00:05:13 |
| 2 | Nothing Else Matters | 00:06:29 |
| 3 | Damage Inc. | 00:05:33 |
+----+----------------------+----------+
AlbumTrackReference
+----+----------+----------+----------+------------+
| id | album_id | track_id | position | isPromoted |
+----+----------+----------+----------+------------+
| 1 | 1 | 2 | 2 | 1 |
| 2 | 1 | 3 | 1 | 0 |
| 3 | 1 | 1 | 3 | 0 |
| 4 | 2 | 2 | 1 | 0 |
+----+----------+----------+----------+------------+
これで、関連付けられたアルバムとトラックのリストを表示できます。
$dql = '
SELECT a, tl, t
FROM Entity\Album a
JOIN a.tracklist tl
JOIN tl.track t
ORDER BY tl.position ASC
';
$albums = $em->createQuery($dql)->getResult();
foreach ($albums as $album) {
echo $album->getTitle() . PHP_EOL;
foreach ($album->getTracklist() as $track) {
echo sprintf("\t#%d - %-20s (%s) %s\n",
$track->getPosition(),
$track->getTrack()->getTitle(),
$track->getTrack()->getDuration()->format('H:i:s'),
$track->isPromoted() ? ' - PROMOTED!' : ''
);
}
}
結果は私が期待しているものです。つまり、適切な順序でトラックが含まれているアルバムのリストと、プロモートされたアルバムがプロモートとしてマークされています。
The Metallica Collection
#1 - Nothing Else Matters (00:06:29)
Master of Puppets
#1 - Damage Inc. (00:05:33)
#2 - Nothing Else Matters (00:06:29) - PROMOTED!
#3 - Battery (00:05:13)
何が問題なのですか?
このコードは何が悪いのかを示しています:
foreach ($album->getTracklist() as $track) {
echo $track->getTrack()->getTitle();
}
Album::getTracklist()
AlbumTrackReference
オブジェクトの代わりにTrack
オブジェクトの配列を返します。私は何の両方の場合、原因プロキシメソッドを作成することはできません、Album
そしてTrack
だろうgetTitle()
方法を?Album::getTracklist()
メソッド内でいくつかの追加処理を行うことができますが、それを行う最も簡単な方法は何ですか?私はそのようなことを書くことを強制されますか?
public function getTracklist() {
$tracklist = array();
foreach ($this->tracklist as $key => $trackReference) {
$tracklist[$key] = $trackReference->getTrack();
$tracklist[$key]->setPosition($trackReference->getPosition());
$tracklist[$key]->setPromoted($trackReference->isPromoted());
}
return $tracklist;
}
// And some extra getters/setters in Track class
編集
@beberleiはプロキシメソッドの使用を提案しました:
class AlbumTrackReference {
public function getTitle() {
return $this->getTrack()->getTitle()
}
}
それは良い考えですが、私はその「参照オブジェクト」を両側から使用しています:$album->getTracklist()[12]->getTitle()
と$track->getAlbums()[1]->getTitle()
なので、getTitle()
メソッドは呼び出しのコンテキストに基づいて異なるデータを返す必要があります。
私は次のようなことをしなければなりません:
getTracklist() {
foreach ($this->tracklist as $trackRef) { $trackRef->setContext($this); }
}
// ....
getAlbums() {
foreach ($this->tracklist as $trackRef) { $trackRef->setContext($this); }
}
// ...
AlbumTrackRef::getTitle() {
return $this->{$this->context}->getTitle();
}
そして、それはあまりクリーンな方法ではありません。
$album->getTracklist()[12]
である AlbumTrackRef
オブジェクトなので、$album->getTracklist()[12]->getTitle()
(プロキシ方式を使用している場合)は、常にトラックのタイトルを返します。一方で$track->getAlbums()[1]
あるAlbum
オブジェクトは、そう$track->getAlbums()[1]->getTitle()
いつもアルバムのタイトルを返します。
AlbumTrackReference
2つのプロキシのメソッド、getTrackTitle()
およびgetAlbumTitle
。