Das Drupal- Entwicklerhandbuch

Transkript

1 JohnK.VanDyk Das Drupal- Entwicklerhandbuch Der Praxisleitfaden für Drupal-basierte Webprojekte / ADDISON-WESLEY An imprint of Pearson Education München Boston San Francisco Harlow, England Don Mills, Ontario Sydney Mexico City Madrid Amsterdam

2 Über den Autor 25 Über die Fachlektoren 27 Einleitung 29 Danksagungen 31 1 So funktioniert Drupal Was ist Drupal? Die Systemarchitektur Der Core Die Verwaltungsoberfläche Module Hooks Themes Nodes Blöcke Dateilayout Ein Drupal-Seitenaufruf Die Rolle des Webservers Der Bootstrap-Prozess Eine Anforderung verarbeiten Daten mit Themes versehen Zusammenfassung 44 2 Ein Modul schreiben Die Dateien erstellen Einen Hook implementieren Modulspezifische Einstellungen hinzufügen Das Formular zur Dateneingabe hinzufügen Daten in einer Datenbanktabelle speichern Den eigenen Verwaltungsabschnitt definieren Dem Benutzerein Formular mit Einstellungen anzeigen Vom Benutzer übermittelte Einstellungen prüfen 66

3 2.8 Einstellungen speichern Verwenden der Drupal-Tabelle variables Abrufen von gespeicherten Werten mit variable_geto Weitere Schritte Zusammenfassung 69 3 Hooks, Aktionen und Trigger Grundlagen von Ereignissen und Triggern Grundlagen von Aktionen Die Benutzeroberfläche für Trigger Eine erste Aktion Zuweisen der Aktion j-/ Ändern der von einer Aktion unterstützten Trigger Aktionen, die alle Trigger unterstützen Erweiterte Aktionen Den Kontext für Aktionen verwenden Wie das Trigger-Modul den Kontext vorbereitet Einrichten des Kontextes Untersuchen des Kontextes Wie Aktionen gespeichert werden Die Tabelle actions Aktions-IDs Eine Aktion direkt mit actions_do() aufrufen Eigene Trigger mit hookjiookjnfoo definieren Trigger zu bestehenden Hooks hinzufügen Zusammenfassung 96 4 Das Menüsystem Callback-Zuordnung URLs zu Funktionen zuordnen Seitencallback-Argumente Menüs verschachteln Zugriffssteuerung Titellokalisierung und Anpassung Einen Titelcallback definieren Titelargumente 112 8

4 4.5 Platzhalter in Menüelementen Einfache Platzhalter Platzhalter und Seitencallback-Parameter Den Wert eines Platzhalters verwenden Platzhalter- und Parameterersetzung Mit to_argo-funktionen Pfade aus Platzhaltern erstellen Menüelemente von anderen Modulen ändern Menülinks von anderen Modulen ändern Arten von Menüelementen Häufige Aufgaben Callbacks ohne Hinzufügen eines Links zuweisen Menüelemente als Registerkarten anzeigen Menüelemente verbergen menu.module verwenden Häufige Fehler Zusammenfassung Mit Datenbanken arbeiten Datenbankparameter definieren Grundlagen der Datenbankabstraktionsschicht Verbindungen zur Datenbank Einfache Abfragen durchführen Abfrageergebnisse abrufen Einen einzelnen Wert abrufen Mehrere Zeilen abrufen Das Ergebnis einschränken Ergebnisse seitenweise anzeigen Die Schema-API install-Moduldateien verwenden Tabellen erstellen Das Schema-Modul verwenden Feldtypzuordnung zwischen Schema und Datenbank Deklarieren eines Spaltentyps mit mysqltype Tabellen pflegen Tabellen beim Deinstallieren löschen Vorhandene Schemas mit hook_schema_altero löschen Einfüge- und Aktualisierungsvorgänge mit drupal_write_record() 148 9

