Paginación en cakePHP: Paginator (componente en controladores)

Para poder ver todos los registros de nuestra base de datos con paginación y posibilidad de ordenar, cakePHP nos ofrece el componente ‘Paginator’. Para usarlo basta con indicarlo en el controlador:

 public $components = array('Paginator');

Y podemos configurar diferentes opciones:

 public $paginate = array(
        'fields' => array('Post.id', 'Post.created'),
        'limit' => 25,
        'order' => array(
            'Post.title' => 'asc'
        )
    );

Para usarlas lo tendremos que indicar en la acción del controlador:

 public function index() {
 $this->Actor->recursive = 0;
 $this->Paginator->settings = $this->paginate;
 $this->set('actors', $this->Paginator->paginate( );
 }

En el index habitualmente ponemos la opción ‘recursive’ a 0 para que no nos devuelva los registros relacionados. Si queremos usar las opciones modificadas del paginador lo indicamos en settings. Y para obtener los registros basta con llamar a la función ‘paginate’.

También podemos pasar condiciones a la hora de paginar:

 public function index() {
 $this->Actor->recursive = 0;
 $this->Paginator->settings = $this->paginate;
 $this->set('actors', $this->Paginator->paginate( array('first_name LIKE' => 'a%')));
 }

En este caso nos muestra los actores cuyo nombre empieza por ‘a’.

Validar campos en cakePHP

CakePHP permite validar los valores que se introducen en los campos. Para ello tenemos que definirlos en el modelo. Por ejemplo:

 public $validate = array(
        'login' => 'alphaNumeric',
        'email' => 'email',
        'born' => 'date'
    );

Aquí estamos indicando que ‘login’ debe ser alfanumérico, ’email’ de tipo mail y ‘born’ de tipo fecha.

Cada campo puede tener más de una regla, y estas puede ser complejas, incluyendo el mensaje que tenemos que mostrar:

 public $validate = array(
        'login' => array(
            'alphaNumeric' => array(
                'rule' => 'alphaNumeric',
                'required' => true,
                'message' => 'Sólo letras y números'
            ),
            'between' => array(
                'rule' => array('lengthBetween', 5, 15),
                'message' => 'Entre 5 y 15 caracteres'
            )
        ),
        'password' => array(
            'rule' => array('minLength', '8'),
            'message' => 'Mínimo ocho caracteres de longitud'
        ),
        'email' => 'email',
        'born' => array(
            'rule' => 'date',
            'message' => 'Debe ser una fecha',
            'allowEmpty' => true
        )
    );

Diferentes valores y su explicación:

'rule' => array('notBlank'), //La regla que vamos a aplicar (ver más adelante)
 //'message' => 'Para poner mensaje personalizado',
 //'allowEmpty' => false, //Permitir valor en blanco
 //'required' => false, //Requerido sí o no
 //'last' => false, // Parar validación despues de esta regla
 //'on' => 'create', // Limitar validación a 'create' o 'update'

Aquí está la lista de las diferentes validaciones.

public $validate = array(
    'login' => array(
        'rule' => 'alphaNumeric',
        'message' => 'Sólo letras y números'
    )
);
public $validate = array(
    'password' => array(
        'rule'    => array('lengthBetween', 5, 15),
        'message' => 'Longitud entre 5 y 15'
    )
);
public $validate = array(
    'myCheckbox' => array(
        'rule' => array('boolean'),
        'message' => 'Valores booleanos (0 o 1)'
    )
);
public $validate = array(
    'ccnumber' => array(
        'rule' => array('cc', array('visa', 'maestro'), false, null),
        'message' => 'Tarjeta de crédito, en este caso visa o maestro.'
    )
);
public $validate = array(
    'age' => array(
        'rule' => array('comparison', '>=', 18),
        'message' => 'El valor tiene que ser mayor o igual que 18.'
    )
);

public $validate = array(
    'age' => array(
        'rule' => array('comparison', 'greater or equal', 18),
        'message' => 'Igual que antes. Valores permitidos:  “is greater”, “is less”, “greater or equal”, “less or equal”, “equal to”, and “not equal”.'
    )
);
public $validate = array(
    'born' => array(
        'rule' => array('date', 'ymd'),
        'message' => 'Fecha en formato YY-MM-DD',
        'allowEmpty' => true
    )
);

/****
Los separadores pueden ser espacios, puntos, guiones o barras
‘dmy’ e.g. 27-12-2006 or 27-12-06 
‘mdy’ e.g. 12-27-2006 or 12-27-06 
‘ymd’ e.g. 2006-12-27 or 06-12-27 
‘dMy’ e.g. 27 December 2006 or 27 Dec 2006
‘Mdy’ e.g. December 27, 2006 or Dec 27, 2006 (coma opcional)
‘My’ e.g. (December 2006 or Dec 2006)
‘my’ e.g. 12/2006 or 12/06 
‘ym’ e.g. 2006/12 or 06/12 
‘y’ e.g. 2006 
***/
public $validate = array(
    'price' => array(
        'rule' => array('decimal', 2) //Dos números decimales

    )
);
public $validate = array(
    'email' => array(
        'rule' => array('email', true),
        'message' => 'Email válido, incluyendo host válido (true)'
    )
);
public $validate = array(
    'food' => array(
        'rule' => array('equalTo', 'cake'),
        'message' => 'Igual a cake'
    )
);
public $validate = array(
    'image' => array(
        'rule' => array('fileSize', '<=', '1MB'),
        'message' => 'El tamaño tiene que ser menor que 1Mb'
    )
);
public $validate = array(
    'function' => array(
         'allowedChoice' => array(
             'rule' => array('inList', array('Foo', 'Bar')),
             'message' => 'El valor tiene que estar en la lista'
         )
     )
 );
public $validate = array(
    'clientip' => array(
        'rule' => array('ip', 'IPv4'), // or 'IPv6' or 'both' (default)
        'message' => 'Tiene que ser una IP.'
    )
);
public $validate = array(
    'login' => array(
        'rule' => 'isUnique',
        'message' => 'Valor único en la base de datos.'
    )
);
public $validate = array(
    'login' => array(
        'rule' => array('maxLength', 15),
        'message' => 'La cadena no puede tener más de 15 caracteres.'
    )
);
public $validate = array(
    'login' => array(
        'rule' => array('minLength', 8),
        'message' => 'Cadena mínimo 8 caracteres.'
    )
);
public $validate = array(
    'salary' => array(
        'rule' => array('money', 'left'),
        'message' => 'Indicador de moneda.'
    )
);
public $validate = array(
    'cars' => array(
        'rule' => 'numeric',
        'message' => 'El valor debe ser numérico.'
    )
);
public $validate = array(
    'wheels' => array(
        'rule' => 'naturalNumber',
        'message' => 'Número natural sin incluir el 0.'
    ),
    'airbags' => array(
        'rule' => array('naturalNumber', true),
        'message' => 'Número natural incluyendo el 0.' 
), 
);
public $validate = array(
    'number' => array(
        'rule' => array('range', -1, 11),
        'message' => 'Valor numérico en un rango'
    )
);
public $validate = array(
    'website' => array(
        'rule' => 'url' //Comprueba que sea una url válida
    )
);

 

public $validate = array(
    'login' => array(
        'rule' => '/^[a-z0-9]{3,}$/i',
        'message' => 'Expresión regular, en este caso que empieza por tres caracteres alfanuméricos'
    )
);

Recuperar datos

find

find($tipo, $parametros)

$tipo es 'all', 'first', 'count', 'neighbors', 'list' o 'threaded'. 'first' es el tipo de búsqueda predeterminado.

$parametros es un array con cualquiera de las siguientes opciones disponibles como claves:

array(
    'conditions' => array('Model.field' => $thisValue), //array de condiciones
    'recursive' => 1, //int
    'fields' => array('Model.field1', 'Model.field2'), //array de nombres de campos
    'order' => 'Model.created', //string o array definiendo el orden
    'group' => array('Model.field'), //campos para GROUP BY
    'limit' => n, //int
    'page' => n //int
)

find(‘first’)

find(‘first’, $params)

‘first’ es el tipo find por defecto, y devolverá un solo resultado, deberías utilizar esto para cualquier caso donde esperes solo un resultado.

find(‘count’)

find('count', $params)

find('count', $params) Devuelve un valor entero.

find(‘all’)

find('all', $params)

find('all')devuelve un array de resultados(potencialmente multiple); es, de hecho, el mecanismo usado por todas las variantes del método find(), como por ejemplo para paginar.

find(‘list’)

find('list', $params)

find('list', $params) Devuelve un array indexado, útil para cualquier uso donde podrías querer una lista como los polulares campos select de los formularios

find(‘neighbors’)

find('neighbors', $params)

‘neighbors’ realiza una búsqueda similar a ‘first’, a diferencia que devuelve el registro precedente y posterior del solicitado.

query

query(string $consulta)

Se pueden realizar llamadas SQL personalizadas usando el método query() del modelo.

Todas las tablas del ejemplo Blog

CREATE TABLE posts (
    id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    title VARCHAR(50),
    body TEXT,
    created DATETIME DEFAULT NULL,
    modified DATETIME DEFAULT NULL
);

/* Then insert some posts for testing: */
INSERT INTO posts (title, body, created)
    VALUES ('The title', 'This is the post body.', NOW());
INSERT INTO posts (title, body, created)
    VALUES ('A title once again', 'And the post body follows.', NOW());
INSERT INTO posts (title, body, created)
    VALUES ('Title strikes back', 'This is really exciting! Not.', NOW());
CREATE TABLE comments ( id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY, subject VARCHAR(50), body VARCHAR(1500), post_id int, created DATETIME DEFAULT NULL, modified DATETIME DEFAULT NULL ); /* algunos valores de test */ INSERT INTO comments (subject,body,post_id,created) VALUES ('Good','Good article',1, NOW()); INSERT INTO comments (subject,body,post_id,created) VALUES ('What?','I don\'t understand',2, NOW()); INSERT INTO comments (subject,body,post_id,created) VALUES ('ola','ola k ase??',3, NOW());

CREATE TABLE themes (
 id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
 title VARCHAR(50),
 created DATETIME DEFAULT NULL,
 modified DATETIME DEFAULT NULL
);


/* algunos valores de test */
INSERT INTO themes (title,created)
 VALUES ('MVC', NOW());
INSERT INTO themes (title,created)
 VALUES ('cakePHP', NOW());
INSERT INTO themes (title,created)
 VALUES ('Depression', NOW());
CREATE TABLE tags (
 id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
 tag VARCHAR(50),
 created DATETIME DEFAULT NULL,
 modified DATETIME DEFAULT NULL
);


/* algunos valores de test */
INSERT INTO tags (tag,created)
 VALUES ('MVC', NOW());
INSERT INTO tags (tag,created)
 VALUES ('CakePHP', NOW());
INSERT INTO tags (tag,created)
 VALUES ('JS', NOW());

CREATE TABLE posts_tags (
 id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
 post_id INT,
 tag_id INT
);

Scaffold y Bake

Hasta la versión 3.0 de cakePHP se puede hacer ‘scaffold’ en los controladores. ¿Qué es esto? Es poner un ‘andamiaje’ que proporciona las funcionalidades básicas de altas, bajas y modificaciones (CRUD).

Para hacerlo basta poner en el controlador lo siguiente:

var $scaffold;

Y automáticamente, si el modelo está bien, obtenemos el entorno para manejar los datos.

En la versión 3.0 se ha eliminado por falta de uso. Es comprensible, ya que si queremos obtener la funcionalidad básica podemos hacerlo vía bake.

Para conseguirlo necesitamos tener en el path del sistema la ruta al php. Por ejemplo:

SET PATH=%PATH%;C:\xampp\php

Añadimos también la siguiente ruta;

Ruta de mi cake\app\Console\

Ejemplo:

C:\xampp\htdocs\cakeblog\app\Console

Colocarnos en la carpeta de la aplicación y ejecutar:

Ruta de mi cake\app\cake bake

Ejemplo:

c:\xampp\htdocs\cakeblog\app\cake bake

O

Ruta de mi cake\app\cake bake all

Esto nos genera modelos, vistas y controladores con toda la funcionalidad, listos para usar y modificar.

 

Ejemplo:

cd c:\xampp\htdocs\cakeblog\app

c:\xampp\htdocs\cakeblog\app\cake bake

c:\xampp\htdocs\cakeblog\app\cake bake all

Ejercicio: Mantenimiento tabla Themes

Añadamos la tabla themes a la base de datos y realicemos el mantenimiento:

CREATE TABLE themes (
 id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
 title VARCHAR(50),
 created DATETIME DEFAULT NULL,
 modified DATETIME DEFAULT NULL
);


/* algunos valores de test */
INSERT INTO themes (title,created)
 VALUES ('MVC', NOW());
INSERT INTO themes (title,created)
 VALUES ('cakePHP', NOW());
INSERT INTO themes (title,created)
 VALUES ('Depression', NOW());

Acción edit y vista

 public function edit($id = null) {
 //Parte donde se recuperan los datos enviados por la vista y se guardan en la BD
 if ($this->request->is(array('post', 'put'))) {
 if ($this->Post->save($this->request->data)) {
 $this->Flash->success(__('Post actualizado.'));
 return $this->redirect(array('action' => 'index'));
 }
 $this->Flash->error(__('Unable to update your post.'));
 } else {
 //Parte donde se recupera el Post y se manda a la vista
 if (!$id) {
 throw new NotFoundException(__('Invalid post'));
 }

 $post = $this->Post->findById($id);
 if (!$post) {
 throw new NotFoundException(__('Invalid post'));
 }

 if (!$this->request->data) {
 $this->request->data = $post;
 }
 }
 }
 <h1>Edit Post</h1>
<?php
echo $this->Form->create('Post');
echo $this->Form->input('title');
echo $this->Form->input('body', array('rows' => '3'));
echo $this->Form->input('id', array('type' => 'hidden'));
echo $this->Form->end('Save Post');
?>

Convenciones de nombres en cakephp

Aquí tenemos la lista de convenciones de nombres:

Convenciones de nombres en cakephp

Hay un problema. CakePHP cambia del plural al singular en controladores/modelos, y si tenemos una tabla como ‘Autores’ nos generará un modelo llamado ‘Autore’. Esto tiene dos soluciones, usar en estos casos un plural inglés en las tablas (autors) o añadir un par de líneas en /app/Config/bootstrap.php:

Inflector::rules('singular', array('rules' => array('/(.*)res$/i' => '\1r', '/(.*)nes$/i' => '\1n', '/(.*)des$/i' => '\1d', '/(.*)ses$/i' => '\1s'), 'irregular' => array(), 'uninflected' => array()));
Inflector::rules('plural', array('rules' => array('/(.*)r$/i' => '\1res', '/(.*)n$/i' => '\1nes', '/(.*)d$/i' => '\1des', '/(.*)s$/i' => '\1ses'), 'irregular' => array(), 'uninflected' => array() ) );
Visto aquí: