Skip to content

AppStructure

DevPGSV edited this page Jun 5, 2017 · 2 revisions

Estructura de la Aplicación

core

La carpeta core contiene la mayor parte del backend. Los archivos de esta carpeta tienen clases que representan objetos usandos en la aplicación.

El archivo hippocampus.md tiene la clase Hippocampus, la clas central que se ejecuta primero y carga el resto de elementos necesarios.

La clase Database (en db.php) se encarga de la conexión a la base de datos, y de las principales llamadas que se realizan comúnmente.

ModuleManager se encarga de cargar los módulos y administrarlos dinámicamente.

ThemeManager carga los temas dinámicamente, creando objetos de tipo Theme.

UserManager administra los usuarios. Comprueba si el usuario está logueado, y se guarda un objeto de tipo User si es así.

La clase Utils tiene funciones estáticas de utilidades que se pueden llamar desde cualquier lugar donde se necesiten.

En esta carpeta también está el archivo de configuración (config.php) con las credenciales de la base de datos.

img

En esta carpeta se situan las imagenes usadas en el proyecto.

lib

La carpeta lib es usada para almacenar las librerías externas necesarias para el proyecto, cuando hemos decidido descargarlas en vez de usar CDN. Los archivos de cada librería se situarán en una carpeta única.

modules

En esta carpeta están los módulos del proyecto, cada uno en una carpeta.

Para más información sobre la estructura de los módulos, consultar en: Módulos.

themes

La carpeta themes contiene los temas disponibles en la aplicación. Cada tema está en una carpeta única. Los temas deben tener un archivo config.php que indiquen las características de las que dispone, el nombre del tema, y una lista de código que se situará en las etiquetas <head> de la página.

tmp

Actualmente, esta carpeta contiene un dump de la base de datos, usado por el instalador durante la configuración inicial de la página.

Raíz del proyecto

En la raíz se encuentran los siguientes archivos:

  • index.php: archivo principal que carga y ejecuta Hippocampus
  • api.php: archivo usado para recibir y procesar las llamadas Ajax
  • .htaccess: dispone de las reglas necesarias para que se realicen las redirecciones a index.php