XGAP - Generated Documentation (phpDocumentor 2)
\

\Form

Clase Form

Clase estática que provee elementos de formulario de HTML.

Summary

Methods
Properties
Constants
text()
autocompletable()
select()
select_multiple()
textarea()
htmlarea()
checkbox()
checkbox_con_hidden()
radio()
radio_grupo()
hidden()
submit()
reset()
button()
password()
file_simple()
file()
label()
abrir()
cerrar()
abrir_grupo()
cerrar_grupo()
agregar_imprimir()
radio_bd()
combo_bd()
combo_bd_sin_hidden()
recuperar_inputs_filtros_personalizados()
agregar_navegador()
abrir_buscador()
cerrar_buscador()
generar_buscador()
agregar_boton_accion_listado()
spin_button()
tiempo()
spin_rango()
No public properties found
COMBO_TEXTO_OPCION_VACIA
SUF_FILE_CHECK_CONSERVAR
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

COMBO_TEXTO_OPCION_VACIA

COMBO_TEXTO_OPCION_VACIA

Define el valor predeterminado del texto que se muestra en campos de tipo combo para indicar la opción que corresponde a selección vacía.

SUF_FILE_CHECK_CONSERVAR

SUF_FILE_CHECK_CONSERVAR

Sufijo que se agrega al nombre del campo para definir el nombre del control que indica si se debe conservar el archivo actual, en {@link Form::file() file()}.

Methods

text()

text(string  $nombre, string  $actual, boolean  $read_only = false, integer  $len = null, integer  $size = null, string  $clase = "Input", boolean  $uppercase = false, string  $onchange = "", string  $extra = '', boolean  $retornar = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null) : mixed

Genera un input de tipo text.

Parameters

string $nombre
string $actual
boolean $read_only
integer $len
integer $size
string $clase
boolean $uppercase
string $onchange
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
\MultipleFormField|boolean $campo_multiple
string $titulo

Returns

mixed —

string o nada, dependiendo de $retornar

autocompletable()

autocompletable(string  $nombre, string  $campo, string  $pag_consulta, integer  $demora = 300, integer  $long_min = 4, integer  $tam_pagina = 10, string  $ancho_lista = null, array  $params_request_est = array(), array  $params_request_din = array(), array  $columnas = null, integer  $ind_columna_campo, array  $columnas_desplegar = null)

Genera código javascript que implementa autocompletado de un campo, permitiendo al usuario seleccionar un valor en una lista que se presenta dinámicamente, filtrada por el texto que ya contiene el campo.

Define una variable global javascript con nombre {$nombre}_search, que referencia un objeto ExtJS Ext.form.ComboBox.

Obtiene los valores a mostrar realizando una consulta AJAX a un archivo que debe retornar los datos en formato JSON con la siguiente estructura:

{
    total: { int: número total de filas, sin tener en cuenta paginación },
    ok: { boolean: ¿la consulta se realizó correctamente y devuelve datos válidos? },
    filas: [ { array: filas del resultado }
        {
            __n: { id de la fila (puede ser cualquier valor único en la lista de filas) },
            { valores para las restantes columnas dadas por $columnas}
        }, ...
    ]
}

El archivo $pag_consulta recibe en el request los siguientes parámetros, además de los indicados en $params_request_est y $params_request_din:

  • 'c' = $campo
  • 'f' = { texto para filtrar los resultados }
  • 'pi' = { paginación: fila inicial }
  • 'pl' = { paginación: cantidad de filas por página }

Parameters

string $nombre

nombre del campo de formulario que corresponde al campo
string $campo

nombre del campo xgap
string $pag_consulta

url del archivo al cual se realiza la consulta
integer $demora

tiempo en milisegundos que debe esperarse antes de enviar la consulta
integer $long_min

cantidad mínima de caracteres que debe contener el campo antes de enviar la consulta
integer $tam_pagina

cantidad de valores que se muestran en cada página de la lista desplegable
string $ancho_lista

