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

toba_componente

Padre de todas las clases que definen componentes


		
		

Ubicada en /nucleo/componentes/toba_componente.php [line 17]

Deprecated: Function split() is deprecated in /home/ricardo/proyectos/toba_migraciones/proyectos/toba_editor/www/doc/api/Componentes/Negocio/c305412028b9a2be48c5677e1d4f636f/%%404^%%40462378^classtags.tpl.php on line 37
Documentación WIKI

Abstract  

Subclases directas
toba_datos_relacion Mantiene un conjunto relacionado de datos_tabla, brindando servicios para cargar y sincronizar esta relación con algún medio de persistencia (general una BD relacional)
toba_datos_tabla Representa una estructura tabular tipo tabla o RecordSet en memoria
toba_ei Clase base de los componentes gráficos o elementos de interface (ei)
toba_cn Este componente permite unificar la carga y entrega de datos y servicios a una jerarquia completa de componentes de interface (especialmente a los cis)
toba_servicio_web

Métodos Propios
static void   set_modo_compatible_manejo_sesion()   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.
toba_componente   __construct()  
void   agregar_dependencia()   Agregar dinámicamente una dependencia al componente actual
void   agregar_dependencia_por_indice()   Agregar dinámicamente una dependencia al componente actual utilizando
void   borrar_memoria()   Elimina toda la memoria interna actual y de pedidos anteriores
toba_ci   controlador()   Retorna la referencia al componente padre o contenedor del actual, generalmente un ci
toba_componente   dep()  
toba_componente   dependencia()   Accede a una dependencia del objeto, opcionalmente si la dependencia no esta cargada, la carga
boolean   dependencia_cargada()   Retorna verdadero si la dependencia fue construida y asociada en este pedido de página
void   destruir()   Destructor del componente
void   eliminar_estado_sesion()   Elimina de la sesion las propiedades de este componente, a su vez pone en null estas propiedades en este objeto
boolean   existe_dependencia()   Retorna verdadero si un componente es dependencia del actual
integer   get_cantidad_dependencias()   Retorna la cantidad de dependencias cargadas
array   get_dependencias()   Retorna un array con las dependencias cargadas del componente
array   get_dependencias_clase()   Devuelve las dependencias cuya clase de componente coincide con la expresion regular pasada como parametro
array   get_estado_sesion()   Construye un arreglo con los valores de todas las propiedades a almacenarse en sesion
array   get_id()   Retorna el identificador del componente
string   get_mensaje()   Retorna un mensaje asociado al componente
string   get_nombre()   Retorna el nombre del componente según se definió en el editor
void   get_parametro()   Retorna un parámetro estático definido en las prop. básicas del componente
string   get_titulo()   Retorna el título del componente (nombre visible al usuario)
void   informar()   Informa un mensaje predefinido al usuario, usando toba::notificacion() y toba::mensajes()
void   informar_msg()   Informa un mensaje al usuario
void   ini()   Ventana de extensión que se ejecuta al iniciar el componente en todos los pedidos en los que participa.
boolean   inicializado()  
mixed   invocar_callback()   Metodo generico de invocar callbacks en el propio objeto
void   log()   Shortcut de toba::logger()->debug que incluye información básica del componente actual
void   mantener_estado_sesion()  
void   set_controlador()   Determina que el componente actual es controlado por otro
void   set_propiedades_sesion()   Fuerza a persistir en sesion ciertas propiedades internas
void   __sleep()  

static method set_modo_compatible_manejo_sesion  [línea 93]

  static void 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: 


agregar_dependencia  [línea 551]

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

Agregar dinámicamente una dependencia al componente actual
Parámetros:
string   $identificador:  ID. de la dependencia
string   $proyecto: 
string   $objeto:  ID. de componente en el proyecto


agregar_dependencia_por_indice  [línea 567]

  void agregar_dependencia_por_indice( $identificador_rol, $identificador_componente, string $identificador, string $proyecto, string $tipo  )

Agregar dinámicamente una dependencia al componente actual utilizando
Parámetros:
string   $identificador:  ID. del componente
string   $proyecto: 
string   $tipo:  Tipo de componente
   $identificador_rol: 
   $identificador_componente: 