5 5.8 Abfragen mit hook_db_rewrite_sql() für andere Module ermöglichen hook_db_rewrite_sqlo verwenden Abfragen anderer Module ändern Verbindungen mit mehreren Datenbanken in Drupal Eine temporäre Tabelle verwenden Einen eigenen Datenbanktreiber schreiben Zusammenfassung Mit Benutzern arbeiten Das Objekt $user Daten in $user speichern Ist der Benutzer angemeldet? Einführung in hook_user() Grundlagen von hook_user (View') Die Benutzerregistrierung Benutzerinformationen mit profile.module erfassen Der Anmeldevorgang Daten zur Ladezeit zu $user hinzufügen Kategorien für Benutzerinformationen bereitstellen Externe Anmeldung Einfache externe Authentifizierung Zusammenfassung Mit Nodes arbeiten Was genau ist ein Node? Nicht alles ist ein Node Ein Node-Modul erstellen Die.install-Datei erstellen Die.info-Datei erstellen Die.module-Datei erstellen Informationen über unseren Node-Typ bereitstellen Den Menücallback ändern Berechtigungen für den Node-Typ mit hook_permo definieren Zugriff auf einen Node-Typ mit hook_accessfj einschränken Das Node-Formular für den Node-Typ anpassen Unterstützung für Filterformate hinzufügen Felder mit hook validatefj validieren

6 Daten mit hookjnserto speichern Daten mit hook_updateo auf dem neuesten Stand halten Aufräumen mit hook_deletefj Nodes eines Typs mit hookjoadfj ändern Und nun die Pointe: hook_viewo Nodes eines fremden Typs mit hook_nodeapio bearbeiten Wie Nodes gespeichert werden Node-Typen mit CCK erstellen Den Zugriff auf Nodes einschränken Node-Rechte definieren Zugriff auf Nodes J Zusammenfassung Das Theme-System Komponenten des Theme-Systems Template-Sprachen und Theme-Engines Themes Ein Theme installieren Ein PHP-Template-Theme erstellen Vorhandene HTML- und CSS-Dateien verwenden Eine.info-Datei für das Theme erstellen Grundlagen von Template-Dateien Überblick Für Themes geeignete Elemente überschreiben Überschreiben mit Template-Dateien Template-Variablen hinzufügen und bearbeiten Variablen für alle Templates page.tpl.php node.tpl.php block.tpl.php comment.tpl.php box.tpl.php Weitere tpl.php-dateien Templates mit mehreren Seiten Erweiterte Theme-Gestaltung in Drupal Die Theme-Registry Eine ausführliche Beschreibung von themefj

7 8.5.3 Neue Blockregionen definieren Drupal-Formulare mit Themes versehen Das Theme-Developer-Modul verwenden Zusammenfassung Mit Blöcken arbeiten Was ist ein Block? Optionen zur Btockkonfiguration Platzierung von Blöcken Einen Block definieren Blöcke mit Themes versehen Einen Block-Hook verwenden Einen Block aufbauen Bonusbeispiel: Einen Block für noch nicht aktivierte Benutzerkonten hinzufügen Einen Block während der Installation eines Moduls aktivieren Beispiele für die Sichtbarkeit von Blöcken Einen Block nur für angemeldete Benutzer anzeigen Einen Block nur für anonyme Benutzer anzeigen Zusammenfassung Die Formular-API Grundlagen der Formularverarbeitung Den Vorgang initialisieren Ein Token festlegen Eine ID festlegen Definitionen aller möglichen Formularelemente erfassen Eine Validierungsfunktion suchen Eine Übermittlungsfunktion suchen Das Formular vor dem Aufbau durch Module ändern lassen Das Formular aufbauen Das Formular nach dem Aufbau durch Funktionen ändern lassen Die Übermittlung des Formulars prüfen Eine Theme-Funktion für das Formular finden Das Formular vor dem Rendern durch Module ändern lassen Das Formular rendern Das Formular validieren

8 Das Formular übertragen Den Benutzer umleiten Einfache Formulare erstellen Formulareigenschaften Formular-IDs Feldgruppen Formulare mit Themes versehen Validierungs- und Übermittlungsfunktionen mit hook_formso festlegen Die Aufrufreihenfolge von Theme-, Validierungs- und Übermittlungsfunktionen Eine Validierungsfunktion schreiben Das Formular neu aufbauen Eine Übermittlungsfunktion schreiben Formulare mit hook_form_altero ändern Formulare programmgesteuert mit drupalexecuteo übertragen Mehrseitige Formulare Eigenschaften der Formular-API Eigenschaften für den Formularstamm Zu allen Elementen hinzugefügte Eigenschaften l n allen Elementen zugelassene Eigenschaften Formularelemente Die Eigenschaft #ahah Zusammenfassung Benutzereingaben bearbeiten: Das Filtersystem Filter Filter und Eingabeformate Einen Filter installieren Wann sind Filter notwendig? Einen benutzerdefinierten Filter erstellen hook_filtero implementieren Die Operation list Die Operation description Die Operation settings Die Operation no cache Die Operation prepare Die Operation process Die Operation default hook_filter_tipso

9 11.4 Schutz gegen potenziell gefährliche Daten Zusammenfassung Inhalte durchsuchen und indizieren Eine benutzerdefinierte Suchseite erstellen Das standardmäßige Suchformular Das erweiterte Suchformular D as Suchformular erweitern Den HTML-Indexer für die Suche verwenden Wann ist der Indexer geeignet? Die Funktionsweise des Indexers Zusammenfassung Mit Dateien arbeiten Wie Drupal Dateien bereitstellt Öffentliche Dateien Private Dateien PHP-Einstellungen Umgang mit Medien Das Upload-Modul Andere generische Module zur Dateiverarbeitung Bilder und Bildergalerien Video und Audio Die Datei-API Das Datenbankschema Häufige Aufgaben und Funktionen Authentifizierungshooks für den Download Zusammenfassung Mit Taxonomien arbeiten Was ist eine Taxonomie? Begriffe Vokabulare Arten von Taxonomien Flach Hierarchisch Mehrfach hierarchisch

10 14.3 Inhalte nach Begriffen anzeigen AND und OR in URLs verwenden Die Tiefe für hierarchische Vokabulare angeben Automatische RSS-Feeds Taxonomien speichern Modulgestützte Vokabulare Ein modulgestütztes Vokabular erstellen Benutzerdefinierte Pfade für Begriffe bereitstellen Mit hook_taxonomyo über Vokabularänderungen informiert bleiben Häufige Aufgaben Taxonomiebegriffe in einem Knotenobjekt finden Eigene Taxonomieabfragen erstellen Taxonomiefunktionen Informationen über Vokabulare abrufen Vokabulare hinzufügen, ändern und löschen Informationen über Begriffe abrufen Begriffe hinzufügen, ändern und löschen Informationen über die Begriffshierarchie abrufen Informationen über Begriffssynonyme abrufen Nodes mit bestimmten Begriffen finden Weitere Quellen Zusammenfassung Caching Wann muss zwischengespeichert werden? Wie Caching funktioniert Caching im Drupal-Core Das Menüsystem Gefilterte Eingabeformate Verwaltungsvariablen und Moduleinstellungen Seiten Blöcke Abfrageweises Caching mit statischen Variablen Die Cache-API verwenden Zusammenfassung

11 16 Sitzungen (Sessions) Was sind Sitzungen? Verwendung Einstellungen für Sitzungen In.htaccess In settings.php In bootstrap.ine Die Verwendung von Cookies erzwingen Speicherung Lebenszyklus von Sitzungen Konversationen in Sitzungen Erster Besuch Zweiter Besuch Benutzer mit einem Konto Häufige Aufgaben Die Gültigkeitsdauer eines Cookies verlängern Den Namen der Sitzung ändern Daten in der Sitzung speichern Zusammenfassung jquery Was ist jquery? Die herkömmliche Vorgehensweise So funktioniert jquery Einen CSS-ID-Selektor verwenden Einen CSS-Klassenselektor verwenden jquery in Drupal Ein erstes Codebeispiel mit jquery Ein Element über die ID ansprechen Methodenverkettung Klassen hinzufügen und entfernen Vorhandene Elemente mit einem Wrapper versehen Die Werte von CSS-Elementen ändern Wohin mit dem JavaScript-Code? Überschreibbarer JavaScript-Code

12 17.5 Ein Abstimmungs-Widget mit jquery erstellen Das Modul erstellen Drupal.behaviors verwenden Erweiterungsmöglichkeiten für dieses Modul Kompatibilität Die nächsten Schritte Zusammenfassung Lokalisierung und Übersetzung Das Locale-Modul aktivieren Übersetzung der Benutzeroberfläche Strings Strings mit tfj übersetzen Eingebaute Strings durch benutzerdefinierte ersetzen Eine neue Übersetzung beginnen pot-Dateien für Drupal herunterladen pot-Dateien mit dem Translation Template Extractor erstellen Eine Übersetzung installieren Eine Übersetzung zur Installationszeit einrichten Eine Übersetzung auf einer bestehenden Site installieren Unterstützung für von rechts nach links geschriebene Sprachen Sprachaushandlung Keine Nur Pfadpräfix Pfadpräfix mit Ausweichsprache Nur Domain-Name Übersetzung des Inhalts Einführung in das Modul zur Inhaltsübersetzung Unterstützung für mehrere Sprachen Unterstützung für mehrere Sprachen mit Übersetzung Dateien für Lokalisierung und Übersetzung Weitere Quellen Zusammenfassung XML-RPC Was ist XML-RPC? Voraussetzungen für XML-RPC

13 19.3 XML-RPC-Ciients Ein Beispiel für einen XML-RPC-Client: Die Uhrzeit abrufen Ein Beispiel für einen XML-RPC-Client: Den Namen eines Bundesstaats abrufen Vorgehensweise bei XML-RPC-Clientfehlern Parametertypen umwandeln Ein einfacher XML-RPC-Server Die Methode mit hook_xmlrpco zuordnen Automatische Validierung von Parametertypen mit hook_xmlrpco Eingebaute XML-RPC-Methoden system.listmethods system.methodsignature 519!9-5-3 system.methodhelp system.getcapabilities system.multicall Zusammenfassung Sicheren Code schreiben Benutzereingaben handhaben Überlegungen zu Datentypen Gesunde Ausgaben mit check_plaino und tfj Mit filter_xsso Angriffe durch siteübergreifendes Scripting verhindern filter_xss_admino verwenden URLs sicher handhaben Abfragen mit db_queryo sicher gestalten Private Daten mit db_rewrite_sqlo schützen Dynamische Abfragen Berechtigungen und Seitencallbacks Cross-Site Request Forgery (CSRF) Dateisicherheit Dateiberechtigungen Geschützte Dateien Dateiuploads Dateinamen und Pfade Mailheader verschlüsseln Dateien für Produktionsumgebungen

14 20.10 cron.php schützen SSL-Unterstützung Eigenständiges PHP AJAX-Sicherheit Sicherheit in der Formular-API Das Superuser-Konto schützen evalo verwenden Zusammenfassung Bewährte Vorgehensweisen in der Entwicklung Standards für die Programmierung Zeileneinzug Öffnende und schließende Tags in PHP Steuerstrukturen Funktionsaufrufe Funktionsdeklarationen Funktionsnamen Arrays Konstanten Globale Variablen Modulnamen Dateinamen PHP-Kommentare Beispiele zur Dokumentierung Konstanten dokumentieren Funktionen dokumentieren Hookimplementierungen dokumentieren Den Programmierstil per Programm überprüfen code-style.pl verwenden Das Coder-Modul verwenden Orientierung im Code mit egrep Die Vorteile der Versionssteuerung nutzen CVS-fähiges Drupal installieren CVS-fähiges Drupal verwenden Einen CVS-Client installieren Drupal in CVS auschecken Zweige und Tags

15 Code mit CVS aktualisieren Änderungen im Drupal-Code nachverfolgen CVS-Konflikte lösen Kerncode sauber ändern Patches erstellen und anwenden Einen Patch anwenden Ein Modul warten Ein Drupal-CVS-Konto einrichten Das Beitragsrepository auschecken Eigene Module zum Repository hinzufügen Der Anfangscommit Das eigene Modul auschecken Ein Projekt auf drupal.org erstellen Commit eines Bugfix Den Verlauf einer Datei anzeigen Einen Zweig erstellen Einen Drupal-6-kompatiblen Zweig erstellen Erweiterte Verzweigung Einen Release-Node erstellen SVN mit CVS für die Projektverwaltung kombinieren Code testen und entwickeln Das Devel-Modul Abfragen anzeigen Zeitintensive Abfragen Andere Anwendungen für das Devel-Modul Das Modul-Builder-Modul Profilerstellung für Anwendungen und Debugging Zusammenfassung Drupal optimieren Engpässe finden Eine erste Untersuchung Andere Formen der Webserveroptimierung Datenbankengpässe Drupal-spezifische Optimierungen Seitencaching Bandbreitenoptimierung

16 Die Sitzungstabelle aufräumen Den Datenverkehr authentifizierter Benutzer verwalten Fehlerprotokolle straffen cron ausführen Automatische Drosselung Architekturen Einzelner Server Eigener Datenbankserver Eigenständiger Datenbankserver und Webservercluster Mehrere Datenbankserver Zusammenfassung Installationsprofile Der Speicherort der Profile Funktionsweise von Installationsprofilen Die zu aktivierenden Module angeben Zusätzliche Installationsaufgaben definieren Zusätzliche Installationsaufgaben ausführen Quellen Zusammenfassung 654 A Referenz zu Datenbanktabellen 655 Ал access (User-Modul) 655 A.2 accesslog (Statistics-Modul) 656 A.3 actions (Trigger-Modul) 656 A.4 actions_aid (Trigger-Modul) 657 A.5 aggregator_category (Aggregator-Modul) 657 A.6 aggregator_category_feed (Aggregator-Modul) 657 A-7 aggregator_category_item (Aggregator-Modul) 658 A.8 aggregator_feed (Aggregator-Modul) 658 A.9 aggregatorjtem (aggregator-modul) 659 Ало authmap (User-Modul) 659 A.11 batch (batch.ine) 660 A.12 blocks (Block-Modul) 660 A.13 blocks_roles (Block-Modul) 662 A.14 book (Book-Modul)

17 A.15 boxes (Block-Modul) 662 A.16 cache 663 A.17 cache_block (Block-Modul) 663 A.18 cache_filter (Filter-Modul) 664 A.19 cache_form 664 A.20 cachejnenu 665 A.21 cache_page 665 A.22 cache_update 666 A.23 comments (Comment-Modul) 666 A.24 contact (Contact-Modul) 667 A.25 files (Upload-Modul) 668 A.26 filter_formats (Filter-Modul) 668 A.27 filters (Filter-Modul) 669 A.28 flood (Contact-Modul) 669 A.29 forum (Forum-Modul) 669 A.30 history (Node-Modul) 670 A.31 languages (Locale-Modul) 670 A.32 locales_source (Locale-Modul) 671 A.33 locales_target (Locale-Modul) 671 A.34 menu_custom (Menu-Modul) 672 A.35 menujinks (Menu-Modul) 672 A.36 menu_router 674 A.37 node (Node-Modul) 676 A.38 node_access (Node-Modul) 677 A.39 node_comment_statistics (Comment-Modul) 677 A.40 node_counter (Statistics-Modul) 678 A.41 node_revisions (Node-Modul) 678 A.42 node_type (Node-Modul) 679 A.43 openid_association (Openid-Modul) 680 A.44 permission (User-Modul) 680 A.45 poll (Poll-Modul) 681 A.46 pollchoices (Poll-Modul) 681 A.47 pollvotes (Poll-Modul) 681

18 A.48 profilejields (Profile-Modul) 682 A.49 profile_values (Profile-Modul) 683 A.50 role (User-Modul) 683 A.51 search_dataset (Search-Modul) 683 A.52 search_index (Search-Modul) 684 A.53 search_node_links (Search-Modul) 684 A.54 search_total (Search-Modul) 684 A.55 sessions 685 A.56 system 685 A.57 term_data (Taxonomy-Modul) 686 A.58 term_hierarchy (Taxonomy-Modul) 687 A.59 term_node (Taxonomy-Modul) 687 A.60 term_relation (Taxonomy-Modul) 687 A.61 term^synonym (Taxonomy-Modul) 688 A.62 trigger_assignments (Trigger-Modul) 688 A.63 upload (Upload-Modul) 688 A.64 url_alias (Path-Modul) 689 A.65 users (User-Modul) 689 A.66 users_roles (users) 690 A.67 variable 691 A.68 vocabulary (Taxonomy-Modul) 691 A.69 vocabulary_node_types (Taxonomy-Modul) 692 A.70 watchdog (Dblog-Modul) 692 В Quellen 693 B.i Code 693 B.1.1 Drupal-CVS 693 B.1.2 Drupal-API-Referenz 693 B.1.3 Sicherheitsratschläge 693 B.1.4 Module aktualisieren 694 B.1.5 Themes aktualisieren 694 B.2 Handbücher 694 B.3 Foren

19 B.4 Mailinglisten 695 B.4.1 development documentation drupal-cvs infrastructure support themes 695 В.4-7 translations 696 В.4-8 webmasters CVS-applications consulting Benutzer- und Interessengruppen Internet Relay Chat #drupal-support #drupal-themes #drupal-ecommerce #drupal #drupal-dev #drupal-consultants #drupal-dojo Videocasts 698 B.8 Weblogs 698 B.8.1 Planet Drupal 698 B.9 Konferenzen 698 B.10 Eigene Beiträge 699 Stichwortverzeichnis