Defina el nombre de formulario: Función:Form('formName', doForm);Parámetros:

formName	:	Nombre del formulario
doForm	:	true = phpMyDatagrid generará automáticamente el formulario (Debe usar esta opción si desea que phpMyDataGrid cargue imágenes al servidor) false = phpMyDataGrid usará un formulario creado por el programador

Ejemplo de uso:

$objGrid -> Form('employees', true);

Arriba

« • »

Defina el método del formulario: Función:methodForm('strMethod');Parámetros:

strMethod

:

Puede usar cualquiera de los métodos de formulario disponibles, GET o POST

Ejemplo de uso:

$objGrid -> methodForm('post');

Importante: Si está haciendo el llamado a phpMyDataGrid desde un formulario definido por el programador, deberá usar el mismo método usado en el formulario.

Arriba

« • »

Si usted traslada a la página del script sus propios parámetros, debería continuar trasladándolos al script del dataGrid, para esto, utilice: Función:linkparam("parameters");Parámetros:

parameters

:

Debe definir la lista de parámetros de la misma forma que se crean parámetros del tipo GET

Ejemplo de uso:

$objGrid -> linkparam("&session={$session}&userid={$userid}&option=4");

Importante:

Las variables que se han incluido en la lista de parámetros deben haber sido previamente capturadas, por ejemplo, para capturar la variable session:

Si el envío es con GET:
$session = $_GET['session'];

Si el envío es con POST:
$session = $_POST['session'];

Si no conoce el origen del envío, o el envío puede ser mixto (GET y POST):
$session = (isset($_GET['session'])?$_GET['session']:(isset($_POST['session'])?$_POST['session']:''));

Nótese que la lista de parámetros se encuentra delimitada por comillas dobles y el nombre de las variables encerrado entre llaves {}, así las variables son reemplazadas por su valor.

Arriba

« • »

Si desea tener un menú contextual con las opciones de mantenimiento, utilice la siguiente línea: Función:useRightClickMenu('ruta');Parámetros:

ruta

:

escriba la ruta completa, incluyendo el nombre del archivo de la clase phpMyMenu.

Ejemplo de uso:

$objGrid -> useRightClickMenu('phpMyMenu.inc.php');

Arriba

« • »

Para definir el modo en que se genera el código HTML: Función:friendlyHTML(bolStat);Parámetros:

bolStat

:

true = si desea que el código HTML generado sea legible
false = Si desea que el código fuente generado esté 'obfuscado'

Ejemplo de uso:

$objGrid -> friendlyHTML(true);

Arriba

« • »

Para compatibilidad con XHTML utilice esta función: Función:closeTags(bolStat);Parámetros:

bolStat

:

true = si desea que el HTML generado sea correcto para la declaración XHTML
false = Si desea que el código generado sea compatible con HTML

Ejemplo de uso:

$objGrid -> closeTags(false);

Arriba

« • »

Para definir la ruta (camino) en el cual se encuentran los iconos del datagrid: Función:pathtoimages('strPath');Parámetros:

strPath

:

Escriba la ruta en la cual se encuentran ubicados los archivos de imagen

Ejemplo de uso:

$objGrid -> pathtoimages('/images/');

Arriba

« • »

Es necesario establecer una conexión con el servidor de bases de datos, para esto utilice la siguiente función: Función:conectadb('strServer', 'strUsername', 'strPassword', 'strDatabase', 'useADOdb', 'strType', intPort);Parámetros:

strServer	:	Nombre o dirección IP del servidor
strUsername	:	Nombre de usuario de la base de datos
strPassword	:	Contraseña de usuario de la base de datos
strDatabase	:	Nombre de la base de datos
useADOdb	:	true = Ralizará la conexión a la base de datos usando la liberia ADOdb false = Utilizará los drivers nativos de php para conectarse a MySQL
strType	:	Tipo de servidor de base de datos (aplica solamente para conexiones realizadas con ADOdb)
intPort	:	Puerto de escucha de la base de datos

Ejemplo de uso:

