Edición de «Helper Datagrid»

== DATAGRID FACIL DE USAR.==

Invocando el helper datagrid y pasando el model se crea automáticamente una grilla con los campos (fields). La forma de modificar el diseño del datagrid es 100% hoja estilo 'CSS'. También con un poco de programación podrás
ocultar campos, cambiar los titulos de los campos, crear link por fila el cual llamara una acción pasando el
id como parámetro, link para editar y eliminar, personalizar mensajes de advertencias. asignar el tipo de campo
que se está visualizando (moneda, número, porcentaje o una imagen). crear paginado.



===setValue($field_id, $field)===

Asigna un campo a mostrar de la tabla _id
$field_id: campo_id del modelo.
$field: nombre del campo que se encuentra en la tabla relacionada

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setValue('paises_id', 'nombre');
</source>


<source lang=php>
$dataGrid	=	new($Usuarios);
$dataGrid->setValue('roles_id', 'rol');
$dataGrid->setValue('paises_id', 'nombre');
$dataGrid->setValue('ciudades_id', 'ciudad');
</source>


===setCaption($field, $title)===

Cambia el nombre de una columna
$field: campo del modelo
$title: nombre a mostrar en la columna.

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setCaption('id', 'COD');
$dataGrid->setCaption('paises_id', 'PAIS');
</source>


===setTextUpper($field)===

Transforma toda la cadena de texto en letras Mayúsculas.
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTextUpper('nombres');
</source>


===setTextLower($field)===

Transforma toda la cadena de texto en letras minúsculas.
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTextLower('nombres');
</source>


===setTextUpperFirst($field)===

Transforma en mayúscula la primera letra de la cadena de texto.
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTextUpperFirst('nombres');
</source>

===setTextUpperWords($field)===

Transforma en mayúscula la primera letra de cada palabra de la cadena de texto.
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTextUpperWords('nombres');
</source>


===setTypeDate($field)===

Formato de salida d/m/Y (01/01/2002) para base de datos mysql
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTypeDate('fecha');
</source>

===setTypeDateTime($field)===

Formato de salida d/m/Y H:m:s (01/01/2002 12:00:00) para base de datos mysql
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTypeDate('fecha');
</source>

===setTypeImage($field)===

Muestra una imagen que se encuentra en la carpeta img/, es decir, solo se almacena el nombre de la imagen en formato jpg, gif o png. Debe existir un subdirectorio llamdo thumbs el cual almacena las imagenes redimencionadas. 
El archivo config/datagrid.ini tiene información del tamaño de la imagen redimensionada.
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTypeImage('photo');
</source>

===setTypeMoney($field)===

Formato de salida de un campo numerico
El archivo config/datagrid.ini tiene información para el signo y separadores.
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTypeMoney('monto');
</source>

===setTypeNumeric($field)===

Formato de salida de un campo numerico
El archivo config/datagrid.ini tiene información para los separadores.
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTypeNumeric('cantidad');
</source>



===setTypePercent($field)===

Formato de salida de un campo numerico
El archivo config/datagrid.ini tiene información adicional.
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setTypePercent('porcentaje');
</source>

===setMimes($params=array())===
Visualiza un icono con un link a una accion al final de la fila para cada registro.

array $params: array de parametros 

el primer paramtro es el nombre de la imagen que se encuentra en la carpeta img/ con extensión gif. 'xls:' el siguiente es el nombre de la accion que se encuetra en el mismo controlador creada la grilla, envia el id.
ej: http://dominio.com/kumbia/clientes/verExcel/11


<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setMimes('xls: verExcel', 'pdf: verPdf');
</source>

===setAlias($fields, $data=array())===
Crea alias a los datos que se encuentran en la tabla

$field: nombre del campo
$data: array de parametros 


<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setAlias('status', array('A'=>'Activo', 'D'=>'Desactivo'));
</source>
o
<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setAlias('numeros', array('0'=>'Cero', '1'=>'Uno', '2'=>'Dos', '3'=>'Tres', '4'=>'Cuatro', '5'=>'Cinco'));
</source>

===setImage($fields, $data=array())===
Coloca una imagen según el campo. La imagen puede ser cualquier formato soportado y debe estar almacenada en img/datagrid/


$field: nombre del campo
$data: array de parametros 


<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setAlias('status', array('A'=>'Activo.png', 'D'=>'Desactivo.png'));
</source>
o
<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setAlias('numeros', array('0'=>'Cero.gif', '1'=>'Uno.gif', '2'=>'Dos.gif', '3'=>'Tres.gif', '4'=>'Cuatro.gif', '5'=>'Cinco.gif'));
</source>

===setClass($fields, $data=array())===
Asigna una clase "CSS" al campo que se despliega según su valor


$field: nombre del campo
$data: array de parametros 


<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->setClass('status', array('P'=>'text-color-red', 'A'=>'text-color-green', 'R'=>'text-bold'));
</source>

===auto_filter = true===
Genera por cada celda un select o combo para realizar búsquedas en la misma grilla.

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->auto_filter = true;
</source>

===ignoreAutoFilter(array($campos))===
Cuando se realiza un autofiltro, con esta funcion se puede eliminar filtros de una columna.

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->auto_filter = true;
$dataGrid->ignoreAutoFilter(array('id', 'status'));
</source>

