Com crear un mòdul custom amb l'assistent de Drush: Drush module generator

Mai us ha passat que heu necessitat afegir una funcionalitat addicional al vostre lloc web i no heu sabut per on començar? La clau de tot plegat és crear un mòdul custom, però per als més nous en el món de Drupal pot semblar una mica complicat si hom no sap l'estructura que aquests mòduls han de seguir. Doncs bé, en aquest tutorial ens endinsarem en les entranyes de Drush, una eina que ens ajudarà, i molt, en aquesta tasca.

Primer de tot, caldrà tenir instal·lat Drush al vostre lloc web. Si fem servir la terminal de comandes i tenim instal·lat el nostre Drupal amb Composer, serà tan fàcil com executar aquesta comanda:

composer require drush/drush

Un cop tenim drush habilitat, farem servir l'assistent de Drush, anomenat Drupal Code Generator per a la generació d'un mòdul custom:

drush gen module

Arribats a aquest punt, ens canviarà el prompt de la terminal, i haurem d'anar responent a les preguntes del assitent:

A la imatge sobre aquestes línies es mostra tot el procés que haureu de seguir amb l'assitent. Les preguntes que us farà es faran servir per a la creació del vostre mòdul custom. Repassem-les en detall:

• Module name: Aquí haureu d'indicar el nom del vostre mòdul, en aquest cas l'hem anomenat Example module. Podreu indicar quasi qualsevol cosa (accepta espais en blanc i d'altres caràcters), i serà el nom que es mostrarà a la pàgina d'administració de mòduls del vostre Drupal, a /admin/modules.
• Module machine name: Aquest serà el nom del sistema pel que fa al vostre mòdul, i serà emprat també per a la creació de la carpeta corresponent. En aquest cas, però, haureu de ser més curosos i emprar només minúscules i guions baixos per a anomenar el vostre mòdul. Una altra consideració important és que el nom ha de ser únic, i en aquest sentit haureu d'assegurar-vos que no existeixi cap mòdul amb el nom escollit. Un possible solució podria ser l'utilització d'un prefix, com ara "my_" resultant en my_modulename o fer servir el nom del projecte, per exemple: "site_" resultant en quelcom de l'estil site_modulename.
• Package: Serveix per classificar el vostre mòdul en alguna categoria, a la pàgina d'administració de mòduls del vostre Drupal, a /admin/modules. Generalment podeu deixar-ho amb el valor Custom que us proposa l'assistent.
• Dependencies (comma separated): Serveix per indicar si el vostre mòdul depèn d'un altre mòdul que ha d'estar instal·lat prèviament al vostre lloc. Si, per exemple, el vostre necessita del mòdul Views per a funcionar, podeu indicar core:views (seguint la convenció project:module). Si el vostre mòdul no té cap dependència declarada, ho podeu deixar en blanc.
• Would you like to create module file?: Aquí us està preguntant si voleu que us assiteixi per a la creació d'un fitxer amb l'extensió .module. Generalment aquest fitxer es fa servir per a la declaració de hooks en el vostre mòdul, però no és obligatori, donat que el vostre mòdul pot constar d'un formulari, d'un controlador o un servei, sense necessitar de cap hook per al seu funcionament. Si no ho necessiteu, ho podeu deixar en blanc.
• Would you like to create install file?: Aquí us està preguntant si voleu que us assiteixi per a la creació d'un fitxer amb l'extensió .install. En aquest fitxer generalment implementarem tasques a executar durant l'activació o desactivació del vostre mòdul o bé la creació de taules a la base de dades amb la Schema API.
• Would you like to create README.md file?: Com a darrer pas, i de manera totalment opcional l'assitent ens preguntarà si volem crear un arxiu de documentació anomenat README.md. Si bé no és obligatori, sí que és una bona idea documentar els aspectes més rellevants del vostre mòdul, com ara el propòsit, funcionalitats, instruccions d'ús, etc.

Com heu pogut veure en aquest tutorial, la creació d'un mòdul custom amb Drush és una tasca d'allò més senzilla, que es fa en qüestió de segons. Ara només cal posar-se a programar les funcionalitats requerides.

Si necessiteu ajuda en la programació del vostre mòdul custom o necessiteu una funcionalitat feta a mida en el vostre Drupal, no dubteu a contactar amb nosaltres, us ajudarem encantats en tot el que us calgui.