$objGrid -> conectadb('localhost', 'root', '%my12PaSS%', 'testdb', 'false', 'mysql', 3306);

Importante: Si decide utilizar la librería ADOdb para realizar la conexión, deberá descargarla desde su sitio web, asi mismo, deberá incluirla al inicio del script

Arriba

« • »

El idioma predeterminado para los mensajes de phpMyDataGrid es inglés, si desea cambiar el idioma, utilice esta función: Función:language('strLang');Parámetros:

strLang

:

Escriba el código ISO de dos caracteres del idioma

Ejemplo de uso:

$objGrid -> language('es');

Importante: phpMyDataGrid Professional tiene como idiomas base el español es y el inglés en, si desea adicionar otro idioma, basta con que lo cree en la carpeta languages

Arriba

« • »

Para habilitar o desabilitar los iconos de mantenimiento, utilice la siguiente función: Función:buttons(bolAdd, bolUpd, bolDel, bolChk, intColumn, 'strColumnName');Parámetros:

bolAdd	:	true = Habilita el sistema de adición de registros del grid false = Desabilita el sistema de adición de registros del grid
bolUpd	:	true = Habilita el sistema de actualización de registros del grid false = Desabilita el sistema de actualización de registros del grid
bolDel	:	true = Habilita el sistema de borrado de registros del grid false = Desabilita el sistema de borrado de registros del grid
bolChk	:	true = Habilita el sistema de visualización de registros del grid false = Desabilita el sistema de visualización de registros del grid
intColumn	:	Define la posición (columna) en la cual se desea mostrar los iconos de mantenimiento (-1 indica al final del grid)
strColumnName	:	Llene este campo, si desea mostrar un título en la columna de iconos

Ejemplo de uso:

$objGrid -> buttons(true, true, true, true, -1, 'Column Title');

Arriba

« • »

Para habilitar o desabilitar las opciones de exportar, utilice la siguiente función: Función:export(bolExportsheet, bolExportCSV, bolExportXML, bolPrinter, bolExportPDF, 'pdfOrientation');Parámetros:

bolExportsheet	:	true = Habilita la opción de exportar a Hoja de cálculo (XLS) false = Desabilita la opción de exportar a Hoja de cálculo (XLS)
bolExportCSV	:	true = Habilita la opción de exportar a archivo separado por comas (CSV) false = Desabilita la opción de exportar a archivo separado por comas (CSV)
bolExportXML	:	true = Habilita la opción de exportar a XML false = Desabilita la opción de exportar a XML
bolPrinter	:	true = Habilita la opción de imprimir false = Desabilita la opción de imprimir
bolExportPDF	:	true = Habilita la opción de exportar a PDF false = Desabilita la opción de exportar a PDF
pdfOrientation	:	Selecciona la orientación de la página al exportar a PDF (P) = Vertical (L) = Horizontal

Ejemplo de uso:

$objGrid -> export(true, true, true, true, true, 'P');

Arriba

« • »

Si desea tener una columna con casillas de verificación para selección múltiple, utilice la siguiente función: Función:checkable(status);Parámetros:

status

:

true = Habilita la columna de casillas de verificación
false = Desabilita la columna de casillas de verificación

Ejemplo de uso:

$objGrid -> checkable(false);

Arriba

« • »

Para definir un título en el grid, utilice: Función:TituloGrid('strTitle');Parámetros:

strTitle

:

Ejemplo de uso:

$objGrid -> TituloGrid('Titulo del grid');

Arriba

« • »

Para definir un pie de página en el grid, utilice: Función:FooterGrid('strFooter');Parámetros:

strFooter

:

Ejemplo de uso:

$objGrid -> FooterGrid('Pie de página del Grid, © 2024 Gurú Sistemas');

Arriba

« • »

Para controlar la cantidad de registros a visualizar por cada página: Función:datarows(intLines);Parámetros:

intLines

:

Cantidad de registros por página

Ejemplo de uso:

$objGrid -> datarows(15);

Arriba

« • »

Si desea definir la cantidad de páginas que se mostrarán antes de resumir con ... puede hacerlo cambiando la cantidad con esta funcion: Función:linksperpage('amount');Parámetros:

