07. Erstellen der Konfigurationsseite des Moduls
Beschreibung des Themas: Konfiguration des Moduls
beschriebener Drupal hook: hook_menu
Nun, da wir eni funktionierendes Modul haben, wollen wir es auch verbessern. Wenn wir eine Seite haben, die schon länger online ist, ist der vor einer Woche erstellte Inhalt womöglich nicht so interessant, wie vor einem Jahr erstellter Inhalt. Im gleichen Fall wollen wir möglicherweise auch nicht all die Links zu dem letzte Woche erstellten Inhalt anzeigen. Also erstellen wir eine Konfigurationsseite für unser Modul um ein paar Einstellungen vornehmen zu können.
Erstellen der Konfigurationsseite
Wir würden gerne einstellen können, wieviele Links im Block angezeigt werden. Also erstellen wir ein Formular für den Administrator, in dem er die Anzahl der Links setzen kann. Dies geschieht in unserer Funktion onthisdate_admin(). Beachte, dass _admin kein Hook ist und wir hier einen (nahezu) beliebigen Namen verwenden könnten (wollen wir jedoch nicht, da wir konsistent bleiben wollen).
<?php
function onthisdate_admin() {
$form['onthisdate_maxdisp'] = array(
'#type' => 'textfield',
'#title' => t('Maximum number of links'),
'#default_value' => variable_get('onthisdate_maxdisp', 3),
'#size' => 2,
'#maxlength' => 2,
'#description' => t("The maximum number of links to display in the block."),
'#required' => TRUE,
);
return
system_settings_form($form);
}
?>Diese Funktion verwendet mehrere mächtige Funktionen von Drupal zur Behandlung von Formularen. Wir müssen uns nicht um die Erstellung des HTML-Quelltextes der Textfelder oder des Formulars kümmern; Drupal macht das alles für uns. Wir verwenden variable_get um den Wert der Systemvariable "onthisdate_maxdisp" zu erhalten und setzen deren Standardwert auf 3. Ein Array (namens $form) wird verwendet, um das Formular mit einem Textfeld der Länge 2 (#size) zu erstellen. Das Textfeld akzeptiert maximal 2 Zeichen (#maxlength). Weiterhin verwenden wir die Übersetzungsfunktion t(). Die Funktion system_settings_form() fügt die Standardschaltflächen zum Formular hinzu uns setzt dessen Präfix.
Um zu erfahren, was man alles noch mit dem Drupal Form API anstellen kann, schau Dir die Seiten Forms API Reference und Forms API Quickstart Guide an.
Wenn Du eine Konfigurationsvariable für ein Modul speicherst, wird die Variable (in unserem Fall 'onthisdate_maxdisp') und deren Wert in der Tabelle variables gespeichert. Im Quelltext kannst Du die Variable dann über die Funktion variable_get('variable_name', default_value) abfragen.
Natürlich benötigen wir den Wert aus der Konfiguration auch in unserem "SQL SELECT", so dass wir unsere Abfrage in onthisdate_block anpassen müssen. Ein Weg dies zu tun ist über "LIMIT":
<?php
$limitnum = variable_get('onthisdate_maxdisp', 3);
$query = "SELECT nid, title, created FROM " .
"{node} WHERE created >= '" . $start_time .
"' AND created <= '". $end_time . "' LIMIT " . $limitnum;
?>Allerdings funktioniert diese Abfrage möglicherweise nicht mit allen Datenbanksystemen. Die Verwendung der Drupal-internen Methoden zum Selektieren von Daten ist in diesem Fall angebrachter. In diesem Fall bleibt die ursprüngliche Abfrage bestehen, die Daten werden jedoch über db_query_range abgefragt:
<?php
$limitnum = variable_get("onthisdate_maxdisp", 3);
$query = "SELECT nid, title, created FROM " .
"{node} WHERE created >= %d " .
"AND created <= %d";
$queryResult = db_query_range($query, $start_time, $end_time, 0, $limitnum);
?>Die Seite zu hook_menu hinzufügen
Sobald Du die Seite mit den Einstellungen erstellt hast, wird die Seite mit einem Callback zu der Funktion, die Du in hook_menu definierst, hinzugefügt. In hook_menu geben wir ein Array zurück, in dem Drupal mitgeteilt wird, welcher Pfad verwendet werden soll, welcher Titel angezeigt werden soll, welche Funktion verwendet werden soll und welche Berechtigungen für diese Seite notwendig sind.
Wir möchten, dass nur Administratoren zugriff zu unserer Konfigurationsseite haben, also fügen wir die Berechtigungsabfrage hier in hook_menu ein, so dass Drupal selbst die Berechtigungen des aktuellen Benutzers überprüft. Damit der Administrator nicht mit allzuvielen Berechtigungen hantieren muss, verwenden wir hier einfach die globalen Berechtigung, um unser Modul administrieren zu dürfen, anstatt eine neue Berechtigung zu erstellen.
<?php
function onthisdate_menu() {
$items = array();
$items['admin/settings/onthisdate'] = array(
'title' => 'On this date module settings',
'description' => 'Description of your On this date settings control',
'page callback' => 'drupal_get_form',
'page arguments' => array('onthisdate_admin'),
'access arguments' => array('access administration pages'),
'type' => MENU_NORMAL_ITEM,
);
return
$items;
}
?>Du kannst die Einstellungsseite testen, indem Du die Anzahl der darzustellenden Links änderst und dann (hoffentlich) siehst, wie sich der Blockinhalt entsprechend ändert. Rufe die Einstellungsseite (unter admin/settings/onthisdate oder im Menü unter "Administer » Settings » On this date") auf. Wenn die Seite nicht existiert, musst Du das Modul evtl. einmal schnell deaktivieren und dann wieder aktivieren, damit die neue Seite im System registriert wird. Verändere jetzt die Anzahl der anzuzeigenden Links und Du solltest sehen, wie sich die Anzahl der Links im Block entsprechend ändert.
Nutzereingaben validieren
Obwohl wir die Nutzereingaben nicht unbedingt validieren müssen, ist dies immer besser. Dabei hilft uns die Funktion onthisdate_validate(), in der geprüft wird, ob der vom Nutzer eingegebene Wert grösser als 0 ist. Drupal bemerkt automatisch, dass wir eine _validate() Funktion haben und ruft diese beim Absenden des Formulars (bevor die Werte gespeichert werden!) auf.
<?php
function onthisdate_admin_validate($form, &$form_state) {
$maxdisp = $form_state['values']['onthisdate_maxdisp'];
if (!is_numeric($maxdisp)) {
form_set_error('onthisdate_maxdisp', t('You must select a number for the maximum number of links.'));
}
else if ($maxdisp <= 0) {
form_set_error('onthisdate_maxdisp', t('Maximum number of links must be positive.'));
}
}
?>Wenn Du jetzt versuchst einen Wert einzugeben, der nicht in dieses Feld gehört (einen Text oder eine Zahl kleiner oder gleich 0), müsste eine Meldung erscheinen, die Dich auf den Fehler hinweist.
Siehe auch
- Anmelden oder Registrieren um Kommentare zu schreiben
Neue Kommentare
vor 3 Tagen 3 Stunden
vor 3 Tagen 9 Stunden
vor 3 Tagen 10 Stunden
vor 3 Tagen 10 Stunden
vor 3 Tagen 16 Stunden
vor 4 Tagen 6 Stunden
vor 4 Tagen 15 Stunden
vor 5 Tagen 18 Stunden
vor 6 Tagen 12 Stunden
vor 1 Woche 1 Tag