.install Dateien schreiben
Eine .install Datei wird bei der Aktivierung eines Moduls das erste Mal aufgerufen und dazu verwendet, die Einrichtung des Moduls vorzunehmen. Die gebräuchlichste Aufgabe ist dabei das Erstellen der Tabellen und Fellder in der Datenbank. Die .install Datei hat keine spezielle Syntax. Sie ist nur eine simple PHP Datei mit anderer Dateiendung.
.install Dateien werden ebenfalls für die Durchführung von Updates verwendet, für den Fall, eine neue Modulversion benötigt dies.
Anweisungen
Installationsanweisungen werden in _install() Funktionen verpackt. Dieser hook wird bei der ersten Aktivierung eines Moduls aufgerufen. Hier können eine beliebige Anzahl an Funktionen implementiert werden, die gebräuchlichste ist jedoch, die vom Modul erforderlichen Tabellen zu erstellen.
Seit Drupal 6.x werden die Tabellen in der Datenbank mittels des Schema API erstellt.
Das Schema API erlaubt den Modulen, ihre Tabellen als ein strukturiertes Array zu deklarieren (ähnlich des Form API). Zusätzlich enthält die API auch Funktionen zum Erstellen, Enfternen und Ändern von Tabellen, Spalten und Indizes.
Beispiel einer Schema-Struktur (aus der Dokumentation des Schema API)
Als Beispiel wird hier ein Ausschnitt der Schemadefinition für die Tabelle 'node' verwendet:
<?php
$schema['node'] = array(
'description' => t('The base table for nodes.'),
'fields' => array(
'nid' => array(
'description' => t('The primary identifier for a node.'),
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE),
'vid' => array(
'description' => t('The current {node_revisions}.vid version identifier.'),
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0),
'type' => array(
'description' => t('The {node_type} of this node.'),
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'default' => ''),
'title' => array(
'description' => t('The title of this node, always treated a non-markup plain text.'),
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => ''),
),
'indexes' => array(
'node_changed' => array('changed'),
'node_created' => array('created'),
),
'unique keys' => array(
'nid_vid' => array('nid', 'vid'),
'vid' => array('vid')
),
'primary key' => array('nid'),
);
?>In diesem Ausschnitt hat die Tabelle 'node' vier Felder (Tabellenspalten) namens 'nid', 'vid', 'type' und 'title'. Jedes Feld spezifiziert seinen Typ (in diesem Beispiel 'serial', 'int' oder 'varchar') und ein paar zusätzliche Parameter (wie z.B. die Beschreibung des Feldes).
Der Primärschlüssel der Tabelle ist das Feld 'nid'. Es gibt weiterhin zwei eindeutige Schlüssel: der Erste heisst 'vid' und beinhaltet nur das Feld 'vid' und der Zweite heisst 'nid_vid', welcher die Felder 'nid' und 'vid' einschliesst. Zwei Indizes ('node_changed' auf dem Feld 'changed' und 'node_created' auf dem Feld 'created') werden ebenfalls angelegt (auch wenn die beiden Felder in diesem Beispiel nicht enthalten sind).
Tabelle erstellen: hook_schema und .install Dateien
Um die Tabellen eines Moduls verwalten zu können, benötigt das Schema API eine Implementierung von hook_schema() in der .install Datei. So kann beispielsweise die Datei mymodule.install diesen Inhalt haben:
<?php
function mymodule_schema() {
$schema['mytable1'] = array(
// specification for mytable1
);
$schema['mytable2'] = array(
// specification for mytable2
);
return $schema;
}
function
mymodule_install() {
// Create my tables.
drupal_install_schema('mymodule');
}
function
mymodule_uninstall() {
// Drop my tables.
drupal_uninstall_schema('mymodule');
}
?>Die Aktualisierung des Schemas für eine neue Modulversion arbeitet so, wie seit Drupal 4.7 bekannt: über hook_update_n(). Angenommen, es soll eine neue Spalte namens 'newcol' zur Tabelle 'mytable1' hinzugefügt werden. Zuerst muss dazu die Schema-Struktur in der Funktion mymodule_schema() angepasst werden, so dass neu erstellt Tabellen (bei der Erstinstallation) die neue Spalte beinhalten. Dann muss eine update Funktion zur Datei mymodule.install hinzugefügt werden:
<?php
function mymodule_update_1() {
$ret = array();
db_add_field($ret, 'mytable1', 'newcol', array('type' => 'int'));
return $ret;
?>Es gibt auch ein Modul namens Schema Module, das zusätzlich zur den in das Schema API eingebauten Funktionalitäten weitere Funktionen anbietet. Diese erweiterten Funktionen sind für Modulentwickler ziemlich hilfreich. Zur Zeit sind das:
- Schema Dokumentation: verlinkte Anzeige der im Schema enthaltenen Dokumentation jedes Feldes und jeder Tabelle.
- Erstellung der Schema-Struktur: das Modul durchsucht die Datenbank und erstellt daraus eine Schema API Datenstruktur.
- Vergleich von Schemata: das Modul vergleicht die Datenbankstruktur mit der Struktur, die in den aktivierten Modulen angegeben ist. Fehlende oder fehlerhafte Tabellen werden daraufhin aufgelistet.
- Anmelden oder Registrieren um Kommentare zu schreiben
Neue Kommentare
vor 16 Stunden 42 Minuten
vor 23 Stunden 21 Minuten
vor 23 Stunden 33 Minuten
vor 1 Tag 8 Minuten
vor 1 Tag 5 Stunden
vor 1 Tag 19 Stunden
vor 2 Tagen 4 Stunden
vor 3 Tagen 7 Stunden
vor 4 Tagen 2 Stunden
vor 6 Tagen 7 Stunden