Cms

Contiene todo tipo de librerías de uso común entre las aplicaciones. Actualmente, estas librerías son las siguientes:

libraries/

Contiene las librerías del lado del servidor, es decir, las librerías PHP.

plugins/

Contiene funciones encargadas de modificar el flujo de salida. Por lo general, son utilizadas para que la salida de una extensión sea enriquecida por el aporte de otras extensiones.

scripts/

Contiene las librerías y recursos del lado del cliente, es decir, todo lo que no sea PHP, por ejemplo: css, javascript, imágenes, tipografías, pre-procesadores de hojas de estilos, etc.

snippets/

Contiene clases que generan dinámicamente una porción de html, como ser: un formulario, una lista o un paginador.

Librerías

Contiene las librerías del lado del servidor, es decir, las librerías PHP.

Las librerías están agrupadas por la extensión a las que pertenecen. Por lo tanto, si observamos dentro de la carpeta cms/libraries/, podemos ver algo similar a:

En cada una de esas carpetas, las librerías deberán ser nombradas comenzando con el nombre de la extensión, por ejemplo «cms/libraries/settings/Settings.php».

Plugins

Contiene funciones encargadas de modificar el flujo de salida. Por lo general, son utilizadas para que la salida de una extensión sea enriquecida por el aporte de otras extensiones.

La organización de las carpetas tiene tres niveles, esto es así para lograr generar código intercambiable. Los niveles corresponden a:

1. El nombre de la extensión.
2. El nombre del plugin.
3. El nombre de la alternativa de plugin. Este nivel le permite a una extensión proponer muchas alternativas de un mismo plugin.

La ruta completa a un plugin estará dada por:

cms/plugins/{{extension_alias}}/{{plugin_name}}/{{alter_plugin}}/{{plugin_name}}.{{plugin_hook}}.php

Como podemos observar, el nombre del archivo que contiene el plugin también tiene su convención.

Los ganchos (hooks)

Dentro de un plugin, es posible que debamos ejecutar varias tareas, para ello declaramos varios archivos con un hook diferente para cada uno de ellos. Por ejemplo, si definimos un editor bbcode para un formulario, debemos considerar el hook para cargar el editor en dicho formulario y un hook para procesar el contenido del editor.

Scripts

Contiene las librerías y recursos del lado del cliente, es decir, todo lo que no sea PHP, por ejemplo: css, javascript, imágenes, tipografías, pre-procesadores de hojas de estilos, etc.

Las librerías están agrupadas por la extensión a las que pertenecen. Por lo tanto, si observamos dentro de la carpeta cms/scripts/, podemos encontrar algo similar a:

Dentro de cada extensión, no hay convenciones, aunque es una buena práctica separar el código según su tipo: css/, font/, js/, sass/, etc.

Fragmentos

Contiene clases que generan dinámicamente una porción de html, como ser: un formulario, una lista o un paginador. Su estructura de tres niveles, similar a la de plugins, tiene como fin generar fragmentos intercambiables entre sí.

Los tres niveles corresponden a:

1. El nombre de la extensión.
2. El nombre del fragmento.
3. El nombre de la alternativa al fragmento. Este nivel le permite a una extensión proponer muchas alternativas de un mismo fragmento.

La ruta completa a un fragmento estará dada por:

cms/snippets/{{extension_alias}}/{{snippet_name}}/{{alter_snippet}}/snippet.php

La alternativa por defecto para los fragmentos será master.