README

Plantilla con el Modelo Vista Controlador

Tabla de Contenidos

Instalación
Configuración
Rutas, Vistas y Controladores
Modelos
Rutas
- GET
- POST
- DELETE
- PUT
- OPTIONS
- HEAD
- AJAX
- Grupos de rutas
Parámetros de rutas
Redireccionamiento
Proveedores o servicios
Otros aspectos
Pruebas Unitarias
Ejemplo: Hola mundo
Ejemplo2: Usando Modelos y Controladores
Usando la consola
Autor

Instalación

Instalar composer

Git clone (recomendada)

Clonar el repositorio en github. Y luego entrar en la carpeta clonada a través del terminal y luego ejecuta composer install para instalar todas las dependencias del projecto en la carpeta vendor.

Nota: esta es la forma recomendada de instalación para obtener la aplicación configurada.

Composer install

-- Crea una carpeta con el nombre de tu proyecto. -- Entra en la carpeta que creaste y agrega un archivo composer.json con el contenido

{
   "require": {
      "simple-php-mvc/simple-php-mvc-app": 'dev-master'
   }
}

-- Abre una terminal de tu sistema operativo y ejecuta en la carpeta del proyecto composer install y espera a que se instale Simple PHP MVC.

Composer create-project

Otra forma de instalar con composer es ejecutando el comando composer install simple-php-mvc/simple-php-mvc en la terminal de tu sistema operativo.

Configuración

Asegúrate de que la carpeta raíz del sistema tenga los permisos apropiados con sudo chmod 755 -R.

proyecto
|_ app/
    |_ config/
       routes.json
       routes.php
    .htaccess
    AppMVC.php
    autoload.php
    console
|_ src/
|_ vendor/
|_ web/
   .htaccess
   app.php
   app_dev.php

**Importante: ** en el archivo app/AppMVC.php es la configuración de los módulos, proveedores o servicios y las rutas, y puede ser como el siguiente:

<?php

use MVC\MVC as BaseMVC;
use MVC\Module\Module;
use MVC\Provider\Provider;
use MVC\Server\Route;

/**
 * Description of AppMVC
 *
 * @author Ramón Serrano <ramon.calle.88@gmail.com>
 */
class AppMVC extends BaseMVC
{
    
    /**
     * Set MVC Application Modules
     * 
     * @return Module[]
     */
    public function setModules()
    {
        $modules = array(
            new MVC\Tests\EjemploModule\EjemploModule(),
        );
        
        return $modules;
    }
    
    /**
     * Set MVC Application Providers
     * 
     * @return Provider[]
     */
    public function setProviders()
    {
        $providers = array(
            new MVC\DataBase\PdoProvider(array(
                'dbname' => 'test'
            )),
            new MVC\Tests\Provider\DoctrineDBALProvider(array(
                'charset'  => null,
                'driver'   => 'pdo_mysql',
                'dbname'   => 'test',
                'host'     => 'localhost',
                'user'     => 'root',
                'password' => null,
                'port'     => null,
            )),
            new MVC\Tests\Provider\DoctrineORMProvider(array(
                'params'       => array(
                    'charset'  => null,
                    'driver'   => 'pdo_mysql',
                    'dbname'   => 'test',
                    'host'     => 'localhost',
                    'user'     => 'root',
                    'password' => null,
                    'port'     => null,
                ),
                'dev_mode'     => false,
                'etities_type' => 'annotations',
                'path_entities' => array(
                    $this->getAppDir() . '/../src/MVC/Tests/EjemploModule/Entity'
                ),
                'proxy_dir'    => null
            )),
            new MVC\Tests\Provider\MonologProvider(array(

            )),
            new MVC\Tests\Provider\TwigProvider(array(
                'path' => $this->getAppDir() . '/../src/MVC/Tests/EjemploModule/Resources/views'
            )),
        );
        
        $providers[] = new MVC\Tests\EjemploModule\EjemploProvider(array(
            
        ));
        
        return $providers;
    }
    