borrar_memoria  [línea 327]

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

See:  toba_componente::dependencia()


dependencia  [línea 527]

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

Accede a una dependencia del objeto, opcionalmente si la dependencia no esta cargada, la carga
Parámetros:
string   $id:  Identificador de la dependencia dentro del objeto actual
boolean   $cargar_en_demanda:  En caso de que el objeto no se encuentre cargado en memoria, lo carga
   $carga_en_demanda: 

Redefinido en subclases como:
  • toba_ci::dependencia() : Accede a una dependencia del objeto, opcionalmente si la dependencia no esta cargada, la carga

dependencia_cargada  [línea 620]

  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]

  void destruir( )

Destructor del componente

Redefinido en subclases como:

eliminar_estado_sesion  [línea 440]

  void 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:  Excepciones, propiedades que no se van a poner en null


existe_dependencia  [línea 629]

  boolean existe_dependencia( $id  )

Retorna verdadero si un componente es dependencia del actual
Parámetros:
   $id: 

Redefinido en subclases como:

get_cantidad_dependencias  [línea 647]

  integer get_cantidad_dependencias( )

Retorna la cantidad de dependencias cargadas


get_dependencias  [línea 638]

  array get_dependencias( )

Retorna un array con las dependencias cargadas del componente


get_dependencias_clase  [línea 656]

  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

Return:  Arreglo(propiedad => valor)


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:  Indice del mensaje en el componente
mixed   $parametros:  Parámetros posicionales a ser reemplazados en el mensaje (puede ser uno solo o un array)

Return:  Mensaje parseado
See:  toba_mensajes


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]

  void get_parametro( string $parametro  )

Retorna un parámetro estático definido en las prop. básicas del componente
Parámetros:
string   $parametro:  Puede ser a,b,c,d,e,f


get_titulo  [línea 168]

  string get_titulo( )

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


informar  [línea 276]

  void 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:  Indice del mensaje predefinido
mixed   $parametros:  Parámetros posicionales a ser reemplazados en el mensaje (puede ser uno solo o un array)
string   $nivel:  Severidad: info o error

See:  toba_notificacion
See:  toba_mensajes


informar_msg  [línea 261]

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

Informa un mensaje al usuario
Parámetros:
string   $mensaje:  Mensaje a mostrar
string   $nivel:  Severidad: info o error

See:  toba_notificacion
See:  toba_mensajes


ini  [línea 115]

  void ini( )

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

Como la ventana es previa a la atención de eventos y servicios es un punto ideal para la configuración global del componente


Information Tags:
Ventana:  
Redefinido en subclases como:
  • toba_datos_relacion::ini() : Ventana para agregar configuraciones particulares al inicio de la vida completa del componente
  • toba_datos_tabla::ini() : Ventana para agregar configuraciones particulares antes de que el objeto sea construido en su totalidad
  • toba_ei_grafico::ini()
  • toba_ci::ini() : Ventana de extensión que se ejecuta al iniciar el componente en todos los pedidos en los que participa.
  • toba_cn::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:  Nombre completo del metodo a invocar

Return:  apex_callback_sin_rpta en caso que no se encuentre el callback, sino la respuesta del metodo
Access:  protected


log  [línea 142]

  void log( $txt  )

Shortcut de toba::logger()->debug que incluye información básica del componente actual
Parámetros:
   $txt: 

Access:  protected

Redefinido en subclases como:

mantener_estado_sesion  [línea 340]

  void mantener_estado_sesion( )


Deprecated:  Usar $this->set_propiedades_sesion


set_controlador  [línea 485]

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

Determina que el componente actual es controlado por otro
Parámetros:
toba_componente   $controlador:  Padre o contenedor de este componente
string   $id_en_padre:  Id de este componente en el padre (conocido como dependencia)

Redefinido en subclases como:

set_propiedades_sesion  [línea 367]

  void set_propiedades_sesion( array $props  )

Fuerza a persistir en sesion ciertas propiedades internas
Parámetros:
array   $props:  Arreglo que contiene los nombres de las propiedades

Access:  protected


__sleep  [línea 83]

  void __sleep( )





Desarrollado por SIU.
Documentación generada con phpDocumentor 1.4.3