ancho de la lista desplegable; ejemplos: 100 (se asume px); 100px; 15em
array $params_request_est

parámetros a pasar en el request al realizar la consulta, que tienen valores estáticos (dados en el momento de generar la página); debe ser una lista de pares {nombre del parámetro} => {valor}
array $params_request_din

parámetros a pasar en el request al realizar la consulta, que tienen valores dinámicos (se obtienen cuando el campo recibe el foco); debe ser una lista de pares {nombre del parámetro} => {nombre del campo origen del valor}
array $columnas

lista de nombres de columnas que retorna la consulta; si es null se asume que retorna una columna de nombre $campo
integer $ind_columna_campo

índice de $columnas que contiene el nombre de la columna cuyo valor se debe aplicar al campo
array $columnas_desplegar

lista de nombres de columnas a mostrar en cada fila de la lista desplegable; si no se provee, se muestra sólo la indicada por $ind_columna_campo

select()

select(string  $nombre, string  $actual, array  $datos, string  $clase = "Select", string  $extra = '', boolean  $retornar = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, array  $propiedades_extra_opciones = null) : mixed

Genera un combo estándar (select no múltiple).

Ejemplo:

$datos = array( 'f1' => 'Peras', 'f2' => 'Naranjas', 'f3' => 'Manzanas' ); $peo = array( array('style' => 'color: #00F;'), array('style' => 'color: #0F0;', 'nuevapropiedad' => '1'), array('class' => 'ultimo') ); Form::select('ej1', 'f1', $datos, 'Select', "onchange='alert(\'Cambio\');'", false, null, 'Ejemplo', $peo);

Genera:

<select id='ej1' name='ej1' class='Select' title='Ejemplo' onchange='alert(\'Cambio\');'>
<option value='f1' selected='selected' style='color: #00F;'>Peras</option>
<option value='f2' style='color: #0F0;' nuevapropiedad='1'>Naranjas</option>
<option value='f3' class='ultimo'>Manzanas</option>
</select>

Nota: las propiedades dadas en $propiedades_extra_opciones se aplican mediante JavaScript, no con código HTML. En el ejemplo se muestran como HTML por claridad.

Parameters

string $nombre

nombre (id) del combo
string $actual

valor seleccionado; debe ser una de las claves en $datos
array $datos

arreglo de pares (valor => etiqueta) que define los elementos del combo
string $clase

nombre de la clase CSS para el elemento select
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
\MultipleFormField|boolean $campo_multiple
string $titulo

valor para el atributo title
array $propiedades_extra_opciones

array con índices enteros de arrays asociativos, que definen propiedades javascript que se deben establecer en las opciones del combo; cada elemento en $propiedades_extra_opciones se aplica a la opción definida por el elemento correspondiente (por posición) en $datos; las claves y valores del array interno indican los nombres y valores, respectivamente, de las propiedades javascript.

Returns

mixed —

string o nada, dependiendo de $retornar

select_multiple()

select_multiple(string  $nombre, array  $actual, array  $datos, string  $clase = "Select Multiple", string  $extra = '', boolean  $retornar = false, integer  $altura = null, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, array  $propiedades_extra_opciones = null, boolean  $controles_seleccion = false, array  $opciones_controles_seleccion = null) : mixed

Genera un combo de selección múltiple (lista).

Opcionalmente puede generar controles para cambiar la selección de los elementos: seleccionar todos, deseleccionar todos y/o restaurar la selección inicial. Si se incluyen ($controles_seleccion == true), se pueden especificar diversas opciones mediante el parámetro $opciones_controles_seleccion, el cual es un array que acepta los siguientes pares clave => valor (todos opcionales):

  • Referencia: {clave} => {tipo valor} [{por defecto}] {descripción}
  • 'todos-mostrar' => boolean [true]: ¿Mostrar el control "todos"?
  • 'todos-etiqueta' => string ['T']: Etiqueta para el control "todos"
  • 'todos-titulo' => string ['Seleccionar todo']: Etiqueta para el control "todos"
  • 'ning-mostrar' => boolean [true]: ¿Mostrar el control "ninguno"?
  • 'ning-etiqueta' => string ['N']: Etiqueta para el control "ninguno"
  • 'ning-titulo' => string ['Deseleccionar todo']: Etiqueta para el control "ninguno"
  • 'rest-mostrar' => boolean [true]: ¿Mostrar el control "restaurar"?
  • 'rest-etiqueta' => string ['R']: Etiqueta para el control "restaurar"
  • 'rest-titulo' => string ['Volver a la selección inicial']: Etiqueta para el control "restaurar"

