Da wir bis jetzt eigentlich nur Handarbeit gemacht haben, wir es Zeit ein wenig den Kopf anzustrengen. Nach Vorgabe brauchen wir erstmal einen Stamm-Datensatz, der die Band bezeichnet und beschreibt. Später kommen dann über 1:n Relationen noch die weiteren Forderungen hinzu. Doch fangen wir erstmal mit der Grundforderung an. Unsere Struktur für den Basis Daten-Satz der Band ist zielmlich einfach:
- ‚titel‘ – Name der Band
- ‚description‘ – Beschreibung der Band (History, Discographie, etc.)
- ‚images‘ – Bilder der Band
- ‚categories‘ – Die Genre Zuordnung der Band
- ’sort_order‘ – Ein Feld zur optionelen Sortierung der Bands
Diese Struktur ist die Basis für eine Datenbank-Tabelle, die wir durch die Datei ext_tables.sql im Root unserer Extension für das Typo3 System als SQL Anweisung bereitstellen. Die Datei ist nichts anderes als eine SQL Datei, die bei Installation der Extension ausgeführt wird. Wichtig ist hierbei, dass man immer darauf achten sollte, dass die Angeben der Datei mit dem Model übereinstimmen. Nebenbei achten wir auch etwas auf die Typo3 Konformität und ergänzen unsere Struktur mit den Typo3 Basis Datenbankfelder, die uns sehr viele Möglichkeiten im Typo3 Datenbank-Handling geben.
CREATE TABLE tx_tut23bandagenda_domain_model_tut23band ( uid int(11) NOT NULL auto_increment, pid int(11) DEFAULT '0' NOT NULL, titel varchar(255) DEFAULT '' NOT NULL, description text NOT NULL, images int(11) unsigned NOT NULL default '0', categories varchar(255) DEFAULT '' NOT NULL, sort_order int(11) DEFAULT '0' NOT NULL, tstamp int(11) unsigned DEFAULT '0' NOT NULL, crdate int(11) unsigned DEFAULT '0' NOT NULL, cruser_id int(11) unsigned DEFAULT '0' NOT NULL, deleted tinyint(4) unsigned DEFAULT '0' NOT NULL, hidden tinyint(4) unsigned DEFAULT '0' NOT NULL, starttime int(11) unsigned DEFAULT '0' NOT NULL, endtime int(11) unsigned DEFAULT '0' NOT NULL, t3ver_oid int(11) DEFAULT '0' NOT NULL, t3ver_id int(11) DEFAULT '0' NOT NULL, t3ver_wsid int(11) DEFAULT '0' NOT NULL, t3ver_label varchar(255) DEFAULT '' NOT NULL, t3ver_state tinyint(4) DEFAULT '0' NOT NULL, t3ver_stage int(11) DEFAULT '0' NOT NULL, t3ver_count int(11) DEFAULT '0' NOT NULL, t3ver_tstamp int(11) DEFAULT '0' NOT NULL, t3ver_move_id int(11) DEFAULT '0' NOT NULL, sys_language_uid int(11) DEFAULT '0' NOT NULL, l10n_parent int(11) DEFAULT '0' NOT NULL, l10n_diffsource mediumblob, PRIMARY KEY (uid), KEY parent (pid), KEY t3ver_oid (t3ver_oid,t3ver_wsid), KEY language (l10n_parent,sys_language_uid) );
In diesem Fall ergibt sich der Tabellen-Name ‚tx_tut23bandagenda_domain_model_tut23band‘ aus dem Präfix ‚tx‘, dem Extension Namen und dem Controller Namen. Durch diese Tabellen Struktur haben wir eigentlich schon unser erstes Model für die Extension fest vordefiniert und müssen es nur noch durch die Datei namens Tut23band.php im Ordner Classes/Domain/Model als Model für das Typo3 System genau definieren.
Das Model ist eine Klasse die den Model Namen trägt und mit der \TYPO3\CMS\Extbase\DomainObject\AbstractEntity beerbt wird, die die Typo3 Basis Tabellen Definitionen beinhaltet. In dieser Klasse müssen wir nun jedes Feld unserer Band Daten Struktur als protected Variable anlegen und um sie anzusprechen jeweils mit einem Getter und Setter ergänzen. Hier kommt eine Besonderheit von Typo3 zum tragen: Die Variablen-Definitionen sowie die erwarteten Parameter werden aus den Kommentaren generiert. D.h. wenn hier nicht alle Informationen akriebisch eingetragen werden, wird es zu Fehlermeldungen kommen, bzw. das ganze System nicht funtionieren.
Am Beispiel der ‚title‘ Variable sehen wir diese eideutigen Definitionen. $title ist eindeutig als var string eingetragen. Der Getter erwartet keine Variable, gibt aber den string $titel zurück. Ebenso ist der Setter klar strukturiert. Er erwaretet string $titel und gibt nichts zurück.
/**
* titel
*
* @var string
*/
protected $titel = '';
/**
* Returns the titel
*
* @return string $titel
*/
public function getTitel() {
return $this->titel;
}
/**
* Sets the titel
*
* @param string $titel
* @return void
*/
public function setTitel($titel) {
$this->titel = $titel;
}
Die meisten Variablen Definitionen sind bereits durch unsere SQL-Datei vorgegeben. Wir können jedoch auch Typo3 Objekte als Daten-Typen wählen, um die Core Funktionalität zu nutzen. In unserem Model nutzen wir das bei den images, die wir über die Zuweisung \TYPO3\CMS\Extbase\Domain\Model\FileReference als Typo3 File Reference Objekt definieren, um auf das bekannte File Handling zugreifen zu können. Diesem widmen wir uns noch in einem eigenen Abschnitt.
Das ganze Model sieht im Endeffekt wie folgt aus.
class Tut23band extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity {
/**
* titel
*
* @var string
*/
protected $titel = '';
/**
* description
*
* @var string
*/
protected $description = '';
/**
* images
*
* @var \TYPO3\CMS\Extbase\Domain\Model\FileReference
*/
protected $images = NULL;
/**
* categories
*
* @var string
*/
protected $categories = '';
/**
* sortOrder
*
* @var integer
*/
protected $sortOrder = 0;
/**
* Returns the titel
*
* @return string $titel
*/
public function getTitel() {
return $this->titel;
}
/**
* Sets the titel
*
* @param string $titel
* @return void
*/
public function setTitel($titel) {
$this->titel = $titel;
}
/**
* Returns the description
*
* @return string $description
*/
public function getDescription() {
return $this->description;
}
/**
* Sets the description
*
* @param string $description
* @return void
*/
public function setDescription($description) {
$this->description = $description;
}
/**
* Returns the images
*
* @return \TYPO3\CMS\Extbase\Domain\Model\FileReference $images
*/
public function getImages() {
return $this->images;
}
/**
* Sets the images
*
* @param \TYPO3\CMS\Extbase\Domain\Model\FileReference $images
* @return void
*/
public function setImages(\TYPO3\CMS\Extbase\Domain\Model\FileReference $images) {
$this->images = $images;
}
/**
* Returns the categories
*
* @return string $categories
*/
public function getCategories() {
return $this->categories;
}
/**
* Sets the categories
*
* @param string $categories
* @return void
*/
public function setCategories($categories) {
$this->categories = $categories;
}
/**
* Returns the sortOrder
*
* @return integer $sortOrder
*/
public function getSortOrder() {
return $this->sortOrder;
}
/**
* Sets the sortOrder
*
* @param integer $sortOrder
* @return void
*/
public function setSortOrder($sortOrder) {
$this->sortOrder = $sortOrder;
}
}
Hier findet man natürlich nur die Definitionen der in der Struktur-Planung angedachten Felder. Alle Typo3 spzifischen Variablen sind bereits durch das Vererben der AbstractEntity in das Model integriert.
Nun müssen wir das Model noch in den TCA einbinden. Dafür gibt es den nächsten Blogbeitrag in Kürze.