File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	Teo MVC Framework with configurable routes and filters
Author:	By Alfredo Rodriguez
Last change:
Date:	2 years ago
Size:	`7,687 bytes`

Download

Acerca de TEO Simple PHP Framework

TEO es un Framework en PHP para construir aplicaciones Web y Sitios Web. Es gratis y open-source.

Este proyecto esta basado en MVC <a href="https://github.com/daveh/php-mvc">daveh/php-mvc</a>

Iniciar usando el framework

Primero, instale el proyecto con composer create-project jarscr/teo app-ejemplo.
Ejecuta composer update para instalar las dependecias.
Configure el servidor web para que apunte a la carpeta public como web root.
Abra App/Config.php y ingrese los datos de conexi�n con la base de datos.
Crea rutas, agrega controladores, vistas y modelos.

Revisa las instrucciones para que puedas usar este framework.

Configuraci�n

Configuration settings are stored in the App/Config.php class. Default settings include database connection data and a setting to show or hide error detail. You can access the settings in your code like this: Config::DB_HOST. You can add your own configuration settings in here.

Rutas

Las Rutas traduce las URL en controladores y acciones. Las rutas se agregan en el controlador. Se incluye una ruta de inicio de muestra que se enruta a la acci�n index en el controlador de home.

Las rutas se agregan con el m�todo add. Puede agregar rutas URL fijas y especificar el controlador y la acci�n, as�:

$router->add('', ['controller' => 'Home', 'action' => 'index']);
$router->add('posts/index', ['controller' => 'Posts', 'action' => 'index']);

O puede agregar variables de ruta, as�:

$router->add('{controller}/{action}');

Adem�s de controller y action, puede especificar cualquier par�metro que desee entre llaves y tambi�n especificar una expresi�n regular personalizada para ese par�metro:

$router->add('{controller}/{id:\d+}/{action}');

Tambi�n puede especificar un espacio de nombres para el controlador:

$router->add('admin/{controller}/{action}', ['namespace' => 'Admin']);

Controladores

Los controladores responden a las acciones del usuario (hacer clic en un enlace, enviar un formulario, etc.). Los controladores son clases que ampl�an la clase Core\Controller.

Los controladores se almacenan en la carpeta App/Controllers. Se incluye una muestra de Home controller. Las clases de controlador deben estar en el espacio de nombres App/Controllers. Puede agregar sub directorios para organizar sus controladores, por lo que al agregar una ruta para estos controladores, debe especificar el espacio de nombres (consulte la secci�n de enrutamiento anterior).

Las clases de controlador contienen m�todos que son las acciones. Para crear una acci�n, agregue el sufijo Action al nombre del m�todo. El controlador de muestra en App/Controllers/Home.php tiene una acci�n "index" de muestra.

Puede acceder a los par�metros de ruta (por ejemplo, el par�metro id que se muestra en los ejemplos de ruta anteriores) en acciones a trav�s de la propiedad $ this->route_params.

Action filters

Los controladores pueden tener m�todos de filtrado before y after. Estos son m�todos que se llaman antes y despu�s de cada llamada al m�todo de acci�n en un controlador. �til para la autenticaci�n, por ejemplo, asegurarse de que un usuario haya iniciado sesi�n antes de permitirle ejecutar una acci�n. Opcionalmente, agregue un antes del filtro a un controlador como este:

/
 * Before filter. Return false to stop the action from executing.
 *
 * @return void
 */
protected function before()
{
}

Para detener la ejecuci�n de la acci�n llamada originalmente, devuelve false del m�todo de filtro anterior. Se agrega un filtro posterior as�:

/
 * After filter.
 *
 * @return void
 */
protected function after()
{
}

Vistas

Las vistas se utilizan para mostrar informaci�n (normalmente HTML). Los archivos de visualizaci�n van en la carpeta App/Views. Las vistas pueden estar en uno de dos formatos: PHP est�ndar, pero con PHP suficiente para mostrar los datos. Ning�n acceso a la base de datos ni nada parecido deber�a ocurrir en un archivo de vista. Puede representar una vista PHP est�ndar en un controlador, opcionalmente pasando variables, como esta:

View::render('Home/index.php', [
    'name'    => 'Dave',
    'colours' => ['red', 'green', 'blue']
]);

El segundo formato utiliza el motor de plantillas Twig. El uso de Twig le permite tener plantillas m�s simples y seguras que pueden aprovechar cosas como herencia de plantillas. Puede renderizar una plantilla Twig como esta:

View::renderTemplate('Home/index.html', [
    'name'    => 'Dave',
    'colours' => ['red', 'green', 'blue']
]);

Se incluye una plantilla de muestra de Twig en App/Views/Home/index.html que hereda de la plantilla base en App/Views/base.html.

Modelos

Los modelos se utilizan para obtener y almacenar datos en su aplicaci�n. No saben nada sobre c�mo se presentar�n estos datos en las vistas. Los modelos extienden la clase Core\Model y usan PDO para acceder a la base de datos. Est�n almacenados en la carpeta App/Models. Se incluye una clase de modelo de usuario de muestra en App/Models/User.php. Puede obtener la instancia de conexi�n de la base de datos PDO de esta manera:

$db = static::getDB();

Errores

Si la configuraci�n de SHOW_ERRORS se establece en true, el navegador mostrar� todos los detalles del error si se produce un error o una excepci�n. Si se establece en false", se mostrar� un mensaje gen�rico mediante App/Views/404.html o App/Views/500.html vistas, seg�n el error.

En este proyecto usamos Sentry.io para monitorear los errores.