Docs For Class toba

static method get_excepciones [línea 220]

static void get_excepciones(
)

Redefinido en subclases como:

toba_ef_cuit::get_excepciones()

static method set_excepciones [línea 215]

static void set_excepciones(

$excepciones 
)

Parámetros:

$excepciones:

Redefinido en subclases como:

toba_ef_cuit::set_excepciones() : Permite agregar excepciones al algoritmo de validacion de CUIT

Constructor __construct [línea 56]

toba_ef __construct(

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

Parámetros:

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

Redefinido en subclases como:

agregar_icono_utileria [línea 650]

void agregar_icono_utileria(
toba_ef_icono_utileria
$icono 
)

Agrega un icono con comportamiento al lado del elemento

Parámetros:

toba_ef_icono_utileria

$icono:

cargar_estado_post [línea 667]

void cargar_estado_post(
)

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

Redefinido en subclases como:

toba_ef_cuit::cargar_estado_post()
toba_ef_seleccion::cargar_estado_post()
toba_ef_combo_editable::cargar_estado_post()
toba_ef_editable::cargar_estado_post()
toba_ef_editable_captcha::cargar_estado_post()
toba_ef_editable_fecha_hora::cargar_estado_post()
toba_ef_editable_hora::cargar_estado_post()
toba_ef_editable_textarea::cargar_estado_post()
toba_ef_popup::cargar_estado_post()
toba_ef_checkbox::cargar_estado_post()
toba_ef_multi_seleccion::cargar_estado_post()
toba_ef_oculto::cargar_estado_post() : Como el componente no viaja al cliente, carga su estado de la memoria (sesion)
toba_ef_upload::cargar_estado_post()

carga_depende_de_estado [línea 201]

boolean carga_depende_de_estado(
)

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

Redefinido en subclases como:

clave_memoria [línea 288]

void clave_memoria(
[
$multiplexado = true] 
)

Parámetros:

$multiplexado:

controlador [línea 764]

toba_formulario controlador(
)

Retorna la referencia al componente padre o formulario

crear_objeto_js [línea 694]

void crear_objeto_js(
)

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

Redefinido en subclases como:

esta_expandido [línea 341]

boolean esta_expandido(
)

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

Para verlo el usuario explícitamente debe apretar un icono o vínculo.

See:

toba_ef::set_expandido()

es_estado_unico [línea 192]

boolean es_estado_unico(
)

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

Redefinido en subclases como:

toba_ef_multi_seleccion::es_estado_unico()

es_obligatorio [línea 312]

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

See:

toba_ef::set_obligatorio()

es_seleccionable [línea 175]

boolean es_seleccionable(
)

El ef permite seleccionar valores o solo se pueden editar?

Redefinido en subclases como:

es_solo_lectura [línea 573]

void es_solo_lectura(
)

get_campos_clave [línea 243]

array get_campos_clave(
)

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

Esto está disponible cuando se brinda un mecanismo de carga asociado al ef.

get_campo_valor [línea 253]

mixed get_campo_valor(
)

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

Return:

Nombre del campo definido como valor o descripción

get_consumo_javascript [línea 727]

array get_consumo_javascript(
)

Esta funcion permite que un EF declare la necesidad de incluir

codigo javascript necesario para su correcto funcionamiento

Return:

Arreglo (sin extension .js) de los consumos

Redefinido en subclases como:

get_cuando_cambia_valor [línea 744]

void get_cuando_cambia_valor(
)

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

Access:

protected

get_dato [línea 379]

mixed get_dato(
)

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

Cuando al formulario se le pide un get_datos() este retorna como columnas los datos definidos en los efs

get_descripcion [línea 369]

string get_descripcion(
)

Retorna la descripción o ayuda del ef.

La descripción se muestra por defecto como un tooltip al lado de la etiqueta

get_descripcion_estado [línea 421]

string get_descripcion_estado(

$tipo_salida 
)

Retorna una descripción textual del 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

Parámetros:

$tipo_salida:

Redefinido en subclases como:

toba_ef_cuit::get_descripcion_estado()
toba_ef_seleccion::get_descripcion_estado() : Retorna la descripción asociada a la opción actualmente seleccionada
toba_ef_combo_editable::get_descripcion_estado()
toba_ef_editable_numero::get_descripcion_estado()
toba_ef_editable_moneda::get_descripcion_estado()
toba_ef_editable_numero_porcentaje::get_descripcion_estado()
toba_ef_editable_fecha::get_descripcion_estado()
toba_ef_editable_fecha_hora::get_descripcion_estado()
toba_ef_editable_hora::get_descripcion_estado()
toba_ef_popup::get_descripcion_estado() : Retorna la descripción asociada a la opción actualmente seleccionada
toba_ef_checkbox::get_descripcion_estado()
toba_ef_multi_seleccion::get_descripcion_estado()

get_estado [línea 406]

mixed get_estado(
)

Retorna el valor o estado actual del ef

Return:

Si el ef maneja un unico dato el estado es un string, sino es un arreglo de strings

Redefinido en subclases como:

toba_ef_seleccion::get_estado()
toba_ef_editable_captcha::get_estado()
toba_ef_editable_fecha::get_estado()
toba_ef_editable_fecha_hora::get_estado()
toba_ef_multi_seleccion::get_estado() : Puede retornar el estado serializado (un unico string) o en un arreglo dependiendo de su definición en el editor
toba_ef_sin_estado::get_estado()

get_estilo_etiqueta [línea 321]

string get_estilo_etiqueta(
)

Retorna la clase css asociada a la etiqueta

get_etiqueta [línea 359]

string get_etiqueta(
)

Retorna el texto de la etiqueta asociada

get_fila_actual [línea 537]

void get_fila_actual(
)

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

get_html_iconos_utilerias [línea 655]

void get_html_iconos_utilerias(
)

get_id [línea 350]

string get_id(
)

Devuelve el id del ef dentro del framework

get_id_form [línea 397]

string get_id_form(
)

Retorna el id html del ef en el formulario

get_id_form_orig [línea 388]

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 758]