amount

:

Escriba la cantidad de links que desea visualizar

Ejemplo de uso:

$objGrid -> linksperpage('4');

Importante: No defina cantidades muy grandes ya que pueden distorsionar la estructura del Grid

Si define linksperpage = 5, verá algo como:
1 2 3 4 5 ... 15 16 17 18 19 20 21 22 23 24 25 ... 45 46 47 48 49

Arriba

« • »

Para cambiar el formato de paginación, utilice: Función:paginationmode('pgm',inTable);Parámetros:

pgm	:	Defina el tipo de paginación, existen 3 valores disponibles: links = Genera un a lista de números de página que indican el número de página al que se desea ir (Recomendado tablas con no mas de 20 páginas) select = Genera un menú desplegable que permite elegir el número de página a la que desea ir mixed = Genera un listado combinando los métodos links y select (valor predeterminado) input = Crea un cuadro de texto para que el usuario escriba el número de página
inTable	:	este parámetro ya no tiene ninguna funcion, esta aqui por compatibilidad con versiones anteriores

Ejemplo de uso:

$objGrid -> paginationmode('mixed',false);

Arriba

« • »

Puede definir un código de seguridad (palabra mágica) que ayudará a phpMyDataGrid a ser más seguro: Función:salt('code');Parámetros:

code

:

Ejemplo de uso:

$objGrid -> salt('salt&pepper');

Arriba

« • »

Defina la cantidad de dígitos decimales que desea mostrar en los campos de tipo numérico: Función:decimalDigits('amount');Parámetros:

amount

:

Ejemplo de uso:

$objGrid -> decimalDigits('2');

Arriba

« • »

Puede definir el caracter que desea utilizar como separador decimal: Función:decimalPoint('char');Parámetros:

char

:

Ejemplo de uso:

$objGrid -> decimalPoint('.');

Arriba

« • »

La edición en línea puede estar: desactivada, activarse con un solo click y grabar al salir del campo, o solicitar confirmación de grabación, esto puede ser definido desde la función: Función:ajax('style', clicks);Parámetros:

style	:	none = Deshabilita la edición en línea default = Habilita la edición en línea con confirmación de grabación silent = Habilita la edición en línea con grabación automática
clicks	:	Define la cantidad de clicks necesarios para activar la edición en línea. 1 - Click sencillo 2 - Doble click

Ejemplo de uso:

$objGrid -> ajax('none', 1);

Arriba

« • »

Si desea diferenciar en pantalla los valores que han sido modificados via AJAX, puede usar esta función: Función:AjaxChanged('strColor');Parámetros:

strColor

:

Debe ser un color hexadecimal válido

Ejemplo de uso:

$objGrid -> AjaxChanged('#900');

Arriba

« • »

Si por algún motivo requiere controlar si se está realizando una llamada AJAX a la página puede usar esta función: Función:isAjaxRequest();Ejemplo de uso:

$objGrid -> isAjaxRequest();

Importante: Puede usar la función para determinar si la solicitud a la página fue una llamada AJAX

if ($objGrid -> isAjaxRequest()){
echo 'esto se hace en el proceso AJAX';
} else {
echo 'esta es una solicitud directa';
}

Arriba

« • »

Usted puede personalizar las acciones que realizarán los botones de mantenimiento: Función:setAction('button', 'event');Parámetros:

button	:
event	:

Ejemplo de uso:

$objGrid -> setAction('add', 'javascript_function()');

Importante: Consideraciones a tener en cuenta a la hora de asignar nuevas acciones a los botones:

Botón Adicionar = Ninguna en especial
Ejemplo: $objGrid -> setAction('add','nuevo_adicionar()');

