Documentación

  1. Bienvenida
  2. Instalación
  3. Configuración
  4. Comenzando
    1. Secciones
    2. Módulos
    3. Acciones
  5. API
    1. Core
      1. setTitle()
      2. setMetaDescription()
      3. setMetaKeywords()
      4. setStyle()
      5. setScript()
      6. loadModule()
      7. setSession()
      8. getSession()
      9. clearSession()
      10. setCurrentURL()
      11. getURL()
      12. redirect()
      13. setMessage()
      14. getMessage()
      15. cleanVar()
      16. pagerResults()
    2. Query
      1. query()
      2. select()
      3. delete()

Comenzando

Para empezar a construir tu primer sitio es importante entender la estructura y el funcionamiento general de SoulPHP. El primer paso es entender la estructura de archivos la cual está dividida de la siguiente manera:

  • actions/
  • classes/
  • images/
  • modules/
  • scripts/
  • sections/
  • styles/
  • templates/
  • index.php
  • configuration.php
  • .htaccess
  • robots.txt
  • sitemap.xml

Cada uno de los directorios y archivos anteriores tiene un motivo especial de ser, para poder explicar más fácilmente su objetivo, usaremos como ejemplo la construcción de un sitio web que ofrece juguetes y consta de 3 páginas:

  • Home o Inicio
  • Lista de Juguetes
  • Contacto

En este caso, el archivo index.php es quien se encarga de delegar todas las peticiones del sitio. Una petición puede llamar a una sección, a una acción o a un módulo.

Por defecto, cuando entramos a nuestro sitio de este manera http://www.misitio.com, SoulPHP cargará la sección que esté definida por default en el archivo configuration.php que por defecto es home.

Cuando necesitemos entrar a la sección contacto, ingresaremos la url http://www.misitio.com/contacto.

Imaginemos que en la sección de contacto deseamos colocar un formulario y que este envíe la información por correo electrónico a una cuenta determinada; para ello recurriremos a una acción, y la llamaremos así http://www.misitio.com/index.php?action=sendMail donde sendMail es un archivo php que se encuentra en la carpeta actions el cual validará los datos del formulario y ejecutará las instrucciones para hacer el envío del mensaje.

Si necesitaramos poner un formulario de contacto resumido en la sección de Home y/o Lista de Juguetes entonces podemos recurrir a un módulo, el cual nos permitirá generar un formulario más pequeño pero que podremos reutilizar las veces que sea en las secciones que deseemos. Cuando deseamos llamar a un módulo lo podemos hacer así http://www.misitio.com/index.php?module=contacto y este módulo usará la acción sendMail para procesar el envío o bien requerir su propia acción.

La carpeta classes almecena todas las clases que el sitio usará, aquí puedes colocar todas las clases que utlizarás, sin embargo también guarda clases esenciales de SoulPHP.

La carpeta images almacena las imágenes globales del sitio, como el logotipo, el fondo principal, el favicon, entre otras, pero no se deben almacenar las imágenes particulares de cada sección, pues para ello las secciones cuentan con su propia carpeta.

La carpeta de scripts almacena las librerías y archivos de javascript globales del sitio, por ejemplo jquery y modernizr, pero no se deben almacenar archivos particulares de una sección, pues para ello las secciones cuentan con su propia carpeta.

La carpeta styles almacena las hojas de estilo globales del sitio, por ejemplo la maquetación principal, pero no se deben almacenar hojas de estilo particulares de una sección, pues para ello las secciones cuentan con su propia carpeta.

La carpeta templates almacena la plantilla o plantillas globales del sitio, al igual que la hoja de estilo principal, aquí se define el maquetado principal, no se deben almacenar las plantillas de una sección, pues para ello las secciones cuentan con su propia carpeta.

Finalmente el archivo .htaccess es quien permite configurar las URL's amigables de nuestro sitio así como aportar algunos otros beneficios que permitirán al sitio mejorar el SEO. El archivo robots.txt y sitemap.xml ayudarán a los buscadores a rastrear de manera más eficiente nuestro sitio web.

Ahora que conoces el funcionamiento general de SoulPHP te sugerimos revisar con detalle la creación de Secciones, Módulos y Acciones.