Programando con Drupal - Mapeo de acciones

Programando con Drupal

Mapeo de acciones

En Drupal, un URL tiene la forma:

app_url/a/b/c/...

ó, si no se usa clean urls:

app_url/?q=a/b/c/...

'a/b/c...' es la ruta de argumentos del URL.

La principal forma de mapear la ruta de argumentos con acciones es usando el hook _menu.

Recordando

HooksDurante el proceso que genera los menús, bloques, etc, Drupal da a los módulos la oportunidad de participar.

Un hook corresponde a un tipo de participación. Básicamente, para cada hook hhh, se consulta a cada módulo mmm si ha implementado una función mmm_hhh, y se ejecuta si es así.

MódulosUn módulo es un conjunto de código agrupado en un directorio, diseñado para ser reconocido por Drupal y participar en el proceso del sistema.

Un módulo mmm guarda en un directorio mmm al menos dos archivos: mmm.info y mmm.module.

La estructura de mmm.info es similar a: ; $Id$

name = Mmm

description = Module description

core = 6.x

package = Group name

La estructura de mmm.module es similar a: <?php

// $Id$

/**

* @file

* File description

*/

/**

* Implementation of hook_hhh().

*/

function mmm_hhh() {

//...

}

//...

Hello WorldUn esquema básico de mapeo es similar a: /**

* Implementation of hook_menu().

*/

function mymodule_menu() {

$items = array();

$items['mypath_1' ] = array(

'page callback' => 'mymodule_mypath_1',

'access callback' => TRUE,

'type' => MENU_CALLBACK,

);

$items['mypath_2' ] = array(

'page callback' => 'mymodule_mypath_2',



);

return $items;

}

/**

* Page callback.

*/

function mymodule_mypath_1() {

// something

}

/**

* Page callback.

*/

function mymodule_mypath_2() {

// something

}

Es decir, el hook _menu debe devolver un array de items, cada uno de los cuales indica qué función realizará la acción correspondiente a una ruta determinada.

Esto permite implementar Hello World del siguiente modo, en el módulo helloworld:

/**


*/

function helloworld_menu() {

$items = array();

$items['helloworld'] = array(

'page callback' => 'helloworld_hello',



);

return $items;

}

/**

* Page callback.

*/

function helloworld_hello() {

$output = t('Hello World!');

return $output;

}

Aquí, el item indica que al invoca al url http://myapp_url/helloworld, se llamará a la función helloword_hello, cuya salida (el resultado de t('Hello World!')) será escrita en la página (en el bloque encargado de mostrar el contenido principal).

Es posible definir cualquier ruta y mapearla a cualquier función adecuada. Por ejemplo, podemos agregar un segundo item que defina una ruta alterna que haga lo mismo: /**


*/


$items = array();





);

$items['hello/again'] = array(




);

return $items;

}

/**

* Page callback.

*/



return $output;

}

El segundo item indica que al invocar al url http://myapp_url/hello/again, se llamará a tambien a la función helloword_hello, lo que producirá el mismo resultado.

Control de accesoPara que cualquiera acceda a la ruta, basta con poner access callback en TRUE (de lo contrario se obtendrá un mensaje de acceso denegado).

Pero es posible usar tambien un callback para esto: /**


*/


$items = array();



'access callback' => 'helloworld_access',


);

return $items;

}

/**

* Page callback.

*/



return $output;

}

/**

* Access callback.

*/

function helloworld_access() {

return TRUE;

}

La idea es que el access callback devuelva un booleano. Aquí simplemente se ha devuelto TRUE.

Tambien podemos usar la función drupal user_access(), indicando el permiso requerido: /**


*/


$items = array();



'access callback' => 'helloworld_access',


);

return $items;

}

/**

* Page callback.

*/



return $output;

}

/**

* Access callback.

*/

function helloworld_access() {

return user_access(array('access content'));

}

O también, de modo más compacto: /**


*/


$items = array();



'access callback' => 'user_access',

'access arguments' => array('access content'),


);

return $items;

}

/**

* Page callback.

*/



return $output;

}

Aquí se da acceso a todos los que tengan el permiso ‘access content’.

Para definir un permiso personalizado, podemos usar el hook _perm. /**


*/


$items = array();



'access callback' => 'user_access',

'access arguments' => array('helloworld access'),


);

return $items;

}

/**

* Page callback.

*/



return $output;

}

/**

* Implementation of hook_perm().

*/

function helloworld_perm() {

return array('helloworld access');

}

En el menúComo el tipo de cada item es MENU_CALLBACK, simplemente se realiza el mapeo de la ruta con la función.

Usando MENU_NORMAL_ITEM, y agregando un título, aparecerá como item del menú: /**


*/


$items = array();


'title' => 'Hello World',



'type' => MENU_NORMAL_ITEM,

);

return $items;

}

/**

* Page callback.

*/



return $output;

}

Además, el título se usa también como título de la página y del bloque.

La línea 'type' => MENU_NORMAL_ITEM, es opcional, ya que MENU_NORMAL_ITEM es el valor por default.

La posición del item en el menú se puede afectar poniendo en weight un valor adecuado (los items con valores menores tienden a flotar y los de valores mayores a hundirse): /**


*/


$items = array();






'weight' => 5,

);

return $items;

}

/**

* Page callback.

*/



return $output;

}

Si las rutas son anidadas, los títulos aparecerán anidados en el menú: /**


*/