void get_input(
)

Genera el HTML del elemento

Abstract:

Redefinido en subclases como:

get_maestros [línea 233]

array get_maestros(
)

Retorna la lista de efs de los cuales depende

Return:

Arreglo de identificadores de efs

get_toggle [línea 330]

boolean get_toggle(
)

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

guardar_dato_sesion [línea 676]

void guardar_dato_sesion(

$dato, [
$multiplexado = false] 
)

Parámetros:

	$dato:
	$multiplexado:

ir_a_fila [línea 528]

void 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 515]

mixed normalizar_parametro_cascada(
mixed
$parametro 
)

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

Parámetros:

mixed

$parametro:

Valor que se recibio por cascada

Redefinido en subclases como:

toba_ef_editable_fecha::normalizar_parametro_cascada()

objeto_js [línea 703]

void objeto_js(
)

Retorna el nombre de la instancia del objeto en javascript

Ej: alert({$ef->objeto_js()}.valor())

parametros_js [línea 711]

void parametros_js(
)

Lista de parametros necesarios para el constructor del objeto en javascript

Access:

protected

Redefinido en subclases como:

permite_seleccion_multiple [línea 183]

boolean permite_seleccion_multiple(
)

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

Redefinido en subclases como:

toba_ef_multi_seleccion::permite_seleccion_multiple()

quitar_maestro [línea 280]

void quitar_maestro(

$maestro 
)

Parámetros:

$maestro:

resetear_estado [línea 459]

void resetear_estado(
)

Retorna el valor del ef a su estado inicial.

Si el ef no maneja un estado o valor por defecto, su valor sera NULL

Redefinido en subclases como:

seleccionado [línea 450]

void seleccionado(
)

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

Redefinido en subclases como:

toba_ef_checkbox::seleccionado()

set_cuando_cambia_valor [línea 736]

void set_cuando_cambia_valor(

$js 
)

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

Por ejemplo en el onchange de los input html

Parámetros:

$js:

set_descripcion [línea 556]

string set_descripcion(

$descripcion 
)

Cambia la descripción o ayuda del ef.

La descripción se muestra por defecto como un tooltip al lado de la etiqueta

Parámetros:

$descripcion:

set_estado [línea 617]

void set_estado(
mixed
$estado 
)

Cambia el valor o estado actual del ef

Parámetros:

mixed

$estado:

Redefinido en subclases como:

set_estado_defecto [línea 505]

void 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 597]

void set_estilo_etiqueta(
string
$estilo 
)

Cambia la clase css aplicada a la etiqueta

Parámetros:

string

$estilo:

set_etiqueta [línea 546]

void set_etiqueta(
string
$etiqueta 
)

Cambia la etiqueta actual del ef

Parámetros:

string

$etiqueta:

set_expandido [línea 608]

void 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.

Para verlo el usuario explícitamente debe apretar un icono o vínculo.

Parámetros:

boolean

$expandido:

set_iconos_utilerias [línea 639]

void set_iconos_utilerias(
array
$iconos 
)

Cambia los iconos visibles a un lado del elemento

Parámetros:

array

$iconos:

Arreglo de iconos que implementan toba_ef_icono_utileria

set_obligatorio [línea 588]

void set_obligatorio(
[boolean
$obligatorio = true] 
)

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

Para cambiar la obligatoriedad durante todo un ciclo cliente-servidor usar set_efs_obligatorios del formulario

Parámetros:

boolean

$obligatorio:

set_permitir_html [línea 630]

void 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 567]

void 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.

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

Parámetros:

boolean

$solo_lectura:

Hacer o no solo lectura

son_campos_posicionales [línea 262]

boolean son_campos_posicionales(
)

Retorna true si tanto los campos clave como valor son posicionales

tiene_estado [línea 442]

void tiene_estado(
)

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

Redefinido en subclases como:

tiene_etiqueta [línea 210]

boolean tiene_etiqueta(
)

El ef maneja el concepto de etiqueta?

Redefinido en subclases como:

toba_ef_sin_estado::tiene_etiqueta()

tiene_opciones_cargadas [línea 301]

boolean tiene_opciones_cargadas(
)

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

validar_estado [línea 468]

mixed validar_estado(
)

Chequea la validez del estado actual del ef

Return:

Retorna true cuando es valido y un string con el mensaje cuando es inválido

Redefinido en subclases como:

toba_ef_cuit::validar_estado()
toba_ef_editable::validar_estado()
toba_ef_editable_numero::validar_estado() : Valida que el número cumpla con el rango preestablecido (si lo hay)
toba_ef_editable_clave::validar_estado()
toba_ef_editable_fecha::validar_estado() : Valida que sea una fecha válida con la funcion php checkdate
toba_ef_editable_fecha_hora::validar_estado() : Valida que sea una fecha válida con la funcion php checkdate
toba_ef_editable_hora::validar_estado() : Valida que sea una fecha válida con la funcion php checkdate
toba_ef_multi_seleccion::validar_estado() : La validación verifica si se cumple con la cantidad mínima y máxima
toba_ef_upload::validar_estado() : Valida que cumpla con la lista de extensiones válidas definidas.
toba_ef_sin_estado::validar_estado()

	Centrales \| Componentes \| Debug \| Fuentes \| SalidaGrafica \| Seguridad \| Varios

[ árbol de herencia: Componentes ] [ índice: Componentes ] [ índice general ]