2.2.1 Organización del Código
Open Populi Application Framework organiza el código fuente en una estructura estandarizada en forma de árbol. Básicamente, los desarrollos se organizan bajo los conceptos de plataforma, aplicaciones, módulos y acciones. El concepto de Plataforma nace a partir dela idea de "conjunto de aplicaciones, de alguna manera, relacionadas en pos de llevar soluciones a un determinado modelo de negocio".
Dentro de una plataforma las operaciones se agrupan en una estructura lógica llamada aplicación. Una o varias aplicaciones pueden ser parte de una plataforma(*). Cada aplicación está formada por uno o muchos módulos. Un modulo representa una página web o un conjunto de páginas webs relacionadas por un mismo propósito. En los módulos se definen las acciones que representan las operaciones que luego podrán ejecutarse en ese modulo.
Ejemplo:
- Organización del código siguiendo la estructura de plataforma / aplicación / modulo / acción
Por defecto, Open Populi Application Framework, contiene una plataforma inicial que incorpora una aplicación denominada Security. Dicha aplicación tiene como objetivo, la gestión de autenticación de usuarios a una plataforma. Vease la sección: 4.1 SeguridadEstructura de la raíz de la plataforma
El directorio raíz de cualquier plataforma desarrollada con Open Populi Application Framework tendrá:
- apps
- Contiene un directorio por cada aplicación del proyecto.
- config
- contiene los archivos de configuración de la plataforma. Se encontrará un archivo config.ini(configuraciones generales), view.ini (configuraciones para la vista) y routes.ini.php (rutas personalizadas).
- logs
- Se almacena el archivo de log de la plataforma.
- model
- Contiene las clases para manejar los modelos correspondientes a una plataforma.
- templates
- Contiene las plantillas globales de la plataforma, las que utilizan todas las aplicaciones. El layout principal con el que se muestran las plantillas de los módulos se llamará miPlataforma.tpl.php. Ademas contiene recursos como estilos(css), javascripts(js) y las imágenes(jpg, gif, png) de la plataforma.
- public
- El directorio public contiene los recursos propios de Open Populi Application Framework, estilos(css), javascripts(js) e imágenes (jpg, gif, png).
Estructura de una aplicación
Dentro del directorio apps se monta la estructura de las aplicaciones:
- actions
- Contiene un archivo llamado actions.class.php, que es donde se define la clase que implementa todas las acciones que se pueden ejecutar de un modulo. Eventualmente podrá contener algún componente definido en la plataforma. Los componentes serán definidos en el archivo components.class.php.
- templates
- Contiene las plantillas correspondientes a las acciones del modulo.
Estructura clases de Open Populi Application Framework
Estructura de directorios de las clases que conforman a Open Populi Application Framework.
-----
«««
Estructura de la plataforma OP |
Convenciones »»»