Parameters

string $nombre

valor base para los atributos id y name
array $actual

valores seleccionados
array $datos

contenido del combo; la clave pasa a ser el atributo value del option y el valor su texto
string $clase

valor del atributo class
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
integer $altura

valor del atributo size; si no está definido se usa 3; si es 0 no se incluye
\MultipleFormField|boolean $campo_multiple
string $titulo

valor del atributo title
array $propiedades_extra_opciones
boolean $controles_seleccion

¿se deben incluir controles para cambiar la selección de los valores?
array $opciones_controles_seleccion

opciones para los controles de selección, usadas cuando $controles_seleccion == true.

Returns

mixed —

string o nada, dependiendo de $retornar

textarea()

textarea(string  $nombre, string  $valor, string  $filas, string  $columnas, string  $clase = "Input", string  $keyup = "", boolean  $uppercase = false, string  $onchange = "", string  $extra = '', boolean  $retornar = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, boolean  $read_only = false) : mixed

Genera un área de texto plano.

Parameters

string $nombre
string $valor
string $filas
string $columnas
string $clase
string $keyup
boolean $uppercase
string $onchange
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
\MultipleFormField|boolean $campo_multiple
string $titulo
boolean $read_only

Returns

mixed —

string o nada, dependiendo de $retornar

htmlarea()

htmlarea(string  $nombre, string  $valor, string  $path, string  $filas = "300", string  $columnas = "400", string  $clase = "Input", string  $keyup = "", boolean  $retornar = false, string  $config = null, string  $toolbarset = null) : mixed

Genera un área de texto con formato (FCKeditor).

Parameters

string $nombre
string $valor
string $path
string $filas
string $columnas
string $clase

no se usa
string $keyup

no se usa
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $config

ruta al archivo de configuración personalizada; por ejemplo: 'scripts/customconfig.js'
string $toolbarset

nombre del juego de toolbars a usar; puede ser uno de los definidos por defecto ('Default', 'Basic' o 'Simple') o uno definido en el archivo $config

Returns

mixed —

string o nada, dependiendo de $retornar

checkbox()

checkbox(string  $nombre, string  $actual, string  $valor, string  $clase = "Checkbox", string  $extra = '', boolean  $retornar = false, integer  $ind_grupo = null, boolean  $deshabilitado = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, string  $descripcion = null) : mixed

Genera un input de tipo checkbox.

Parameters

string $nombre
string $actual

valor actual del control; éste se crea chequeado si $actual == $valor
string $valor

valor a enviar cuando el control está chequeado
string $clase

valor para el atributo class del input
string $extra

atributos extra a incorporar en el control; por ejemplo: " style=' margin-left: 10px;'"
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
integer $ind_grupo

índice del checkbox dentro de un grupo; si se especifica, el nombre del control es "$nombre[]" y el id es "$nombre$ind_grupo"
boolean $deshabilitado

¿crear el control en estado deshabilitado?
\MultipleFormField|boolean $campo_multiple
string $titulo

valor para el atributo title del input
string $descripcion

texto a colocar a la derecha del checkbox; $descripcion se envuelve en un span con clase "etiqueta-form-radio", por lo tanto puede tener código html, pero sólo con los elementos permitidos dentro del elemento span

Returns

mixed —

string o nada, dependiendo de $retornar

checkbox_con_hidden()

