API Documentation

Métodos Propios

static void	get_excepciones()
static void	get_maximo_descripcion()
static void	set_excepciones()
static void	set_maximo_descripcion()
void	__construct ()
void	agregar_icono_utileria ()
boolean	carga_depende_de_estado ()
void	cargar_estado_post ()
void	clave_memoria ()
\toba_formulario	controlador ()
void	crear_objeto_js ()
boolean	es_estado_unico ()
boolean	es_obligatorio ()
boolean	es_seleccionable ()
void	es_solo_lectura ()
boolean	esta_expandido ()	Para verlo el usuario explícitamente debe apretar un icono o vínculo.
mixed	get_campo_valor ()
array	get_campos_clave ()	Esto está disponible cuando se brinda un mecanismo de carga asociado al ef.
array	get_consumo_javascript ()
void	get_cuando_cambia_valor ()
mixed	get_dato ()	Cuando al formulario se le pide un get_datos() este retorna como columnas los datos definidos en los efs
string	get_descripcion ()	La descripción se muestra por defecto como un tooltip al lado de la etiqueta
string	get_descripcion_estado ()	Para muchos efs la descripción es identica al estado (caso de un texto común por ejemplo), pero para otros el estado es una clave interna distinta a su descripción
mixed	get_estado ()
string	get_estilo_etiqueta ()
string	get_etiqueta ()
void	get_fila_actual ()
void	get_html_iconos_utilerias ()
string	get_id ()
string	get_id_form ()
string	get_id_form_orig ()
void	get_input ()
array	get_maestros ()
boolean	get_toggle ()
void	guardar_dato_sesion ()
void	ir_a_fila ()
mixed	normalizar_parametro_cascada ()
void	objeto_js ()
void	parametros_js ()
boolean	permite_seleccion_multiple ()
void	quitar_maestro ()
void	resetear_estado ()	Si el ef no maneja un estado o valor por defecto, su valor sera NULL
void	seleccionado ()
void	set_cuando_cambia_valor ()	Por ejemplo en el onchange de los input html
string	set_descripcion ()	La descripción se muestra por defecto como un tooltip al lado de la etiqueta
void	set_estado ()
void	set_estado_defecto ()
void	set_estilo_etiqueta ()
void	set_etiqueta ()
void	set_expandido ()	Para verlo el usuario explícitamente debe apretar un icono o vínculo.
void	set_iconos_utilerias ()
void	set_obligatorio ()	Para cambiar la obligatoriedad durante todo un ciclo cliente-servidor usar [set_efs_obligatorios del formulario](/classes/toba_ei_formulario.html#method_set_efs_obligatorios)
void	set_permitir_html ()
void	set_solo_lectura ()	Notar que si un ef se fija solo_lectura en el servidor, este estado no puede variar en el cliente (javascript), Para armar lógica de cambio de solo_lectura en javascript utilizar la extensión javascript del componente usado
void	set_tamano ()
boolean	son_campos_posicionales ()
void	tiene_estado ()
boolean	tiene_etiqueta ()
boolean	tiene_opciones_cargadas ()
mixed	validar_estado ()

static method get_excepciones [línea 232]

static  get_excepciones(
            )

static method get_maximo_descripcion [línea 63]

static  get_maximo_descripcion(
            )

static method set_excepciones [línea 227]

static  set_excepciones(
                                                
                     
                    $excepciones                                                 )

Parámetros:

$excepciones:

static method set_maximo_descripcion [línea 58]

static  set_maximo_descripcion(
                                                
                     
                    $maximo                                                 )

Parámetros:

$maximo:

__construct [línea 68]

 __construct(
                                    
                
                $padre                ,                             
                
                $nombre_formulario                ,                             
                
                $id                ,                             
                
                $etiqueta                ,                             
                
                $descripcion                ,                             
                
                $dato                ,                             
                
                $obligatorio                ,                             
                
                $parametros                                    )

Parámetros:

	$padre:
	$nombre_formulario:
	$id:
	$etiqueta:
	$descripcion:
	$dato:
	$obligatorio:
	$parametros:

agregar_icono_utileria [línea 674]

 agregar_icono_utileria(
                                    
                \toba_ef_icono_utileria
                $icono                                    )

Agrega un icono con comportamiento al lado del elemento

Parámetros:

\toba_ef_icono_utileria

$icono:

carga_depende_de_estado [línea 213]

boolean carga_depende_de_estado(
        )

La carga de opciones de este ef depende de su estado actual?

cargar_estado_post [línea 691]

 cargar_estado_post(
        )

Carga el estado actual del ef a partir del $_POST dejado por este mismo componente en el pedido anterior

clave_memoria [línea 300]

 clave_memoria(
                                    
                [
                $multiplexado = true ]                                    )

Parámetros:

$multiplexado:

controlador [línea 788]

\toba_formulario controlador(
        )

Retorna la referencia al componente padre o formulario

crear_objeto_js [línea 718]

 crear_objeto_js(
        )

Retorna la sentencia de creación del objeto javascript que representa al EF

es_estado_unico [línea 204]

boolean es_estado_unico(
        )

El ef maneja un único valor como estado? O maneja un arreglo de estados?

es_obligatorio [línea 324]

boolean es_obligatorio(
        )

Un ef obligatorio lanza una excepción en PHP si su estado actual es nulo La obligatoriedad se define en el editor, aunque es posible modificarla durante un pedido de pagina específico

es_seleccionable [línea 187]

boolean es_seleccionable(
        )

El ef permite seleccionar valores o solo se pueden editar?

es_solo_lectura [línea 588]

 es_solo_lectura(
        )

esta_expandido [línea 353]

boolean esta_expandido(
        )

Un ef no expandido se muestra oculto en el layout del formulario.

get_campo_valor [línea 265]

mixed get_campo_valor(
        )

Retorna la columna 'valor' del ef Esto está disponible cuando se brinda un mecanismo de carga asociado al ef.

get_campos_clave [línea 255]

array get_campos_clave(
        )

Retorna la/s columna/s clave/s del ef.

get_consumo_javascript [línea 751]

array get_consumo_javascript(
        )

Esta funcion permite que un EF declare la necesidad de incluir codigo javascript necesario para su correcto funcionamiento

get_cuando_cambia_valor [línea 768]

 get_cuando_cambia_valor(
        )

Retorna el js utilizado cuando el ef cambia de valor en el cliente

get_dato [línea 391]

mixed get_dato(
        )

El 'dato' del ef es la o las columnas de datos asociadas.

get_descripcion [línea 381]

string get_descripcion(
        )

Retorna la descripción o ayuda del ef.

get_descripcion_estado [línea 433]

string get_descripcion_estado(
                                    
                
                $tipo_salida                                    )

Retorna una descripción textual del estado.

Parámetros:

$tipo_salida:

get_estado [línea 418]

mixed get_estado(
        )

Retorna el valor o estado actual del ef

get_estilo_etiqueta [línea 333]

string get_estilo_etiqueta(
        )

Retorna la clase css asociada a la etiqueta

get_etiqueta [línea 371]

string get_etiqueta(
        )

Retorna el texto de la etiqueta asociada

get_fila_actual [línea 552]

 get_fila_actual(
        )

Obtiene la fila actual en el multiplexado en el ef (usado en el formulario_ml)

get_html_iconos_utilerias [línea 679]

 get_html_iconos_utilerias(
        )

get_id [línea 362]

string get_id(
        )

Devuelve el id del ef dentro del framework

get_id_form [línea 409]

string get_id_form(
        )

Retorna el id html del ef en el formulario

get_id_form_orig [línea 400]

string get_id_form_orig(
        )

Como el id html puede variar si se multiplexa el ef (caso formulario_ml), este metodo retorna el id original del ef

get_input [línea 782]

 get_input(
        )

Genera el HTML del elemento

get_maestros [línea 245]

array get_maestros(
        )

Retorna la lista de efs de los cuales depende

get_toggle [línea 342]

boolean get_toggle(
        )

El checkbox esta configurado en los ML para tener un tilde sel/des todos?

guardar_dato_sesion [línea 700]

 guardar_dato_sesion(
                                    
                
                $dato                ,                             
                [
                $multiplexado = false ]                                    )

Parámetros:

	$dato:
	$multiplexado:

ir_a_fila [línea 543]

 ir_a_fila(
                                    
                [
                $agregado = "" ]                                    )

Multiplexa el ef (usado en el formulario_ml) Permite que una sola intancia de un objeto ef pueda ser utilizada para representar un conjunto de efs similares en estructura

Parámetros:

$agregado:

normalizar_parametro_cascada [línea 530]

mixed normalizar_parametro_cascada(
                                    
                mixed
                $parametro                                    )

Permite normalizar un parametro recibido de una cascada a un formato estandar

Parámetros:

mixed

$parametro:

objeto_js [línea 727]

 objeto_js(
        )

Retorna el nombre de la instancia del objeto en javascript Ej: alert({$ef->objeto_js()}.valor())

parametros_js [línea 735]

 parametros_js(
        )

Lista de parametros necesarios para el constructor del objeto en javascript

permite_seleccion_multiple [línea 195]

boolean permite_seleccion_multiple(
        )

El ef permite seleccionable permite elegir más de un valor?

quitar_maestro [línea 292]

 quitar_maestro(
                                    
                
                $maestro                                    )

Parámetros:

$maestro:

resetear_estado [línea 471]

 resetear_estado(
        )

Retorna el valor del ef a su estado inicial.

seleccionado [línea 462]

 seleccionado(
        )

El ef tiene un valor positivo, similar a tiene_estado() pero puede ser mas restrictivo

set_cuando_cambia_valor [línea 760]

 set_cuando_cambia_valor(
                                    
                
                $js                                    )

Determina el codigo personalizado a ejecutar cuando el ef cambia de valor en el cliente.

Parámetros:

$js:

set_descripcion [línea 571]

string set_descripcion(
                                    
                
                $descripcion                                    )

Cambia la descripción o ayuda del ef.

Parámetros:

$descripcion:

set_estado [línea 632]

 set_estado(
                                    
                mixed
                $estado                                    )

Cambia el valor o estado actual del ef

Parámetros:

mixed

$estado:

set_estado_defecto [línea 517]

 set_estado_defecto(
                                    
                
                $estado                                    )

Cambia el valor que toma el ef cuando no se lo carga con un estado

Parámetros:

$estado:

set_estilo_etiqueta [línea 612]

 set_estilo_etiqueta(
                                    
                string
                $estilo                                    )

Cambia la clase css aplicada a la etiqueta

Parámetros:

string

$estilo:

set_etiqueta [línea 561]

 set_etiqueta(
                                    
                string
                $etiqueta                                    )

Cambia la etiqueta actual del ef

Parámetros:

string

$etiqueta:

set_expandido [línea 623]

 set_expandido(
                                    
                boolean
                $expandido                                    )

Determina si un ef se muestra o no expandido Un ef no expandido se muestra oculto en el layout del formulario.

Parámetros:

boolean

$expandido:

set_iconos_utilerias [línea 663]

 set_iconos_utilerias(
                                    
                array
                $iconos                                    )

Cambia los iconos visibles a un lado del elemento

Parámetros:

array

$iconos:

set_obligatorio [línea 603]

 set_obligatorio(
                                    
                [boolean
                $obligatorio = true ]                                    )

Cambia la obligatoriedad de un ef Notar que este cambio no se persiste para el siguiente pedido.

Parámetros:

boolean

$obligatorio:

set_permitir_html [línea 645]

 set_permitir_html(
                                    
                boolean
                $permitir                                    )

Determina si el ef puede contener en su estado HTML, por defecto falso para evitar ataques de seguridad XSS

Parámetros:

boolean

$permitir:

set_solo_lectura [línea 582]

 set_solo_lectura(
                                    
                [boolean
                $solo_lectura = true ]                                    )

Cuando un ef se encuentra en solo_lectura su valor es visible al usuario pero no puede modificarlo.

Parámetros:

boolean

$solo_lectura:

set_tamano [línea 654]

 set_tamano(
                                    
                integer
                $tamanio                                    )

Expresa el tamaño del ef en cantidad de caracteres

Parámetros:

integer

$tamanio:

son_campos_posicionales [línea 274]

boolean son_campos_posicionales(
        )

Retorna true si tanto los campos clave como valor son posicionales

tiene_estado [línea 454]

 tiene_estado(
        )

Retorna true si el ef tiene un valor o estado distinto al nulo

tiene_etiqueta [línea 222]

boolean tiene_etiqueta(
        )

El ef maneja el concepto de etiqueta?

tiene_opciones_cargadas [línea 313]

boolean tiene_opciones_cargadas(
        )

Si el ef permite seleccionar opciones, estas ya estan cargadas?

validar_estado [línea 480]

mixed validar_estado(
        )

Chequea la validez del estado actual del ef

	Centrales \| Componentes \| consola \| Debug \| Default \| Fuentes \| SalidaGrafica \| Seguridad \| SIUToba \| Varios \| Deprecated