Zastanawiam się, jaki jest najlepszy, najczystszy i najprostszy sposób pracy z relacjami wiele do wielu w Doctrine2.
Załóżmy, że mamy album typu Master of Puppets Metalliki z kilkoma utworami. Należy jednak pamiętać, że jeden utwór może pojawiać się w więcej niż jednym albumie, podobnie jak Battery Metalliki - trzy albumy zawierają ten utwór.
Potrzebuję więc relacji wiele do wielu między albumami i ścieżkami, używając trzeciej tabeli z dodatkowymi kolumnami (np. Pozycji ścieżki w określonym albumie). Właściwie muszę użyć, jak sugeruje dokumentacja Doctrine, podwójnej relacji jeden do wielu, aby osiągnąć tę funkcjonalność.
/** @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;
}
}
Przykładowe dane:
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 |
+----+----------+----------+----------+------------+
Teraz mogę wyświetlić listę albumów i powiązanych z nimi utworów:
$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!' : ''
);
}
}
Wyniki są takie, jakich się spodziewam, tj .: lista albumów z ich utworami w odpowiedniej kolejności i promowanymi oznaczonymi jako promowane.
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)
Więc co jest nie tak?
Ten kod pokazuje, co jest nie tak:
foreach ($album->getTracklist() as $track) {
echo $track->getTrack()->getTitle();
}
Album::getTracklist()
zwraca tablicę AlbumTrackReference
obiektów zamiast Track
obiektów. Nie mogę utworzyć metod proxy, co by było, gdyby jedno Album
i drugie Track
miałoby getTitle()
metodę? Mógłbym wykonać dodatkowe przetwarzanie w ramach Album::getTracklist()
metody, ale jaki jest najprostszy sposób, aby to zrobić? Czy jestem zmuszony napisać coś takiego?
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
EDYTOWAĆ
@beberlei zasugerował użycie metod proxy:
class AlbumTrackReference {
public function getTitle() {
return $this->getTrack()->getTitle()
}
}
To byłby dobry pomysł, ale używam tego „obiektu referencyjnego” z obu stron: $album->getTracklist()[12]->getTitle()
i $track->getAlbums()[1]->getTitle()
dlatego getTitle()
metoda powinna zwracać różne dane w zależności od kontekstu wywołania.
Musiałbym zrobić coś takiego:
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();
}
I to nie jest bardzo czysty sposób.
$album->getTracklist()[12]
is AlbumTrackRef
object, więc $album->getTracklist()[12]->getTitle()
zawsze zwraca tytuł ścieżki (jeśli używasz metody proxy). Chociaż $track->getAlbums()[1]
jest Album
obiektem, więc $track->getAlbums()[1]->getTitle()
zawsze zwraca tytuł albumu.
AlbumTrackReference
dwóch metod proxy getTrackTitle()
i getAlbumTitle
.