checkbox_con_hidden(string  $nombre, string  $actual, string  $clase = 'Checkbox', string  $extra = '', boolean  $retornar = false, string  $valor_ckecked = '1', string  $valor_unchecked = '0', boolean  $autosubmit = true, integer  $ind_grupo = null, boolean  $deshabilitado = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, string  $descripcion = null) : mixed

Genera un input de tipo checkbox, con un hidden asociado que recibe los valores indicados cuando el checkbox cambia de estado.

Parameters

string $nombre

ID del hidden; el checkbox queda con ID == "check-$nombre"
string $actual

valor actual; debe ser uno de $valor_ckecked - $valor_unckecked
string $clase

clase CSS a aplicar al checkbox
string $extra

atributos extra a agregar al checkbox; no usar onclick
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $valor_ckecked

valor que debe tomar el hidden cuando se marca el checkbox
string $valor_unchecked

valor que debe tomar el hidden cuando se desmarca el checkbox
boolean $autosubmit

¿se debe hacer automáticamente un submit del form?
integer $ind_grupo

índice del checkbox dentro de un grupo; si se especifica, el nombre del control es "$nombre[]" y el id es "$nombre$ind_grupo"
boolean $deshabilitado
\MultipleFormField|boolean $campo_multiple
string $titulo
string $descripcion

texto a colocar a la derecha del checkbox; $descripcion se envuelve en un span con clase "etiqueta-form-radio", por lo tanto puede tener código html, pero sólo con los elementos permitidos dentro del elemento span

Returns

mixed —

string o nada, dependiendo de $retornar

radio()

radio(string  $nombre, string  $actual, string  $valor, string  $descripcion, string  $clase = "Radio", string  $extra = '', boolean  $retornar = false,   $ind_grupo = null, boolean  $deshabilitado = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null) : mixed

Genera un input de tipo radio, con una etiqueta a la derecha, todo envuelto en un span con clase "form-radio".

Parameters

string $nombre

ID del elemento input
string $actual
string $valor
string $descripcion

texto a colocar a la derecha del radio; $descripcion se envuelve en un span con clase "etiqueta-form-radio", por lo tanto puede tener código html, pero sólo con los elementos permitidos dentro del elemento span
string $clase

clase CSS a aplicar al elemento input
string $extra

atributos extra a aplicar al elemento input
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
$ind_grupo
boolean $deshabilitado

¿el elemento debe estar deshabilitado?
\MultipleFormField|boolean $campo_multiple
string $titulo

Returns

mixed —

string o nada, dependiendo de $retornar

radio_grupo()

radio_grupo(string  $nombre, string  $actual, array  $valores, string  $orientacion, string  $clase = "Radio", string  $extra = '', boolean  $retornar = false, boolean  $deshabilitado = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null) : mixed

Genera un input de un grupo de radio buttons.

Parameters

string $nombre
string $actual
array $valores
string $orientacion

{'h','v'} ¿Los radio buttons se deben colocan en forma horizontal o vertical?
string $clase
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
boolean $deshabilitado
\MultipleFormField|boolean $campo_multiple
string $titulo

Returns

mixed —

string o nada, dependiendo de $retornar

hidden()

hidden(string  $nombre, string  $valor, boolean  $retornar = false, \MultipleFormField|boolean  $campo_multiple = null) : mixed

Genera un campo input de tipo hidden.

Parameters

string $nombre
string $valor
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
\MultipleFormField|boolean $campo_multiple

Returns

mixed —

string o nada, dependiendo de $retornar

submit()

submit(string  $nombre, string  $valor, string  $clase = 'Button', string  $extra = '', boolean  $retornar = false, string  $onclick = '', string  $onmouseover = '', string  $onmouseout = '', string  $teclaacceso = '', string  $titulo = '', boolean  $deshabilitado = false, string  $imagen = null, string  $contenido = null, boolean  $cambiar_clase_en_hover = null) : mixed

Genera un button de tipo submit.

Parameters