$items = array();






);

$items['helloworld/again'] = array(

'title' => 'Hello World again',




);

return $items;

}

/**

* Page callback.

*/



return $output;

}

Opcionalmente se puede definir una descripción, que aparecerá al pasar el puntero del mouse sobre el item:

/**


*/


$items = array();



'description' => 'say Hello World',




);

return $items;

}

/**

* Page callback.

*/



return $output;

}

Traduciendo el menúEn helloworld_hello(), por ejemplo, se usa t() para indicar contenido traducible. Sin embargo, no se usa t() ni para title ni para description, ya que esa función se aplicará automáticamente a los valores que ahí se definan.

Para description siempre se usa t(). Pero, en el caso de title, la funcion de traducción se puede cambiar dándole un valor a title callback (que por default ‘t’): /**


*/


$items = array();


'title' => 'Hello @name!',

'title callback' => 'helloworld_title',





);

return $items;

}

/**

* Page callback.

*/



return $output;

}

/**

* Title callback.

*/

function helloworld_title($title) {

$output = strtoupper(t($title, array('@name' => 'Antonio')));

return $output;

}

Se puede usar drupal_set_title() para que el title sólo afecte al menú: /**


*/


$items = array();








);

return $items;

}

/**

* Page callback.

*/



return $output;

}

/**

* Title callback.

*/

function helloworld_title($title) {

drupal_set_title(t('Hello World!'));

$output = strtoupper(t($title, array('@name' => 'Antonio')));

return $output;

}

Si el title callback es sólo t(), el paso de argumentos se puede escribir de modo compacto: /**


*/


$items = array();




'title arguments' => array('@name' => 'Antonio'),





);

return $items;

}

/**

* Page callback.

*/



return $output;

}

Argumentos de la páginaLos argumentos adicionales en la ruta son pasados como argumentos a la función, si esta los acepta. /**


*/


$items = array();

$items['hello'] = array(




);

return $items;

}

/**

* Page callback.

*/

function helloworld_hello($name='John', $lastname='Doe') {

$output = t('Hello @name @lastname!',

array('@name' => $name, '@lastname' => $lastname));

return $output;

}

Ahora, el callback puede aceptar dos argumentos. Si no hay ninguno, usa los valores por default:

También es posible pasar los argumentos al definir el item. En ese caso, son usados antes que los pasados por el URL: /**


*/


$items = array();



'page arguments' => array('Carlos'),



);

return $items;

}

/**

* Page callback.

*/




return $output;

}

Aquí, el primer argumento tomado es ‘Carlos’, que es el primer argumento pasado en la definición del item, y el segundo argumento tomado es ‘Antonio’, que es el primer argumento pasado en el URL.

También se pueden pasar los argumentos poniendo en page arguments un array con los índices de los argumentos a tomar. El orden en que aparezcan los índices es tomado en cuenta. Asi que es posible invertirlos, por ejemplo: /**


*/


$items = array();



'page arguments' => array(2, 1),



);

return $items;

}

/**

* Page callback.

*/




return $output;

}

Callbacks en otro archivoAunque es necesario que las definiciones de los items estén en el archivo .module, es posible pasar las definiciones de los callback a otros archivos, para que así esas definiciones se carguen sólo cuando sean necesarias. helloworld.module

//...

/**


*/


$items = array();



'file' => 'helloworld.inc',



);

return $items;

}

//...

helloworld.inc

//...

/**

* Page callback.

*/



return $output;

}

//...

ComodinesEn la definición de una ruta se puede usar comodines. Por ejemplo, % significa ‘cualquier cosa’, hasta antes del siguiente /. /**


*/


$items = array();





);

$items['hello/%'] = array(

'page callback' => 'helloworld_hellox',



);

return $items;

}

/**

* Page callback.

*/



return $output;

}

/**

* Page callback.

*/

function helloworld_hellox($name='Anonymous') {

$output = t('Hello') . ' '. $name . '!';

return $output;

}

Así, rutas como hello/a/Antonio, hello/1/Antonio, ó hello/something/Antonio, serán procesadas por el callback helloworld_hellox().

Un item cuya ruta contenga comodines normalmente no aparecerá en el menú, aun cuando se indique que su tipo es MENU_NORMAL_ITEM.

Se puede pasar el comodín y los otros argumentos de la ruta, poniendo en page arguments, sus índices: /**


*/


$items = array();





);

$items['hello/%/a/b/c'] = array(

'page callback' => 'helloworld_hellox',

'page arguments' => array(1,2,3), // Esto pasa %, a, b



);

return $items;

}

/**

* Page callback.

*/



return $output;

}

/**

* Page callback.

*/

function helloworld_hellox($something='Hello',

$a='', $b='', $name='Anonymous') {

$output = t($something) . ' '. $name . '!';

return $output;

}

page callback permite pasar tanto el comodín como los otros argumentos, si fuera necesario.

Una vez que se han pasado los argumentos indicados por page callback, el siguiente será el que aparezca en el URL después de la ruta. Por eso en este ejemplo $name=’Antonio’ y no ‘c’.

Referencias● John K. VanDyk, "Pro Drupal Development", 2ed, 2008, ISBN 978-1-4302-0989-8

Autor● Antonio Kobashikawa Carrasco

[email protected] http://www.kobaonline.com

Programando con Drupal - Mapeo de acciones

Documents

Transcript of Programando con Drupal - Mapeo de acciones