Tvorba souboru .module

Soubor .module je soubor jazyka PHP, jenž běžně obsahuje implementace hlavních háčků modulu. Háčky jsme si důkladně popsali dříve. Teď o nich získáte nějaké praktické znalosti.

Implementace háčku je funkce, jež se řídí určitým vzorem pojmenování a slouží jako funkce zpětného volání pro některé události v systému Drupal. Programátoři řídící se principy objektově orientovaného programování si pravděpodobně spojí háčky s návrhovým vzorem Pozorovatel.

Když v Drupalu vznikne událost, pro niž existuje háček (a takových událostí existují tisíce), Drupal vyhledá odpovídající implementace háčků ve všech modulech. Následně spustí implementace háčků jednu po druhé. Jakmile provede všechny implementace háčků, pokračuje v dalším zpracování.

V minulosti se musely všechny implementace háčků Drupalu nacházet v souboru .module. Požadavky systému Drupal 7 jsou shovívavější, ale u menších modulů je vhodnější ukládat většinu implementací háčků do souboru .module.

<?php
// $Id$
/**
* @file
* Modul osvětlující postupy při programování v Drupalu a rozhraní API.
*
* Tento modul nabízí blok se seznamem všech nainstalovaných modulů.
* Demonstruje programovací standardy, postupy a rozhraní API pro
* práci se systémem Drupal 7.
*/
/**
* Implementuje háček hook_help().
*/
function first_help($path, $arg) {
if ($path == 'admin/help#first’) {
return t('Ukázkový modul.‘);
}
}

Než se dostaneme k samotnému kódu, popíšeme si několik stylistických rad. Všimněte si, že tento soubor obsahuje značku $Id$ stejně jako soubor .info. Tuto značku nahradí systém CVS při nahrávání souboru do něj. Všechny soubory PHP by měly obsahovat tuto značku ve vloženém komentáři začínajícím dvěma lomítky: // $Id$. Výše uvedený zdrojový kód představuje pár důležitých programovacích standardů pro Drupal.

Sdílejte, pokud vám to k něčemu bylo :)