string $nombre
string $valor
string $clase
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $onclick
string $onmouseover
string $onmouseout
string $teclaacceso
string $titulo
boolean $deshabilitado
string $imagen

ruta de la imagen a utilizar en el botón; no se genera imagen si este parámetro es vacío
string $contenido

contenido del botón; si está vacío, se usa $valor
boolean $cambiar_clase_en_hover

permite ignorar para este botón el valor del parámetro de configuración 'cambiar_clase_en_hover'; si es null se usa el valor del parámetro de configuración; si no, se usa su valor

Returns

mixed —

string o nada, dependiendo de $retornar

reset()

reset(string  $nombre, string  $valor, string  $clase = 'Button', string  $extra = '', boolean  $retornar = false, string  $onclick = '', string  $onmouseover = '', string  $onmouseout = '', string  $teclaacceso = '', string  $titulo = '', boolean  $deshabilitado = false, string  $imagen = null, string  $contenido = null, boolean  $cambiar_clase_en_hover = null) : mixed

Genera un button de tipo reset.

Parameters

string $nombre
string $valor
string $clase
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $onclick
string $onmouseover
string $onmouseout
string $teclaacceso
string $titulo
boolean $deshabilitado
string $imagen

ruta de la imagen a utilizar en el botón; no se genera imagen si este parámetro es vacío
string $contenido

contenido del botón; si está vacío, se usa $valor
boolean $cambiar_clase_en_hover

permite ignorar para este botón el valor del parámetro de configuración 'cambiar_clase_en_hover'; si es null se usa el valor del parámetro de configuración; si no, se usa su valor

Returns

mixed —

string o nada, dependiendo de $retornar

button()

button(string  $nombre, string  $valor, string  $onclick, string  $extra = '', string  $clase = 'Button', boolean  $retornar = false, string  $onmouseover = '', string  $onmouseout = '', string  $teclaacceso = '', string  $titulo = '', boolean  $deshabilitado = false, string  $imagen = null, string  $contenido = null, boolean  $cambiar_clase_en_hover = null) : mixed

Genera un button de tipo button.

Parameters

string $nombre
string $valor
string $onclick
string $extra
string $clase
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $onmouseover
string $onmouseout
string $teclaacceso
string $titulo
boolean $deshabilitado
string $imagen

ruta de la imagen a utilizar en el botón; no se genera imagen si este parámetro es vacío
string $contenido

contenido del botón; si está vacío, se usa $valor
boolean $cambiar_clase_en_hover

permite ignorar para este botón el valor del parámetro de configuración 'cambiar_clase_en_hover'; si es null se usa el valor del parámetro de configuración; si no, se usa su valor

Returns

mixed —

string o nada, dependiendo de $retornar

password()

password(string  $nombre, string  $valor, integer  $size = "10", integer  $max = "10", string  $clase = "Input", string  $extra = '', boolean  $retornar = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null) : mixed

Genera un input de tipo password.

Parameters

string $nombre
string $valor
integer $size
integer $max
string $clase
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
\MultipleFormField|boolean $campo_multiple
string $titulo

Returns

mixed —

string o nada, dependiendo de $retornar

file_simple()

file_simple(string  $nombre, string  $valor, string  $clase = "Input", string  $dir = "", string  $form = 'formulario', integer  $width = 50, string  $onchange = '', string  $extra = '', boolean  $retornar = false, string  $titulo = null) : mixed

Genera un input de tipo file.

Parameters

string $nombre
string $valor

no se usa
string $clase
string $dir

no se usa
string $form
integer $width
string $onchange
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $titulo

Returns

mixed —

string o nada, dependiendo de $retornar

file()

file(string  $nombre, string  $valor, string  $clase = "Input", string  $dir = "", boolean  $agregado = true, string  $form = 'formulario', integer  $width = 50, string  $onchange = '', string  $extra = '', boolean  $retornar = false, string  $titulo = null) : mixed

Genera un componente para selección de un archivo.