Botón Editar = la función deberá contener dos parámetros, los cuales deben ir delimitados asi: (\"%s\",\"%s\");
Ejemplo: $objGrid -> setAction('edit','nuevo_editrow(\"%s\",\"%s\")');

Botón Borrar = la función deberá contener dos parámetros, los cuales deben ir delimitados asi: (\"%s\",\"%s\");
Ejemplo: $objGrid -> setAction('delete','nuevo_deleterow(\"%s\",\"%s\")');

Botón Buscar = Ninguna en especial
Ejemplo: $objGrid -> setAction('search','nuevo_buscar()');

Botón Ver = la función deberá contener dos parámetros, los cuales deben ir delimitados asi: (\"%s\",\"%s\");
Ejemplo: $objGrid -> setAction('view','nuevo_viewrow(\"%s\",\"%s\")');

Arriba

« • »

Es necesario definir la tabla sobre la cual trabajará el grid: Función:tabla('strTable');Parámetros:

strTable

:

Ejemplo de uso:

$objGrid -> tabla('employees');

Arriba

« • »

Puede definir una condición del tipo WHERE para filtrar y mostrar solo los registros que cumplan con una condición: Función:where('strWhere');Parámetros:

strWhere

:

Ejemplo de uso:

$objGrid -> where('active = 1');

Arriba

« • »

Si necesita agrupar registros por algún campo, o campos, puede usar la función: Función:groupby('strGroup');Parámetros:

strGroup

:

Ejemplo de uso:

$objGrid -> groupby('status');

Importante: Tenga en cuenta que al agrupar datos, las funcionalidades de mantenimiento (Adicionar, Editar, Borrar, edición en línea), no funcionarán correctamente, por lo tanto se recomienda deshabilitarlas, o si es necesario, aplicar sus propios procesos de mantenimiento.

Arriba

« • »

Puede definir una condición del tipo HAVING para filtrar y mostrar solo los registros que cumplan con una condición: Función:having('strHaving');Parámetros:

strHaving

:

Ejemplo de uso:

$objGrid -> having('active = 1');

Arriba

« • »

Defina los campos por los cuales desea ordenar los registros: Función:orderby('fields','style');Parámetros:

fields	:	Lista de campos por los que desea ordenar la salida, separada por comas
style	:	Defina el tipo de ordenamiento para cada campo ASC o DESC, en caso de dejar en blanco, se usará automáticamente ASC

Ejemplo de uso:

$objGrid -> orderby('name,lastname','asc,desc');

Arriba

« • »

La versión professional cuenta con una característica de ordenamiento manual, la cual sirve, por ejemplo para definir el orden en el que aparecerán los productos de una página: Función:setorderarrows('field');Parámetros:

field

:

El campo de consecutivo NO debería ser el ID

Ejemplo de uso:

$objGrid -> setorderarrows('consecutivo');

Importante: El campo de ordenamiento debe ser consecutivo y no debe ser autoincrementable, para los ejemplos prácticos que hemos desarrollado, siempre el consecutivo es inicialmente igual al ID autoincrementable del registro.

Arriba

« • »

Por defecto, phpMyDataGrid habilita las flechas de ordenamiento en los títulos de todas las columnas, si desea desactivar esta característica utilice la siguiente función: Función:noorderarrows();Ejemplo de uso:

$objGrid -> noorderarrows();

Importante: Si desea deshabilitar el ordenamiento de solo unas cuantas columnas del grid, NO utilice esta función, en su lugar utilice chField especificando los parámetros necesarios.

Arriba

« • »

phpMyDataGrid Genera automáticamente las consultas SQL basado en la información suministrada, pero en algunas ocasiones es necesario generar consultas avanzadas que requieren que el programador las defina manualmente, para eso puede usar esta función: Función:sqlstatement('strSQL','strCount');Parámetros:

strSQL	:
strCount	:

Ejemplo de uso:

$objGrid -> sqlstatement('SELECT *, now() as fecha from employees','select count(*) from employees');

Importante: Las consultas SQL manuales no deben incluir las sentencias WHERE, GROUP u ORDER, estas deben ser definidas directamente desde las funciones disponibles.
También debe tener en cuenta que es muy importante que todos los nombres de campos que utilice en el grid, se encuentren definidos en la consulta SQL

Arriba

« • »

Para el programador es indispensable poder hacer seguimiento al comportamiento de los scripts, esta función permite al programador recibir correos electrónicos con 'eventuales' errores SQL que se puedan generar: Función:reportSQLErrorsTo('strMail', 'bolShow');Parámetros:

strMail	:	Escriba la dirección de e-mail del programador
bolShow	:	true = Muestra los errores SQL en pantalla durante la ejecución (Recomendado en desarrollo) false = Oculta cualquier error SQL generado (Recomendado en entornos productivos)

Ejemplo de uso:

$objGrid -> reportSQLErrorsTo('developer@thecompanymail.com', 'false');

Importante: Esta función hace uso de la sentencia mail() de php, por lo tanto para que funcione correctamente, deberá estar configurada y activa

Arriba

« • »

Para operaciones de mantenimiento es necesario definir un campo clave, utilice la función: Función:keyfield('strField');Parámetros:

strField

:

Ejemplo de uso:

$objGrid -> keyfield('id');

Arriba

« • »

phpMyDataGrid le permite hacer búsquedas, puede definir los campos por los que desea buscar información usando la siguiente función: Función:searchby('listoffields');Parámetros:

listoffields

:

Puede adicionar la instrucción :SELECT al nombre del campo para mostrar un menú desplegable con los posibles valores de búsqueda.

Ejemplo de uso:

$objGrid -> searchby('firstname,lastname,date:select');

Arriba

« • »

Si desea generar un enlace para controlar el proceso de 'desfiltrar' después de realizar búsquedas, puede usar esta función: Función:getResetSearch(icon);Parámetros:

icon

:

Define si se devuelve solo texto o una imagen representativa, valor predeterminado: false

Ejemplo de uso:

$objGrid -> getResetSearch(false);

Arriba

« • »

Una de las funciones principales es FormatColumn, con esta función usted definirá las características de cada uno de los campos que mostrará en grid: Función:FormatColumn('strfieldName','strHeader','fieldWidth','maxlength','inputtype','columnwidth','align','Mask','default','cutChar');Parámetros:

strfieldName	:	Nombre del campo en la tabla
strHeader	:	Título de la columna
fieldWidth	:	Solo usado en campos de tipo textarea, identifica la cantidad de líneas que contendrá el textarea
maxlength	:	Longitúd máxima de caracteres a aceptar en el campo
inputtype	:	Tipo de campo 0 = Campo Normal 1 = Campo de solo lectura 2 = Campo Oculto 3 = Imágen, cálculo o enlace sin relación con campo en la tabla 4 = Imágen, cálculo o enlace relacionado con un campo en la tabla
columnwidth	:	Ancho de la columna (En píxeles)
align	:	Alineación del texto en la columna center = Centrado (Valor predeterminado) left = Ajuste del texto a la Izquierda right = Ajuste del campo a la derecha
Mask	:	Enmascaramiento para el campo text = Campo normal de texto (Valor predeterminado) textarea = Región de edición de texto (puede tener un mayor área que los campos tipo text) image = Muestra una imágen, puede ser relacionada con un campo o fija. (ver ejemplos) imagelink = Muestra una imágen con enlace, puede ser relacionada a un campo o fija. (ver ejemplos) number = Campo numérico money = Campo numérico con formato de moneda, forma de uso: money:signo, ejemplo money:$ money:£ date = Campo tipo fecha, forma de uso: date:formato:separador, ejemplo date:dmy:/ date:ymd:- datetime = Campo tipo fecha y hora, forma de uso: datetime:formatofecha:separador:formatohora,separador, ejemplo datetime:datetime:mdy:/:His,: o datetime:mdy:/:hisa,: link = Campo con enlace. ver ejemplos password = Campo tipo contraseña (Protegido con asteriscos) calc = Campo calculado. ver ejemplos scalc = Campo calculado que almacena el valor del cálculo, ver ejemplos bool = Campo Booleano, genera una casilla de verificación y almacena 0 si no esta checkeada y 1 si esta chequeada check = Igual al campo tipo bool select = Campo con menú de opciones, las opciones pueden ser manualmente definidas, o dinámicamente desde otra tabla de la base de datos. 0 = Campo numérico sin decimales 1 = Campo numérico con 1 decimales 2 = Campo numérico con 2 decimales 3 = Campo numérico con 3 decimales 4 = Campo numérico con 4 decimales integer = Campo numérico sin decimales related = Busca un registro coincidente en otra tabla y muestra la relación array() - conditional = Muestra una respuesta analizando una serie de condiciones dadas. (ver ejemplos)
default	:	Valor predeterminado del campo (se usa solo en la opción de adicionar nuevos registros)
cutChar	:	Util en campos de tipo textarea que contengan mucha información, con esta opción solo mostrará los primeros X caracteres mientras visualice la información en el grid, para ver la información completa puede usar la opcion Ver registro

Ejemplo de uso:

$objGrid -> FormatColumn('lastname','Apellido','0','20','0','80','center','text','','');

Arriba

« • »

Puede definir características adicionales a cada una de las columnas, para esto basta con usar: Función:chField('strfieldName', 'permissions', overwrite)Parámetros:

strfieldName	:	Nombre del campo
permissions	:	N+ = Visualizar campo al adicionar registro N- = Ocultar campo al adicionar registro E+ = Visualizar campo al editar registros E- = Ocultar campo al editar registros V+ = Visualizar campo al ver registro V- = Ocultarcampo al ver registro R = Quitar flechas de ordenamiento a este campo U = Si es un campo de tipo image permita cargar fotos en el campo M = Habilita la opción de cargar imágenes sobre imágenes ya exitentes
overwrite	:	Define si las definiciones realizadas anteriormente al campo deberán ser borradas o acumulativas

Ejemplo de uso:

$objGrid -> chField('nombrecampo', 'N+', false)

Importante: Tenga en cuenta que si desea asignar varios modificadores al mismo campo, debe hacerlo en la misma solicitud, por ejemplo:
$objGrid -> chField('firstname','N-E+V+R');

Arriba

« • »

Define el ancho de los campos de texto al adicionar/editar: Función:setInputWidth('field','width');Parámetros:

field	:
width	:

Ejemplo de uso:

$objGrid -> setInputWidth('Nombre campo','300px');

Arriba

« • »

Si desea realizar validaciones javascript sobre el campo, utilice la siguiente función: Función:jsValidate('strField', 'strValidation', 'strErrorMessage', 'strDisplayMessage');Parámetros:

strField	:	Nombre del campo
strValidation	:	Código JavaScript para validar el campo, (Puede tambien llamar una función JS)
strErrorMessage	:	Mensaje de error cuando no se cumpla la condición
strDisplayMessage	:	Mensaje descriptivo de la información que deberá digitar el usuario

Ejemplo de uso:

$objGrid -> jsValidate('firstname', 'this.value.length>=8', 'El nombre debe contener más de 7 caracteres', 'Por favor escriba el nombre del cliente');

Importante: La validación Javascript se usará en los procesos Nuevo y Edición, y también en el proceso de edición en línea, cabe tener en cuenta que las validaciones solo se realizan sobre el campo activo, no se pueden realizar operaciones con los otros campos de la tabla.

Arriba

« • »

Si no desea validar la entrada de datos, pero desea dar indicaciones al usuario sobre la información que deberá digitar, utilice: Función:fldComment('strField', 'strDisplayMessage');Parámetros:

strField	:	Nombre del campo
strDisplayMessage	:	Mensaje de ayuda al usuario

Ejemplo de uso:

$objGrid -> fldComment('lastname', 'Escriba el apellido del cliente');

Importante: Los mensajes de ayuda no serán mostrados durante el proceso de edición en línea, sin embargo, se visualizarán en los procesos normales de crear y editar registros.

Arriba

« • »

Si en su lista de campos existe alguno de tipo "date" y desea que phpMyDataGrid utilice un calendario (datepicker) para la selección de fechas, utilice: Función:useCalendar(bolCalendar);Parámetros:

bolCalendar

:

Ejemplo de uso:

$objGrid -> useCalendar(true);

Arriba

« • »

Para totalizar columnas, utilice: Función:total('fields');Parámetros:

fields

:

Lista de campos a totalizar separados por coma

Ejemplo de uso:

$objGrid -> total('salary,days,total');

Importante: Recuerde que ahora también puede totalizar columnas calculadas

Arriba

« • »

Define el tamaño (ancho y alto) para mostrar imágenes en un campo: Función:setImageSize('campo','ancho','alto');Parámetros:

campo	:	Nombre del campo
ancho	:	Ancho en px (Solo el valor numérico)
alto	:	Height en px (Solo el valor numérico

Ejemplo de uso:

$objGrid -> setImageSize('NombreCampo','95','127');

Importante: Esta función no cambiará el tamaño de las imágenes almacenadas, sólo cambiará el tamaño de la imagen en la salida del navegador.

Arriba

« • »

Permite definir un formato condicional para CELDAS que cumplan una condición: Función:addCellStyle('campo','condicion', 'estilo');Parámetros:

campo	:	Nombre del campo
condicion	:	Cadena, condición.
estilo	:	Nombre de la clase CSS a ejecutar

Ejemplo de uso:

$objGrid -> addCellStyle('NombreCampo','["activo"]==1', 'nombreClaseCSS');

Importante: Es posible usar cualquier campo que se encuentre en uso dentro del grid, basta con escribir el nombre del campo entre [' ... '].

Arriba

« • »

Permite definir un formato condicional para FILAS que cumplan una condición: Función:addRowStyle('condicion', 'estilo');Parámetros:

condicion	:	Cadena, condición.
estilo	:	Nombre de la clase CSS a ejecutar

Ejemplo de uso:

$objGrid -> addRowStyle('["activo"]==1', 'nombreClaseCSS');

Importante: Es posible usar cualquier campo que se encuentre en uso dentro del grid, basta con escribir el nombre del campo entre [' ... '].

Arriba

« • »

Define la ruta para imágenes relacionadas a un skin: Función:skinimages('skin', 'ruta');Parámetros:

skin	:	Nombre del skin
ruta	:	Ruta de las imágenes

Ejemplo de uso:

$objGrid -> NombreSkinimages('NombreSkin', 'skins/%s/icons/');

Importante: El %s en la ruta será reemplazado con el nombre del skin, si el %s no existe, la ruta sera tomada tal como esté.

Arriba

« • »

Modifica el valor a almacenar especificado en la edición en línea: Función:setNewInlineData('newData');Parámetros:

newData

:

Nuevos datos al momento de guardar una edición en línea

Ejemplo de uso:

$objGrid -> setNewInlineData('nuevosDatos');

Arriba

« • »

Define una función JS a ejecutar despues de actualizar en línea, puede tener los parámetros (idkey,field,newtext,oldtext): Función:onAjaxUpdate('js');Parámetros:

js

:

Nombre de la función javascript que desea ejecutar al finalizar la grabación inline

Ejemplo de uso:

$objGrid -> onAjaxUpdate('javascriptFunction(idkey,field,newtext,oldtext)');

Arriba

« • »

Devuelve el valor de la acción AJAX que se está ejecutando: Función:getAjaxID();Ejemplo de uso:

$objGrid -> getAjaxID();

Arriba

« • »

Devuelve los códigos de las casillas de verificación seleccionadas: Función:getCheckedBoxes();Ejemplo de uso:

$objGrid -> getCheckedBoxes();

Arriba

« • »

Devuelve verdadero si la acción AJAX que se esta realizando es Adición de datos: Función:isadding();Ejemplo de uso:

$objGrid -> isadding();

Arriba

« • »

Devuelve verdadero si se esta grabando una edición en línea: Función:isOnlineEdition();Ejemplo de uso:

$objGrid -> isOnlineEdition();

Arriba

« • »

Devuelve la información que está siendo editada en línea: Función:getEditedData();Ejemplo de uso:

$objGrid -> getEditedData();

Arriba

« • »

Muestra una nueva imagen basándose en los parametros recibidos: Función:changeImage();Ejemplo de uso:

$objGrid -> changeImage();

Arriba

« • »

Adiciona un separador a la barra de botones: Función:addSeparator();Ejemplo de uso:

$objGrid -> addSeparator();

Importante: Esta función solo es válida si la propiedad toolbar es verdadera

Arriba

« • »

Adiciona opciones a la barra de botones: Función:addButton('img', 'action', 'message');Parámetros:

img	:	Ruta y nombre del icono a mostrar en la barra de botones
action	:	Nombre de la función javascript que desea ejecutar
message	:	Mensaje que acompañará al icono

Ejemplo de uso:

$objGrid -> addButton('/path/to/image.png', 'javascriptFunction()', 'Message In Toolbar');

Importante: Esta función solo es válida si la propiedad toolbar es verdadera

Arriba

« • »

Adiciona un menú desplegable a la barra de botones: Función:addSelect('arrData', 'action', 'message');Parámetros:

arrData	:	'toDisplay1','key2'=>'toDisplay2','key3'=>'toDisplay3','keyN'=>'toDisplayN')' onblur='ut("$objGrid","58","addSelect(¬c¬arrData¬c¬, ¬c¬action¬c¬, ¬c¬message¬c¬);","ta58","arrData,action,message",false)' />
action	:	Nombre de la función javascript que desea ejecutar
message	:	Mensaje que acompañará al icono

Ejemplo de uso:

$objGrid -> addSelect('array('key1'=>'toDisplay1','key2'=>'toDisplay2','key3'=>'toDisplay3','keyN'=>'toDisplayN')', 'javascriptFunction()', 'Message In Toolbar');

Importante: Esta función solo es válida si la propiedad toolbar es verdadera

Arriba

« • »

Esta función está disponible para la compatibilidad con versiones anteriores, no se recomienda para ser utilizada, es ideal que se inserte el JS y CSS manualmente o usando la función set_DG_Header: Función:setHeader('phpScriptFile', 'jsFile', 'cssFile', 'jsCalFile', 'cssCalFile', 'jsmmenu');Parámetros:

phpScriptFile	:	Nombre del script que se esta ejecutando
jsFile	:	Ruta y nombre del archivo de scripts del datagrid
cssFile	:	Ruta y nombre del archivo de estilos del datagrid
jsCalFile	:	Ruta y nombre del archivo que contiene el calendario Datepicker
cssCalFile	:	Ruta y nombre del archivo de estilos del calendario
jsmmenu	:	Ruta y nombre del archivo que controla el menú contextual en el grid

Ejemplo de uso:

$objGrid -> setHeader('sample.php', 'js/dgscripts.js', 'css/dgstyle.css', 'js/dgcalendar.js', 'css/dgcalendar.css',  'mmscripts.js');

Importante: Para mayor flexibilidad y facilidad del programador se recomienda NO usar esta función, en su lugar inserte los archivos CSS y JS como normalmente lo haria con otros archivos de este tipo.

Arriba

« • »

Finalmente, realice el llamado a la función que renderizará el grid basándose en toda la configuración anteriormente suministrada: Función:grid();Ejemplo de uso:

$objGrid -> grid();

Arriba

« • »

Si necesita pasar parámetros a una consulta SQL se recomienda utilizar esta función la cual analizará el contenido de la variable, y la modificará de ser necesario para evitar inyecciones SQL.: Función:magic_quote($variable);Ejemplo de uso:

magic_quote($variable);

Importante: Tenga en cuenta que esta función no hace parte de la classe del datagrid, por lo cual, no se debe llamar como un objeto sino como función independiente!

Arriba

« • »

Se recomienda a la hora de incluir los archivos JS y CSS hacerlo usando esta función, ver ejemplos para mayor claridad: Función:set_DG_Header('path/to/JS/', 'path/to/CSS/', 'closetagChar', 'skinName')Ejemplo de uso:

set_DG_Header('path/to/JS/', 'path/to/CSS/', 'closetagChar', 'skinName')

Importante: Tenga en cuenta que esta función no hace parte de la classe del datagrid, por lo cual, no se debe llamar como un objeto sino como función independiente!

Arriba

« • »