API Documentation

static method set_modo_compatible_manejo_sesion [línea 93]

static  set_modo_compatible_manejo_sesion(
                                                
                     
                    $compatible                                                 )

Alternativa para que la reutilización de un mismo componente en un mismo request se siga comportando como antes de [3050], es decir el ultimo creado pisa la memoria del 1ero.

Parámetros:

$compatible:

__construct [línea 51]

 __construct(
                                    
                
                $definicion                                    )

Parámetros:

$definicion:

__sleep [línea 83]

 __sleep(
        )

agregar_dependencia [línea 551]

 agregar_dependencia(
                                    
                string
                $identificador                ,                             
                string
                $proyecto                ,                             
                string
                $objeto                                    )

Agregar dinámicamente una dependencia al componente actual

Parámetros:

string	$identificador:
string	$proyecto:
string	$objeto:

agregar_dependencia_por_indice [línea 567]

 agregar_dependencia_por_indice(
                                    
                
                $identificador_rol                ,                             
                
                $identificador_componente                                    )

Agregar dinámicamente una dependencia al componente actual utilizando

Parámetros:

	$identificador_rol:
	$identificador_componente:

borrar_memoria [línea 327]

 borrar_memoria(
        )

Elimina toda la memoria interna actual y de pedidos anteriores

controlador [línea 204]

\toba_ci controlador(
        )

Retorna la referencia al componente padre o contenedor del actual, generalmente un ci

dep [línea 539]

\toba_componente dep(
                                    
                
                $id                ,                             
                [
                $carga_en_demanda = true ]                                    )

Parámetros:

	$id:
	$carga_en_demanda:

dependencia [línea 527]

\toba_componente dependencia(
                                    
                string
                $id                ,                             
                [
                $carga_en_demanda = true ]                                    )

Accede a una dependencia del objeto, opcionalmente si la dependencia no esta cargada, la carga

Parámetros:

string	$id:
	$carga_en_demanda:

dependencia_cargada [línea 621]

boolean dependencia_cargada(
                                    
                
                $id                                    )

Retorna verdadero si la dependencia fue construida y asociada en este pedido de página

Parámetros:

$id:

destruir [línea 120]

 destruir(
        )

Destructor del componente

eliminar_estado_sesion [línea 440]

 eliminar_estado_sesion(
                                    
                [array
                $no_eliminar = null ]                                    )

Elimina de la sesion las propiedades de este componente, a su vez pone en null estas propiedades en este objeto

Parámetros:

array

$no_eliminar:

existe_dependencia [línea 630]

boolean existe_dependencia(
                                    
                
                $id                                    )

Retorna verdadero si un componente es dependencia del actual

Parámetros:

$id:

get_cantidad_dependencias [línea 648]

integer get_cantidad_dependencias(
        )

Retorna la cantidad de dependencias cargadas

get_dependencias [línea 639]

array get_dependencias(
        )

Retorna un array con las dependencias cargadas del componente

get_dependencias_clase [línea 657]

array get_dependencias_clase(
                                    
                
                $ereg_busqueda                                    )

Devuelve las dependencias cuya clase de componente coincide con la expresion regular pasada como parametro

Parámetros:

$ereg_busqueda:

get_estado_sesion [línea 456]

array get_estado_sesion(
        )

Construye un arreglo con los valores de todas las propiedades a almacenarse en sesion

get_id [línea 177]

array get_id(
        )

Retorna el identificador del componente

get_mensaje [línea 240]

string get_mensaje(
                                    
                mixed
                $indice                ,                             
                [mixed
                $parametros = null ]                                    )

Retorna un mensaje asociado al componente

Parámetros:

mixed	$indice:
mixed	$parametros:

get_nombre [línea 159]

string get_nombre(
        )

Retorna el nombre del componente según se definió en el editor

get_parametro [línea 195]

 get_parametro(
                                    
                string
                $parametro                                    )

Retorna un parámetro estático definido en las prop. básicas del componente

Parámetros:

string

$parametro:

get_titulo [línea 168]

string get_titulo(
        )

Retorna el título del componente (nombre visible al usuario)

informar [línea 276]

 informar(
                                    
                mixed
                $indice                ,                             
                [mixed
                $parametros = null ]                ,                             
                [string
                $nivel = null ]                                    )

Informa un mensaje predefinido al usuario, usando toba::notificacion() y toba::mensajes()

Parámetros:

mixed	$indice:
mixed	$parametros:
string	$nivel:

informar_msg [línea 261]

 informar_msg(
                                    
                string
                $mensaje                ,                             
                [string
                $nivel = null ]                                    )

Informa un mensaje al usuario

Parámetros:

string	$mensaje:
string	$nivel:

ini [línea 115]

 ini(
        )

Ventana de extensión que se ejecuta al iniciar el componente en todos los pedidos en los que participa.

inicializado [línea 186]

boolean inicializado(
        )

invocar_callback [línea 215]

mixed invocar_callback(
                                    
                string
                $metodo                                    )

Metodo generico de invocar callbacks en el propio objeto

Parámetros:

string

$metodo:

log [línea 142]

 log(
                                    
                
                $txt                                    )

Shortcut de {@link toba_logger::debug() toba::logger()->debug} que incluye información básica del componente actual

Parámetros:

$txt:

mantener_estado_sesion [línea 340]

 mantener_estado_sesion(
        )

set_controlador [línea 485]

 set_controlador(
                                    
                \toba_componente
                $controlador                ,                             
                [string
                $id_en_padre = null ]                                    )

Determina que el componente actual es controlado por otro

Parámetros:

\toba_componente	$controlador:
string	$id_en_padre:

set_propiedades_sesion [línea 367]

 set_propiedades_sesion(
                                    
                array
                $props                                    )

Fuerza a persistir en sesion ciertas propiedades internas

Parámetros:

array

$props:

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