Incluye un input de tipo file y, si $agregado es false y el nombre del archivo no es vacío, un checkbox con nombre $nombre . self::SUF_FILE_CHECK_CONSERVAR, usado para indicar si se debe conservar el archivo actual.

Parameters

string $nombre

nombre del campo file
string $valor

valor del campo file
string $clase

clase CSS a usar en el campo file
string $dir

directorio padre del archivo referenciado en $valor; puede ser vacío
boolean $agregado

¿el campo se está usando en un formulario de alta (true) o de modificación (false)?
string $form

nombre del formulario al que pertenece el componente
integer $width

ancho en caracteres del campo file
string $onchange

no se usa
string $extra

atributos extra para el campo file
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $titulo

valor del atributo title del campo file

Returns

mixed —

string o nada, dependiendo de $retornar

label()

label(string  $texto, string  $asociadaA, string  $teclaacceso = '', string  $clase = '', string  $extra = '', boolean  $retornar = false, string  $nombre = null, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null) : mixed

Genera un label.

Parameters

string $texto
string $asociadaA
string $teclaacceso
string $clase
string $extra
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $nombre

ID del label
\MultipleFormField|boolean $campo_multiple
string $titulo

Returns

mixed —

string o nada, dependiendo de $retornar

abrir()

abrir(string  $nombre, string  $action = "", string  $extra = "", string  $method = "post", string  $enctype = "application/x-www-form-urlencoded", boolean  $retornar = false) : mixed

Genera el codigo html de comienzo de formulario.

Parameters

string $nombre
string $action

destino del envío
string $extra
string $method

método HTTP usado para enviar el formulario: 'get' | 'post'
string $enctype

tipo de contenido usando al enviar el formulario; debería ser 'multipart/form-data' cuando contiene algún campo de tipo file o 'application/x-www-form-urlencoded' en caso contrario
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?

Throws

\DomainException

si $method no es 'get' o 'post'

Returns

mixed —

string o nada, dependiendo de $retornar

cerrar()

cerrar(boolean  $retornar = false) : mixed

Genera el codigo html de cierre de formulario

Parameters

boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?

Returns

mixed —

string o nada, dependiendo de $retornar

abrir_grupo()

abrir_grupo(string  $leyenda = '', string  $nombre = '', string  $teclaacceso = '', string  $extras = '', boolean  $retornar = false, string  $clase = null) : mixed

Abre un grupo de campos de formulario (fieldset).

Parameters

string $leyenda

texto de título del grupo
string $nombre

ID del grupo
string $teclaacceso

tecla rápida para acceder al grupo
string $extras

valores para otros atributos no definidos explícitamente en parámetros
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $clase

clase/s CSS

Returns

mixed —

string o nada, dependiendo de $retornar

cerrar_grupo()

cerrar_grupo(boolean  $retornar = false) : mixed

Cierra un grupo de campos de formulario.

Parameters

boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?

Returns

mixed —

string o nada, dependiendo de $retornar

agregar_imprimir()

agregar_imprimir(string  $pagina, string  $filtros, array  $filtrosPersonalizados, array  $parametros, string  $titulo, array  $urlRetorno, string  $clase = 'Button', string  $teclaacceso = '', boolean  $retornar = false, string  $tipo1 = '', boolean  $deshabilitado = false, string  $tipo = 'pdf', string  $orden = '') : mixed

Genera un botón para Previsualizar e Imprimir, con id = "b_imprimir$tipo".

Incluye la imagen definida por el recurso XGAP_RECURSO_IMG_BTN_IMPRIMIR.

Parameters

string $pagina
string $filtros
array $filtrosPersonalizados
array $parametros
string $titulo
array $urlRetorno
string $clase
string $teclaacceso
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $tipo1

mantenido por compatibilidad; en versiones anteriores había un error en la definición: $tipo estaba 2 veces en la firma del método
boolean $deshabilitado

¿el botón se debe generar deshabilitado?
string $tipo