    /**
     * Set MVC Application Routes
     * 
     * @return Route[]
     */
    public function setRoutes()
    {
        $routes = parent::setRoutes();
        
        return $routes;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getModules()
    {
        return $this->container->getModules();
    }
}

Rutas, Vistas y Controladores

Rutas

En el archivo app/config/routes.php o app/config/routes.json puedes configurar las acciones para las rutas que deseas configurar.

Vistas

Las vistas debe ser archivos con extensión .html o .php.

Si usa un controlador para mostrar la vista, los nombres de estos archivos deben ser iguales a la accion del controlador. Ejemplo: accion/controlador index, archivo/vista index.html

Los archivos deben ser guardados en la carpeta configurada en templates_path de la instancia de MVC\MVC con el nombre de la clase del controlador sin la palabra Controller. Ejemplo: carpeta clase donde clase -> ClaseController.

Controladores

Se recomienda que cada controlador extienda de MVC\Controller\Controller.

El retorno de cada controlador deben ser cadenas de texto o variables de tipo arreglos asociativos con valores de cualquier tipo.

Para enviar varias variables a una vista, sean de cualquier tipo, el controlador debe retornar las variables dentro de la función array(). Ejemplo: $variable1, $variable2, $variable3 return array( 'variable1' => $variable1, 'variable2' => $variable2, 'variable3' => $variable3 )

Controladores

<?php

namespace ControllersNamespace;

use MVC\Controller\Controller,
    MVC\MVC,
    MVC\Server\HttpRequest;

class ClaseController extends Controller
{
   public function indexAction(MVC $mvc, HttpRequest $request)
   {
       return '<p>Resultado de la accion</p>';
   }
}

Modelos

Un modelo se crea de la siguiente forma:

<?php
namespace ModelsNamespace;

use MVC\DataBase\Model,
    MVC\DataBase\PDO;

class Nombre_del_Modelo extends Model
{
    public function __construct(PDO $pdo)
    {
        parent::__construct($pdo, 'nombre_tabla');
    }
}

También DBAL Model

<?php
namespace ModelsNamespace;

use Doctrine\DBAL\Connection,
    MVC\DataBase\DBALModel as Model;

class Nombre_del_Modelo extends Model
{
    public function __construct(Connection $conn)
    {
        parent::__construct($conn, 'nombre_tabla');
    }
}

Rutas

Una ruta se representa como cualquier URI con métodos de consulta que se envía al servidor.

En la carpeta app/config en el archivo routes.json o routes.php se configuran las rutas de la aplicación.

[{
    "method": ["get", "post", "ajax"],
    "pattern": "/index",
    "action": "ControllerNamespace\\ClaseController::indexAction",
    "name": "foo_index"
},
{
    "method": ["ajax", "delete", "get", "post", "put", "head", "options"],
    "pattern": "/index2",
    "action": "ControllerNamespace\\FooController::index2Action",
    "name": "foo_index2"
}]

use MVC\Server\Route;

<?php
return array(
    array(
        "method"  => ["ajax", "get", "post"],
        "pattern" => "/index",
        "action"  => "ControllerNamespace\\FooController::indexAction",
        "name"    => "foo_index"
    ),
    array(
        new Route(Route::$validMethods, '/', 'ControllerNamespace\\FooController::indexAction2', 'foo_index2')
    ),
);

GET

Usa el método get() de tu aplicación u objeto MVC para crear recursos que devuelvan una llamada a un URI mediante el método HTTP GET.

$mvc = new \MVC\MVC();
$mvc->get("/hello/[a:name]", function($name) {
    return "Hello $name.";
}, 'hello_get');

POST

Usa el método post() de tu aplicación u objeto MVC para crear recursos que devuelvan una llamada a un URI mediante el método HTTP POST.

$mvc = new \MVC\MVC();
$mvc->post("/hello/[a:name]", function($name) {
    return "Hello $name";
}, 'hello_post');

DELETE

Usa el método delete() de tu aplicación u objeto MVC para crear recursos que devuelvan una llamada a un URI mediante el método HTTP DELETE.

$mvc = new \MVC\MVC();
$mvc->delete("/hello/[i:id]", function($id) {
    return "DELETE $id";
}, 'hello_delete');

PUT

Usa el método put() de tu aplicación u objeto MVC para crear recursos que devuelvan una llamada a un URI mediante el método HTTP PUT.

$mvc = new \MVC\MVC();
$mvc->put("/hello/[i:id]", function($id) {
    return "PUT $id";
}, 'hello_put');

OPTIONS

Usa el método options() de tu aplicación u objeto MVC para crear recursos que devuelvan una llamada a un URI mediante el método HTTP OPTIONS.

$mvc = new \MVC\MVC();
$mvc->options("/hello/[i:id]", function($id) {
    return "OPTIONS $id";
}, 'hello_options');

HEAD

Usa el método head() de tu aplicación u objeto MVC para crear recursos que devuelvan una llamada a un URI mediante el método HTTP HEAD.

$mvc = new \MVC\MVC();
$mvc->head("/hello/[i:id]", function($id) {
    return "HEAD $id";
}, 'hello_head');

AJAX

Usa el método ajax() de tu aplicación u objeto MVC para crear recursos que devuelvan una llamada a un URI mediante el método HTTP AJAX.

$mvc = new \MVC\MVC();
$mvc->ajax("/hello/[i:id]", function($id) {
    return "AJAX $id";
}, 'hello_ajax');

Grupos de rutas

Usa el método group de tu aplicación u objeto MVC para crear recursos de rutas agrupadas. Esto es para agrupar grupos de rutas que tienen el mismo prefijo.

$mvc = new \MVC\MVC();
$mvc->group("/admin", function($route) use($mvc) {
    $mvc->get($route, function() {
        return "Admin index";
    }, 'admin_index');
    $mvc->get("$route/other", function() {
        return "Admin other route.";
    }, 'admin_other');
});

Parámetros de rutas

Los tipos de variables válidos para las rutas son:

[i] Entero
[a] Alfanumerico
[h] Hexadecimal
[*] Cualquier valor

$mvc = new \MVC\MVC();
$mvc->ajax("/hello/[i:id]/[a:name]", function($id, $name) {
    return "AJAX id = $id, name = $name\n";
}, 'hello_id_name');

Redireccionamiento

Esta función redirecciona a una ruta...

$mvc = new \MVC\MVC();
$mvc->get("/", function() use($mvc){
    $mvc->redirect('/redirect');
}, 'home_redirect');
$mvc->get("/redirect", function(){
    return "Redirect\n";
}, 'redirect');

Proveedores o servicios

Este aspecto es para registrar otros servicios independientes del Simple PHP MVC extendiendo de MVC\Provider\Provider. Por ejemplo: Doctrine Object Relational Mapper (ORM), SwiftMailer, Monolog, etc.

<?php

namespace ProvidersNamespace;

use MVC\MVC,
    MVC\Provider\Provider;

class ExampleProvider extends Provider
{
    public function __construct(array options = array())
    {
	    parent::__contruct($options);
    }
    
    public function boot(MVC $mvc)
    {
	    //Configuraciones
    }

    public function register(MVC $mvc) 
    {
        // Registro de variables de uso o de servicios
        $app->setCvpp('example.name', get_class($this));
        
    }

}

Otros aspectos

Para usar los objetos Response, HttpRequest, View, están las siguientes funciones:

view()

Devuelve el objeto de la vistas.

$mvc = new \MVC\MVC();
$view = $mvc->view();

request()

Devuelve el objeto MVC\Server\HttpRequest.

$mvc = new \MVC\MVC();
$request = $mvc->request();

response()

Devuelve el objeto \MVC\server\Response.

$mvc = new \MVC\MVC();
$response = $mvc->response();

Usando la consola

Actualmente en desarrollo. Esperar la version 2.0

Autor:

Ramón Serrano ramon.calle.88@gmail.com

simple-php-mvc / simple-php-mvc-app

Maintainers

Details