===ignore($field)===
No muestra un campo del molelo en la grilla
$field: campo del modelo

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->ignore('id');
</source>

===createCol($caption, $html)===
Crea una nueva columna a la grilla

$caption: Nombre de la columna.

$html: crea un html para ser visualizado

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->createCol('APROBAR', '<div id="div_a_{id}">' . Html::img('yes.gif', 'APROBAR', 'onclick=aprobar({id}); class="manito" id="img_a_{id}"') . '</div>');
</source>

o

<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->createCol('PRIMER V°B°', '');
</source>

===create = $url ===
Visualiza una imagen sobre la grilla y crea un link a la accion crear

$url: nombre del controlador más la accion

ej: http://dominio.com/kumbia/clientes/create


<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->edit	=	$controller_name . '/create';
</source>


===edit = $url ===
Visualiza un icono con un link a una accion al final de la fila para cada registro.

$url: nombre del controlador más la accion, es devuelta con su id 

ej: http://dominio.com/kumbia/clientes/edit/11


<source lang="php">
$dataGrid	=	new($Clientes);
$dataGrid->edit	=	$controller_name . '/edit';
</source>

===delete = $url ===
Visualiza un icono con un link a una accion al final de la fila para cada registro.

$url: nombre del controlador más la accion, es devuelta con su id 

ej: http://dominio.com/kumbia/clientes/delete/11


<source lang="php">
$dataGrid		=	new($Clientes);
$dataGrid->delete	=	controller_name . '/delete';
</source>


===delete_confirm = $msg===
Mensaje de alerta para la accion delete.
$msg: se puede visualizar el valor de un campo pasandoselo entre llaves {$field}.

<source lang="php">
$dataGrid			=	new($Clientes);
$dataGrid->delete		=	$controller_name . '/delete';
$dataGrid->delete_confirm	=	'Desea elimina el registro {id}';
</source>


<source lang="php">
$dataGrid			=	new($Clientes);
$dataGrid->delete		=	$controller_name . '/delete';
$dataGrid->delete_confirm	=	'¿Desea elmimar este registro {nombre}, {apellido}?';
</source>

===paginator_name = $paginador===

$paginador: Nombre del paginador para la grilla por defecto usa el default
puede incluir paginadores del kumbia.
   Classic -   Digg -   Extended -   Punbb -   Simple

<source lang="php">
$dataGrid			=	new($Clientes->paginate('per_page: 20'));
$dataGrid->paginator_name	=	'classic';
</source>


===url = $url===
Si utiliza paginator la grilla se debe indicar la url para el paginado, sino se indica por defecto obtiene el nombre del controlador y su accion de donde fue creado el dataGrid.

<source lang="php">
$dataGrid		=	new($Clientes->paginate('per_page: 20'));
$dataGrid->url		=	'usurios/index';
</source>

===show = 10===
número de paginas que se mostraran en el paginador, por defecto 10.

<source lang="php">
$dataGrid		=	new($Clientes->paginate('per_page: 20'));
$dataGrid->show		=	10;
</source>

===style = $name===
$name: nombre de la hoja de estilo ubicado en public/css/

<source lang="php">
$dataGrid		=	new($Clientes->paginate('per_page: 20'));
$dataGrid->style	=	'default';
</source>

===Ejemplo 1 de Uso===

'''controller_clientes.php'''

<source lang="php">
public function index()
{
	$this->clientes 	=	$this->Clientes->find("order: nombre");;
}
</source>

'''views/clientes/index.phtml'''
<source lang="php">
    	View::content();
    	View::helpers('dataGrid');
    	$dataGrid			=	new dataGrid($clientes);
    	View::partial('datagrid/default',false,array('dataGrid'=>$dataGrid));
</source>

===Ejemplo 2 de Uso===

'''controller_clientes.php'''
<source lang="php">
    public function index($page=1)
    {
    	$this->clientes	= $this->Clientes->paginate('per_page: 20', "page: $page");
    }
</source>

'''views/clientes/index.phtml'''

<source lang="php">
<?php View::content() ?>
<?php View::helpers('dataGrid'); ?>
<?php 
    	$dataGrid					=	new dataGrid($clientes);
    	$dataGrid->setValue('ciudades_id', 'nombre');
    	$dataGrid->setTextLower('nombre');
    	$dataGrid->setTypeImage('photo');
    	$dataGrid->setMimes('xls: verXls');
    	$dataGrid->ignore('id');
    	$dataGrid->setCaption('ciudades_id', 'CIUDAD');
    	$dataGrid->delete	=	$controller_name . '/delete';
    	$dataGrid->edit		=	$controller_name . '/edit';
    	$dataGrid->delete_confirm	=	'Eliminar el registro {rut}-{dv}';
?>
<? View::partial('datagrid/default',false,array('dataGrid'=>$dataGrid)); ?>
</source>



===Screenshots===
Modelo Paises

[[Archivo:Model_paises.gif]]

[[Archivo:DataGrid2.png]]

===Descargar===
[https://sourceforge.net/projects/helperdatagrid/files/dataGrid%20Jquery-ui%20Beta1%20rc0.9.tar.gz/download Descargar] para '''Spirit v1.0 beta1''' con temas de jquery-ui





[[Categoría:Helpers]]
[[Categoría:Tutoriales KumbiaPHP]]