indica el tipo de salida que se genera a partir del botón; si no tiene valor vacío, el id del botón pasa a ser "bimprimir$tipo"
string $orden

Returns

mixed —

string o nada, dependiendo de $retornar

radio_bd()

radio_bd(\Conexion  $objeto_conexion, string  $sql_radio, string  $nombre_formulario, string  $nombre_campo, string  $valor, array  $orientacion = "horizontal", boolean  $retornar = false, string  $extras = '', string  $clase = 'Radio', \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null) : mixed

Genera un Radio pero a partir de una consulta.

Parameters

\Conexion $objeto_conexion
string $sql_radio
string $nombre_formulario
string $nombre_campo
string $valor
array $orientacion

{'h','v'} ¿Los radio buttons se deben colocan en forma horizontal o vertical?
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $extras
string $clase
\MultipleFormField|boolean $campo_multiple
string $titulo

Returns

mixed —

string o nada, dependiendo de $retornar

combo_bd()

combo_bd(\Conexion  $objeto_conexion, string  $sql_combo, string  $nombre_formulario, string  $nombre_campo, string  $valor, boolean  $retornar = false, string  $extras = '', string  $clase = 'Select', boolean  $clave = false, \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, string  $texto_opcion_vacia = self::COMBO_TEXTO_OPCION_VACIA, boolean  $agregar_opcion_vacia = true) : mixed

Genera un elemento select que se llena con el resultado de una consulta a la base de datos, y un campo hidden asociado donde se guarda el texto de la opción seleccionada.

El campo hidden tiene nombre "{$nombre_campo}_descripcion".

Parameters

\Conexion $objeto_conexion
string $sql_combo
string $nombre_formulario
string $nombre_campo
string $valor
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $extras
string $clase
boolean $clave
\MultipleFormField|boolean $campo_multiple
string $titulo
string $texto_opcion_vacia

texto de la opción que corresponde a selección vacía
boolean $agregar_opcion_vacia

¿se debe incluir una opción que corresponde a selección vacía?

Returns

mixed —

string o nada, dependiendo de $retornar

combo_bd_sin_hidden()

combo_bd_sin_hidden(\Conexion  $objeto_conexion, string  $sql_combo, string  $nombre_formulario, string  $nombre_campo, string  $valor, boolean  $retornar = false, string  $extras = '', string  $clase = 'Select', \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, string  $texto_opcion_vacia = self::COMBO_TEXTO_OPCION_VACIA, boolean  $agregar_opcion_vacia = true) : mixed

Genera un elemento select que se llena con el resultado de una consulta a la base de datos.

Este select no tiene un campo hidden asociado, a diferencia de self::combo_bd().

Parameters

\Conexion $objeto_conexion
string $sql_combo
string $nombre_formulario
string $nombre_campo
string $valor
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $extras
string $clase
\MultipleFormField|boolean $campo_multiple
string $titulo
string $texto_opcion_vacia

texto de la opción que corresponde a selección vacía
boolean $agregar_opcion_vacia

¿se debe incluir una opción que corresponde a selección vacía?

Returns

mixed —

string o nada, dependiendo de $retornar

recuperar_inputs_filtros_personalizados()

recuperar_inputs_filtros_personalizados(array  $filtrosPersonalizados) : string

Genera un campo hidden por cada valor del arreglo de entrada.

Parameters

array $filtrosPersonalizados

Returns

string —

el código html generado

agregar_navegador()

agregar_navegador(integer  $cantidadAMostrar, integer  $nroPagina, integer  $total) : string

Genera el navegador/paginador de los listados.

Parameters

integer $cantidadAMostrar
integer $nroPagina
integer $total

Returns

string

abrir_buscador()

abrir_buscador(mixed  $orden, array  $columnas, boolean  $excluir)

Genera la apertura de un form para el buscador.

Parameters

mixed $orden
array $columnas
boolean $excluir

cerrar_buscador()

cerrar_buscador()

Genera el cierre de un form para el buscador.

generar_buscador()

