Pergunto-me qual é a melhor, a maneira mais limpa e mais simples de trabalhar com relações muitos-para-muitos no Doctrine2.
Vamos supor que temos um álbum como o Master of Puppets do Metallica com várias faixas. Mas observe o fato de que uma faixa pode aparecer em mais de um álbum, como o Battery by Metallica - três álbuns estão apresentando essa faixa.
Então, o que eu preciso é de um relacionamento muitos para muitos entre álbuns e faixas, usando a terceira tabela com algumas colunas adicionais (como a posição da faixa no álbum especificado). Na verdade, tenho que usar, como sugere a documentação de Doctrine, uma dupla relação um-para-muitos para alcançar essa funcionalidade.
/** @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;
}
}
Dados de amostra:
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 |
+----+----------+----------+----------+------------+
Agora eu posso exibir uma lista de álbuns e faixas associadas a eles:
$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!' : ''
);
}
}
Os resultados são o que eu estou esperando, ou seja: uma lista de álbuns com suas faixas na ordem apropriada e os promovidos sendo marcados como promovidos.
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)
Então, oque há de errado?
Este código demonstra o que está errado:
foreach ($album->getTracklist() as $track) {
echo $track->getTrack()->getTitle();
}
Album::getTracklist()
devolve uma disposição de AlbumTrackReference
objectos em vez de Track
objectos. Eu não posso criar métodos de proxy porque e se ambos, Album
e Track
teria getTitle()
método? Eu poderia fazer algum processamento extra dentro do Album::getTracklist()
método, mas qual é a maneira mais simples de fazer isso? Sou forçado a escrever algo assim?
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
EDITAR
@beberlei sugeriu usar métodos de proxy:
class AlbumTrackReference {
public function getTitle() {
return $this->getTrack()->getTitle()
}
}
Isso seria uma boa idéia, mas eu estou usando esse "objeto de referência" de ambos os lados: $album->getTracklist()[12]->getTitle()
e $track->getAlbums()[1]->getTitle()
, por isso getTitle()
método deve retornar dados diferentes com base no contexto de invocação.
Eu teria que fazer algo como:
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();
}
E essa não é uma maneira muito limpa.
$album->getTracklist()[12]
é AlbumTrackRef
object, portanto $album->getTracklist()[12]->getTitle()
, sempre retornará o título da faixa (se você estiver usando o método proxy). Enquanto $track->getAlbums()[1]
é Album
objeto, $track->getAlbums()[1]->getTitle()
sempre retornará o título do álbum.
AlbumTrackReference
dois métodos de proxy, getTrackTitle()
e getAlbumTitle
.