Desarrollo de módulos personalizados: creación de un esqueleto de módulo

Puede ampliar el sitio del Portal del desarrollador creando módulos personalizados. El punto de partida para un nuevo módulo es crear un esqueleto de módulo.

1. Elija un nombre abreviado, también conocido como nombre de máquina, para el módulo personalizado.
   El nombre de máquina se utiliza en varios archivos y funciones del módulo, así como en el núcleo Drupal para hacer referencia mediante programación al módulo. El nombre debe cumplir las reglas siguientes:

   • Debe comenzar por una letra.
   • Debe contener sólo letras en minúsculas y subrayados. (Tenga en cuenta que si se utilizan letras mayúsculas en el nombre, Drupal no reconocerá ninguna implementación de enganche en el módulo.)
   • No debe contener espacios.
   • Debe ser exclusivo en el sitio del Portal del desarrollador .
   • No debe ser ninguno de los siguientes términos reservados: src, lib, vendor, assets, css, files, images, js, misc, templates, includes, fixtures, Drupal.
2. Cree una carpeta de módulo en una ubicación de su elección, por ejemplo, /modules/module_name.
   No tiene que nombrar la carpeta con el mismo nombre que el nombre de la máquina del módulo, sin embargo, debe recordar utilizar el nombre de la máquina mediante programación dentro del código y los nombres de archivo del módulo.
3. Cree un archivo module_name.info.yml en la carpeta del módulo.
   Donde module_name es el nombre abreviado, o nombre de máquina, que ha elegido en el paso 1.
4. Inserte los metadatos para el módulo personalizado en el archivo module_name.info.yml como se indica a continuación:

   name: Example module name
   description: Description of the module.
   package: Custom
   
   type: module
   core: 8.x
   core_version_requirement: '^8 || ^9'
   version: 1.0
   
   dependencies:
     - module_name
   
   test_dependencies:
     - module_name
   
   configure: example.settings
   
   php: 7.1
   
   hidden: true

   donde

   • name (obligatorio) es el nombre del módulo y es el texto que se muestra en la página de administración del módulo en la interfaz de usuario del Portal del desarrollador .
   • description (opcional) es una descripción del módulo y es el texto que se muestra en la página de administración del módulo en la interfaz de usuario del Portal del desarrollador .
   • package (opcional) es una clave que le permite agrupar módulos similares.
   • type (obligatorio) es el tipo de extensión que está creando, por ejemplo, un módulo, tema o perfil. En esta instancia está creando un módulo.
   • core (opcional) especifica con qué versión principal de Drupal es compatible el módulo.
   • core_version_requirement (obligatorio) especifica con qué versiones de Drupal es compatible el módulo. Este ejemplo especifica que el módulo es compatible con todas las versiones de Drupal 8 y 9.
   • version (obligatorio) es el número de versión del módulo. Tenga en cuenta que version no es necesario si está publicando el módulo en Drupal.org.
   • dependencies (opcional) es una lista YAML de los módulos de los que depende el módulo. Deben tener un espacio de nombres con el formato module_name, donde nombre_módulo es el nombre de máquina del módulo.
   • test_dependencies (opcional) es una lista de los módulos (en el mismo formato que dependencies) que son necesarios para ejecutar determinadas pruebas automatizadas para el módulo en el ejecutor de pruebas automatizado de Drupal(DrupalCI), pero no son necesarios como dependencias de módulo en general.
   • configure (opcional), si el módulo ofrece un formulario de configuración, especifique aquí la ruta a este formulario.
   • php (opcional) es la versión mínima de PHP que se necesita para el módulo. Para el Portal del desarrollador , la versión mínima de PHP es 7.1.
   • hidden (opcional) es una opción que, si se establece, ocultará el módulo de la sección Ampliar del panel de control del administrador en la interfaz de usuario del Portal del desarrollador . Esta opción puede ser útil si el módulo sólo contiene pruebas, o si el módulo está pensado como ejemplo para otros desarrolladores.
5. Guarde el module_name.info.yml.

name: User field example
type: module
description: Developer Portal tutorial about a user field example
package: IBM API Connect Tutorials
core: 8.x
core_version_requirement: '^8 || ^9'
version: 8.x-0.0.1
dependencies:
  - ibm_apim
  - auth_apic