generar_buscador(integer  $cantidadAMostrar, integer  $nroPagina, integer  $total)

Genera todo el contenido necesario para el buscador.

Parameters

integer $cantidadAMostrar
integer $nroPagina
integer $total

agregar_boton_accion_listado()

agregar_boton_accion_listado(string  $titulo, string  $nombre, string  $urlRetorno = '', string  $clase = 'Button', string  $teclaacceso = '', boolean  $deshabilitado = false, boolean  $retornar = false, string  $imagen = XGAP_RECURSO_IMG_BTN_ACCION, string  $onclick = '') : mixed

Genera un botón para una accion determinada por el usuario.

Incluye la imagen definida por el recurso XGAP_RECURSO_IMG_BTN_ACCION.

Parameters

string $titulo
string $nombre
string $urlRetorno

dirección de la página donde se envía el POST de la acción; por defecto es la página actual
string $clase
string $teclaacceso
boolean $deshabilitado
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
string $imagen
string $onclick

código javascript a ejecutar cuando se hace click en el botón, antes del código predeterminado; no debería hacer un submit del formulario

Returns

mixed —

string o nada, dependiendo de $retornar

spin_button()

spin_button(string  $nombre, string  $funcion_up, string  $funcion_down, boolean  $retornar = false) : mixed

Genera un control SPIN generico con dos botones y una funcion asociada a cada uno.

El control queda envuelto en un span con clase 'campo_spin'.

Parameters

string $nombre
string $funcion_up
string $funcion_down
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?

Returns

mixed —

string o nada, dependiendo de $retornar

tiempo()

tiempo(string  $nombre, string  $actual, integer  $incremento_horas = 1, integer  $incremento_minutos = 1, boolean  $text_read_only = false, string  $clase = "Input", string  $onchange = "", \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, boolean  $retornar = false, boolean  $read_only = false) : mixed

Genera un componente que representa un campo de tipo TIEMPO, que consiste en un campo para hora, otro para minutos y un hidden para almacenar el valor real de la hora.

El componente queda envuelto en un elemento html span con clase 'campo_tiempo'.

Parameters

string $nombre
string $actual
integer $incremento_horas

valor a incrementar o decrementar la hora por cada click del spin
integer $incremento_minutos

valor a incrementar o decrementar los minutos por cada click del spin
boolean $text_read_only

si true, el valor del tiempo se puede modificar mediante los controles spin, pero no editando los campos de texto
string $clase
string $onchange
\MultipleFormField|boolean $campo_multiple
string $titulo
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
boolean $read_only

si true, el campo no se puede editar: los campos de texto quedan como sólo lectura y no se generan los spin buttons; en ese caso, se ignora el valor de $text_read_only

Returns

mixed —

string o nada, dependiendo de $retornar

spin_rango()

spin_rango(string  $nombre, string  $actual, integer  $valor_minimo = '', integer  $valor_maximo = '', boolean  $text_read_only = false, integer  $ancho = 2, string  $clase = 'Input', string  $onchange = '', \MultipleFormField|boolean  $campo_multiple = null, string  $titulo = null, boolean  $retornar = false, boolean  $read_only = false) : mixed

Genera un campo de texto con un control de spin asociado, cuyo valor se puede mover dentro de un rango dado.

El componente queda envuelto en un elemento html span con clase 'rango'.

Parameters

string $nombre
string $actual
integer $valor_minimo

límite inferior del rango
integer $valor_maximo

límite superior del rango
boolean $text_read_only

si true, el valor del tiempo se puede modificar mediante los controles spin, pero no editando los campos de texto
integer $ancho
string $clase
string $onchange
\MultipleFormField|boolean $campo_multiple
string $titulo
boolean $retornar

¿el método debe retornar el código HTML o emitirlo a la salida?
boolean $read_only

si true, el campo no se puede editar: el campo de texto quedan como sólo lectura y no se generan el spin button; en ese caso, se ignora el valor de $text_read_only

Returns

mixed —

string o nada, dependiendo de $retornar