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

toba_datos_tabla

Representa una estructura tabular tipo tabla o RecordSet en memoria

  • Utiliza un administrador de persistencia para obtener y sincronizar los datos con un medio de persistencia.
  • Una vez en memoria existen primitivas para trabajar sobre estos datos.
  • Los datos y sus modificaciones son mantenidos automáticamente en sesión entre los distintos pedidos de página.
  • Una vez terminada la edición se hace la sincronización con el medio de persistencia marcando el final de la transacción de negocios.

toba_componente
   |
   --toba_datos_tabla

Ubicada en /nucleo/componentes/persistencia/toba_datos_tabla.php [line 14]


Métodos Heredados

Heredado de toba_componente

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

Métodos Propios
array   anexar_datos()   Agrega a la tabla en memoria un nuevo set de datos (conservando el estado anterior).
void   cambiar_padre_fila()   Cambia los padres de una fila
void   cargar()   Carga la tabla restringiendo POR valores especificos de campos
void   cargar_con_datos()   Carga la tabla en memoria con un nuevo set de datos (se borra todo estado anterior)
void   control_tope_maximo_filas()   Valida que la cantidad de filas a crear no supere el maximo establecido
void   control_tope_minimo_filas()   Valida que la cantidad de filas supere el mínimo establecido
void   definir_metodo_carga_dao()  
void   destruir()   Destructor del componente
void   eliminar()  
Id.   eliminar_fila()   Elimina una fila de la tabla en memoria
void   eliminar_filas()   Elimina todas las filas de la tabla en memoria
void   eliminar_todo()   Elimina todas las filas de la tabla en memoria y sincroniza con el medio de persistencia
boolean   esta_cargada()   La tabla esta cargada con datos?
boolean   es_campo_modificado()   Verifica si hubo cambios en los valores de un campo especifico
void   evt__validar_fila()   Ventana para hacer validaciones particulares previo a la sincronización
void   evt__validar_ingreso()   Ventana de validacion que se invoca cuando se crea o modifica una fila en memoria. Lanzar una excepcion en caso de error
boolean   existe_fila()   Existe una determina fila? (la fila puede estar marcada como para borrar)
void   existe_fila_condicion()   Busca los registros en memoria que cumplen una condicion.
void   forzar_insercion()   Determina que todas las filas de la tabla son nuevas
void   get()   Retorna el contenido de la fila donde se encuentra posicionado el cursor interno
string   get_alias()   Retorna el alias utilizado para desambiguar la tabla en uniones tales como JOINs
resource   get_blob()   Retorna un 'file pointer' apuntando al campo binario o blob de la tabla.
array   get_cambios_fila()   Calcula las diferencias entre el valor original de la fila al momento de carga y el valor actual
integer   get_cantidad_filas()   Cantidad de filas que tiene la tabla en memoria
integer   get_cantidad_filas_a_sincronizar()   Retorna la cantidad de filas que sufrieron cambios desde la carga, y por lo tanto se van a sincronizar
void   get_clave()   Retorna las columnas que son claves en la tabla
array   get_clave_valor()   Retorna el valor de la clave para un fila dada
mixed   get_columna()   Retorna el valor de la columna de la fila actualmente seleccionada como cursor
void   get_columnas()   Retorna el nombre de las columnas de esta tabla
mixed   get_cursor()   Retorna el Id. interno de la fila donde se encuentra actualmente el cursor de la tabla
array   get_fila()   Retorna el contenido de una fila, a partir de su clave interna
array   get_filas()   Retorna el conjunto de filas que respeta las condiciones dadas Por defecto la búsqueda es afectada por la presencia de cursores en las tablas padres.
mixed   get_fila_columna()   Retorna el valor de una columna en una fila dada
array   get_fks()   Devuelve las fks que asocian a las tablas extendidas
string   get_fuente()   Retorna el nombre de la fuente de datos utilizado por este componente
array()   get_id_filas()   Retorna los ids de todas las filas (sin eliminar) de esta tabla
array   get_id_filas_a_sincronizar()   Retorna lasfilas que sufrieron cambios desde la carga
array()   get_id_filas_filtradas_por_cursor()   Retorna los ids de todas las filas (sin eliminar) de esta tabla
array   get_id_fila_condicion()   Busca los registros en memoria que cumplen una condicion.
void   get_id_fila_padre()   Busca en una tabla padre el id de fila padre que corresponde a la fila hija especificada
void   get_id_padres()   Retorna los padres de un conjunto de registros especificos
void   get_persistidor()  
void   get_proximo_id()   Retorna el proximo id interno a ser utilizado
toba_datos_relacion   get_relacion()   Retorna la relacion que contiene a esta tabla, si existe
string   get_schema()   Retorna el schema de BD sobre el que trabaja el datos_tabla
void   get_tabla()   Nombre de la tabla que se representa en memoria
void   get_tabla_extendida()   Devuelve el nombre de la tabla extendida
integer,   get_tope_max_filas()   Retorna la cantidad maxima de filas que puede contener la tabla (si existe tal restriccion)
integer,   get_tope_min_filas()   Retorna la cantidad minima de fila que debe contener la tabla (si existe tal restriccion)
array   get_valores_columna()   Retorna los valores de una columna específica
void   get_xml()   Agrega en un nodo xml los datos del registro seleccinado en la tabla por el cursor, como atributos del nodo
boolean   hay_cambios()   Determina si los datos cargados en la tabla difieren de los datos existentes en la base al inicio de la transacción
boolean   hay_cambios_fila()   Retorna verdadero si algún valor de la tabla cambio desde el inicio de la transacción
void   hay_cursor()   Hay una fila seleccionada por el cursor?
void   ini()   Ventana para agregar configuraciones particulares antes de que el objeto sea construido en su totalidad
void   log()   Shorcut a toba::logger()->debug incluyendo infomación básica del componente
mixed   modificar_fila()   Modifica los valores de una fila de la tabla en memoria Solo se modifican los valores de las columnas enviadas y que realmente cambien el valor de la fila.
toba_datos_busqueda   nueva_busqueda()   Retorna un objeto en el cual se puede realizar busquedas complejas de registros en memoria
mixed   nueva_fila()   Crea una nueva fila en la tabla en memoria
toba_ap_tabla_db   persistidor()   Retorna el admin. de persistencia que asiste a este objeto durante la sincronización
boolean   posee_columnas_externas()   La tabla posee alguna columna marcada como de 'carga externa' Una columna externa no participa en la sincronización posterior, pero por necesidades casi siempre estáticas necesitan mantenerse junto al conjunto de datos.
void   procesar_filas()   Procesa los cambios masivos de filas
void   registrar_cambio()   Fuerza una cambio directo a la estructura interna que mantiene registro de los cambios
void   reservar_id_fila()   Reserva un id interno y lo retorna
void   resetear()   Deja la tabla sin carga alguna, se pierden todos los cambios realizados desde la carga
void   resetear_cursor()   Asegura que el cursor no se encuentre posicionado en ninguna fila específica
void   restaurar_cursor()   Deshace el ultimo seteo de cursor
void   set()   Cambia el contenido de la fila donde se encuentra el cursor interno
void   set_blob()   Almacena un 'file pointer' en un campo binario o blob de la tabla.
void   set_columna_valor()   Cambia el valor de una columna en todas las filas
void   set_cursor()   Fija el cursor en una fila dada Cuando la tabla tiene un cursor muchas de sus operaciones empiezan a tratar a esta fila como la única y sus tablas padres e hijas también. Por ejemplo al pedir las filas de la tabla hija solo retorna aquellas filas hijas del registro cursor de la tabla padre.
void   set_definicion_columna()  
void   set_es_unico_registro()   Indica que la tabla maneja un único registro en memoria, habilitando la api get/set
void   set_fila_columna_valor()   Cambia el valor de una columna de una fila especifica
void   set_no_duplicado()   Indica una combinacion de columnas cuyos valores no deben duplicarse (similar a un unique de sql)
void   set_tope_max_filas()   Cambia la cantidad maxima de filas que puede contener la tabla
void   set_tope_min_filas()   Cambia la cantidad mínima de filas que debe contener la tabla
integer   sincronizar()   Sincroniza la tabla en memoria con el medio físico a travéz del administrador de persistencia.
integer   sincronizar_filas()   Sincroniza un conjunto de filas de la tabla en memoria con el medio físico a travéz del administrador de persistencia.
void   validar()   Validacion de toda la tabla necesaria previa a la sincronización

anexar_datos  [línea 1492]

  array anexar_datos( array $datos, [boolean $usar_cursores = true]  )

Agrega a la tabla en memoria un nuevo set de datos (conservando el estado anterior).

Se asume que el set de datos llega desde el mecanismo de persistencia.

Parámetros:
array   $datos:  en formato RecordSet
boolean   $usar_cursores:  Los datos cargados se marcan como hijos de los cursores actuales en las tablas padre, sino son hijos del padre que tenia en la base

Return:  Ids. internos de los datos anexados


cambiar_padre_fila  [línea 922]

  void cambiar_padre_fila( mixed $id_fila, array $nuevos_padres  )

Cambia los padres de una fila
Parámetros:
mixed   $id_fila: 
array   $nuevos_padres:  Arreglo (id_tabla_padre => $id_fila_padre, ....), solo se cambian los padres que se pasan por parámetros El resto de los padres sigue con la asociación anterior


cargar  [línea 1442]

  void cargar( [ $clave = array()]  )

Carga la tabla restringiendo POR valores especificos de campos

Si los datos contienen una unica fila, esta se pone como cursor de la tabla

Parámetros:
   $clave: 


cargar_con_datos  [línea 1461]

  void cargar_con_datos( array $datos  )

Carga la tabla en memoria con un nuevo set de datos (se borra todo estado anterior)

Si los datos contienen una unica fila, esta se pone como cursor de la tabla

Parámetros:
array   $datos:  en formato RecordSet


control_tope_maximo_filas  [línea 1385]

  void control_tope_maximo_filas( $cantidad  )

Valida que la cantidad de filas a crear no supere el maximo establecido
Parámetros:
   $cantidad: 

Access:  protected


control_tope_minimo_filas  [línea 1374]

  void control_tope_minimo_filas( )

Valida que la cantidad de filas supere el mínimo establecido

Access:  protected


definir_metodo_carga_dao  [línea 152]

  void definir_metodo_carga_dao( $externa, $resultados, $parametros  )

Parámetros:
   $externa: 
   $resultados: 
   $parametros: 

Access:  protected


destruir  [línea 89]

  void destruir( )

Destructor del componente

Redefinición de:
toba_componente::destruir()
Destructor del componente

eliminar  [línea 1576]

  void eliminar( )


Deprecated:  Desde 0.8.4, usar eliminar_todo()


eliminar_fila  [línea 954]

  Id. eliminar_fila( mixed $id  )

Elimina una fila de la tabla en memoria

En caso de que la fila sea el cursor actual de la tabla, este ultimo se resetea

Parámetros:
mixed   $id:  Id. interno de la fila a eliminar

Return:  interno de la fila eliminada


eliminar_filas  [línea 987]

  void eliminar_filas( [boolean $con_cursores = true]  )

Elimina todas las filas de la tabla en memoria
Parámetros:
boolean   $con_cursores:  Tiene en cuenta los cursores del padre para afectar solo sus filas hijas, por defecto utiliza cursores.


eliminar_todo  [línea 1564]

  void eliminar_todo( )

Elimina todas las filas de la tabla en memoria y sincroniza con el medio de persistencia


esta_cargada  [línea 1451]

  boolean esta_cargada( )

La tabla esta cargada con datos?


es_campo_modificado  [línea 1873]

  boolean es_campo_modificado( string $campo, integer $id_viejos, array $datos_nuevos  )

Verifica si hubo cambios en los valores de un campo especifico
Parámetros:
string   $campo:  Nombre de la columna a comparar
integer   $id_viejos:  Identificador de la fila con los datos viejos
array   $datos_nuevos:  Arreglo con los datos nuevos


evt__validar_fila  [línea 1344]

  void evt__validar_fila( array $fila  )

Ventana para hacer validaciones particulares previo a la sincronización

El proceso puede ser abortado con un toba_error, el mensaje se muestra al usuario

Parámetros:
array   $fila:  Asociativo clave-valor de la fila a validar

Information Tags:
Ventana:  

evt__validar_ingreso  [línea 1253]

  void evt__validar_ingreso( array $fila, [mixed $id = null]  )

Ventana de validacion que se invoca cuando se crea o modifica una fila en memoria. Lanzar una excepcion en caso de error
Parámetros:
array   $fila:  Datos de la fila
mixed   $id:  Id. interno de la fila, si tiene (en el caso modificacion de la fila)

Access:  protected

Information Tags:
Ventana:  

existe_fila  [línea 763]

  boolean existe_fila( mixed $id  )

Existe una determina fila? (la fila puede estar marcada como para borrar)
Parámetros:
mixed   $id:  Id. interno de la fila


existe_fila_condicion  [línea 783]

  void existe_fila_condicion( array $condiciones, [boolean $usar_cursores = true]  )

Busca los registros en memoria que cumplen una condicion.

Solo se chequea la condicion de igualdad. No se chequean tipos

Parámetros:
array   $condiciones:  Asociativo de campo => valor. Para condiciones más complejas (no solo igualdad) puede ser array($columna, $condicion, $valor), por ejemplo array(array('id_persona','>=',10),...)
boolean   $usar_cursores:  Este conjunto de filas es afectado por la presencia de cursores en las tablas padres


forzar_insercion  [línea 1764]

  void forzar_insercion( [boolean $usar_cursores = false], [ $filas = null]  )

Determina que todas las filas de la tabla son nuevas
Parámetros:
boolean   $usar_cursores:  Si esta seteado, solo se marcan como nuevas las filas marcadas por el cursor
   $filas: 


get  [línea 1114]

  void get( )

Retorna el contenido de la fila donde se encuentra posicionado el cursor interno

Si la tabla se definio admitiendo a lo sumo un registro, este cursor se posiciona automáticamente en la carga, sino se debe explicitar con el método set_cursor En caso de que no haya registros retorna NULL



get_alias  [línea 1696]

  string get_alias( )

Retorna el alias utilizado para desambiguar la tabla en uniones tales como JOINs

Se toma el primero seteado de: el alias definido, el rol en la relación o el nombre de la tabla



get_blob  [línea 1169]

  resource get_blob( string $columna, [mixed $id_fila = null]  )

Retorna un 'file pointer' apuntando al campo binario o blob de la tabla.
Parámetros:
string   $columna:  Nombre de la columna binaria-blob
mixed   $id_fila:  Id. interno de la fila que contiene la columna, en caso de ser vacio se utiliza el cursor


get_cambios_fila  [línea 1823]

  array get_cambios_fila( $id_fila, [ $datos_ap = array()]  )

Calcula las diferencias entre el valor original de la fila al momento de carga y el valor actual
Parámetros:
   $id_fila: 
   $datos_ap: 

Return:  Asociativo campo => array('anterior' => $anterior, 'actual' => $actual)


get_cantidad_filas  [línea 753]

  integer get_cantidad_filas( [ $usar_cursores = true]  )

Cantidad de filas que tiene la tabla en memoria

El conjunto de filas utilizado es afectado por la presencia de cursores en las tablas padres

Parámetros:
   $usar_cursores: 


get_cantidad_filas_a_sincronizar  [línea 370]

  integer get_cantidad_filas_a_sincronizar( )

Retorna la cantidad de filas que sufrieron cambios desde la carga, y por lo tanto se van a sincronizar


get_clave  [línea 324]

  void get_clave( )

Retorna las columnas que son claves en la tabla


get_clave_valor  [línea 338]

  array get_clave_valor( mixed $id_fila  )

Retorna el valor de la clave para un fila dada
Parámetros:
mixed   $id_fila:  Id. interno de la fila

Return:  Valores de las claves para esta fila, en formato RecordSet


get_columna  [línea 737]

  mixed get_columna( string $columna  )

Retorna el valor de la columna de la fila actualmente seleccionada como cursor
Parámetros:
string   $columna:  Id. de la columna que contiene el valor a retornar

Return:  NULL si no cursor o no hay filas


get_columnas  [línea 1649]

  void get_columnas( )

Retorna el nombre de las columnas de esta tabla


get_cursor  [línea 507]

  mixed get_cursor( )

Retorna el Id. interno de la fila donde se encuentra actualmente el cursor de la tabla


get_fila  [línea 688]

  array get_fila( mixed $id  )

Retorna el contenido de una fila, a partir de su clave interna
Parámetros:
mixed   $id:  Id. interno de la fila en memoria

Return:  columna => valor. En caso de no existir la fila retorna NULL


get_filas  [línea 536]

  array get_filas( [array $condiciones = null], [boolean $usar_id_fila = false], [boolean $usar_cursores = true]  )

Retorna el conjunto de filas que respeta las condiciones dadas Por defecto la búsqueda es afectada por la presencia de cursores en las tablas padres.
Parámetros:
array   $condiciones:  Se utiliza este arreglo campo=>valor y se retornan los registros que cumplen (con condicion de igualdad) con estas restricciones. El valor no puede ser NULL porque siempre da falso
boolean   $usar_id_fila:  Hace que las claves del array resultante sean las claves internas del datos_tabla. Sino se usa una clave posicional y la clave viaja en la columna apex_datos_clave_fila
boolean   $usar_cursores:  Este conjunto de filas es afectado por la presencia de cursores en las tablas padres.

Return:  Formato tipo RecordSet


get_fila_columna  [línea 707]

  mixed get_fila_columna( mixed $id, string $columna  )

Retorna el valor de una columna en una fila dada
Parámetros:
mixed   $id:  Id. interno de la fila
string   $columna:  Nombre de la columna

Return:  En caso de no existir, retorna NULL


get_fks  [línea 403]

  array get_fks( )

Devuelve las fks que asocian a las tablas extendidas


get_fuente  [línea 1658]

  string get_fuente( )

Retorna el nombre de la fuente de datos utilizado por este componente


get_id_filas  [línea 559]

  array() get_id_filas( [boolean $usar_cursores = true]  )

Retorna los ids de todas las filas (sin eliminar) de esta tabla
Parámetros:
boolean   $usar_cursores:  Este conjunto de filas es afectado por la presencia de cursores en las tablas padres

Information Tags:
Todo:  Se podría optimizar este método para no recaer en tantos recorridos

get_id_filas_a_sincronizar  [línea 388]

  array get_id_filas_a_sincronizar( [array $cambios = array("d","i","u")]  )

Retorna lasfilas que sufrieron cambios desde la carga
Parámetros:
array   $cambios:  Combinación de tipos de cambio a buscar: d, i o u (por defecto los tres)

Return:  Ids. internos


get_id_filas_filtradas_por_cursor  [línea 583]

  array() get_id_filas_filtradas_por_cursor( [ $incluir_eliminados = false], boolean $usar_cursores  )

Retorna los ids de todas las filas (sin eliminar) de esta tabla
Parámetros:
boolean   $usar_cursores:  Este conjunto de filas es afectado por la presencia de cursores en las tablas padres
   $incluir_eliminados: 

Information Tags:
Todo:  Se podría optimizar este método para no recaer en tantos recorridos

get_id_fila_condicion  [línea 639]

  array get_id_fila_condicion( [array $condiciones = null], [boolean $usar_cursores = true]  )

Busca los registros en memoria que cumplen una condicion.

Solo se chequea la condicion de igualdad. No se chequean tipos

Parámetros:
array   $condiciones:  Asociativo de campo => valor. El valor no puede ser NULL porque siempre da falso Para condiciones más complejas (no solo igualdad) puede ser array($columna, $condicion, $valor), por ejemplo array(array('id_persona','>=',10),...)
boolean   $usar_cursores:  Este conjunto de filas es afectado por la presencia de cursores en las tablas padres

Return:  Ids. internos de las filas, pueden no estar numerado correlativamente


get_id_fila_padre  [línea 620]

  void get_id_fila_padre( $tabla_padre, $id_fila  )

Busca en una tabla padre el id de fila padre que corresponde a la fila hija especificada
Parámetros:
   $tabla_padre: 
   $id_fila: 


get_id_padres  [línea 605]

  void get_id_padres( $ids_propios, $tabla_padre  )

Retorna los padres de un conjunto de registros especificos
Parámetros:
   $ids_propios: 
   $tabla_padre: 


get_persistidor  [línea 1431]

  void get_persistidor( )


Deprecated:  Usar persistidor() a secas


get_proximo_id  [línea 203]

  void get_proximo_id( )

Retorna el proximo id interno a ser utilizado


get_relacion  [línea 301]

  toba_datos_relacion get_relacion( )

Retorna la relacion que contiene a esta tabla, si existe


get_schema  [línea 1683]

  string get_schema( )

Retorna el schema de BD sobre el que trabaja el datos_tabla


get_tabla  [línea 1666]

  void get_tabla( )

Nombre de la tabla que se representa en memoria


get_tabla_extendida  [línea 1674]

  void get_tabla_extendida( )

Devuelve el nombre de la tabla extendida


get_tope_max_filas  [línea 351]

  integer, get_tope_max_filas( )

Retorna la cantidad maxima de filas que puede contener la tabla (si existe tal restriccion)

Return:  0 si no hay tope


get_tope_min_filas  [línea 361]

  integer, get_tope_min_filas( )

Retorna la cantidad minima de fila que debe contener la tabla (si existe tal restriccion)

Return:  0 si no hay tope


get_valores_columna  [línea 723]

  array get_valores_columna( string $columna  )

Retorna los valores de una columna específica

El conjunto de filas utilizado es afectado por la presencia de cursores en las tablas padres

Parámetros:
string   $columna:  Nombre del campo o columna

Return:  Arreglo plano de valores


get_xml  [línea 1907]

  void get_xml( SimpleXMLElement $xml  )

Agrega en un nodo xml los datos del registro seleccinado en la tabla por el cursor, como atributos del nodo
Parámetros:
SimpleXMLElement   $xml:  El objeto nodo xml al que se le van a agregar los atributos


hay_cambios  [línea 1793]

  boolean hay_cambios( )

Determina si los datos cargados en la tabla difieren de los datos existentes en la base al inicio de la transacción


hay_cambios_fila  [línea 1813]

  boolean hay_cambios_fila( $id_fila  )

Retorna verdadero si algún valor de la tabla cambio desde el inicio de la transacción
Parámetros:
   $id_fila: 


hay_cursor  [línea 517]

  void hay_cursor( )

Hay una fila seleccionada por el cursor?


ini  [línea 83]

  void ini( )

Ventana para agregar configuraciones particulares antes de que el objeto sea construido en su totalidad

Information Tags:
Ventana:  
Redefinición de:
toba_componente::ini()
Ventana de extensión que se ejecuta al iniciar el componente en todos los pedidos en los que participa.

log  [línea 211]

  void log( $txt  )

Shorcut a toba::logger()->debug incluyendo infomación básica del componente
Parámetros:
   $txt: 

Access:  protected

Redefinición de:
toba_componente::log()
Shortcut de toba::logger()->debug que incluye información básica del componente actual

modificar_fila  [línea 866]

  mixed modificar_fila( mixed $id, array $fila, [array $nuevos_padres = null]  )

Modifica los valores de una fila de la tabla en memoria Solo se modifican los valores de las columnas enviadas y que realmente cambien el valor de la fila.
Parámetros:
mixed   $id:  Id. interno de la fila a modificar
array   $fila:  Contenido de la fila, en formato columna=>valor, puede ser incompleto
array   $nuevos_padres:  Arreglo (id_tabla_padre => $id_fila_padre, ....), solo se cambian los padres que se pasan por parámetros El resto de los padres sigue con la asociación anterior

Return:  Id. interno de la fila modificada


nueva_busqueda  [línea 312]

  toba_datos_busqueda nueva_busqueda( )

Retorna un objeto en el cual se puede realizar busquedas complejas de registros en memoria


nueva_fila  [línea 820]

  mixed nueva_fila( [array $fila = array()], [mixed $ids_padres = null], [integer $id_nuevo = null]  )

Crea una nueva fila en la tabla en memoria
Parámetros:
array   $fila:  Asociativo campo=>valor a insertar
mixed   $ids_padres:  Asociativo padre =>id de las filas padres de esta nueva fila, en caso de que no se brinde, se utilizan los cursores actuales en estas tablas padres
integer   $id_nuevo:  Opcional. Id interno de la nueva fila, si no se especifica (recomendado) Se utiliza el proximo id interno.

Return:  Id. interno de la fila creada


persistidor  [línea 1402]

  toba_ap_tabla_db persistidor( )

Retorna el admin. de persistencia que asiste a este objeto durante la sincronización


posee_columnas_externas  [línea 1713]

  boolean posee_columnas_externas( )

La tabla posee alguna columna marcada como de 'carga externa' Una columna externa no participa en la sincronización posterior, pero por necesidades casi siempre estáticas necesitan mantenerse junto al conjunto de datos.


procesar_filas  [línea 1045]

  void procesar_filas( array $filas, [mixed $ids_padres = null]  )

Procesa los cambios masivos de filas

El id de la fila se asume que la key del registro o la columna apex_datos_clave_fila Para procesar es necesario indicar el estado de cada fila utilizando una columna referenciada con la constante 'apex_ei_analisis_fila' los valores pueden ser:

  • 'A': Alta
  • 'B': Baja
  • 'M': Modificacion

Parámetros:
array   $filas:  Filas en formato RecordSet, cada registro debe contener un valor para la constante apex_ei_analisis_fila
mixed   $ids_padres:  Asociativo padre =>id de las filas padres de esta nueva fila, en caso de que no se brinde, se utilizan los cursores actuales en estas tablas padres


registrar_cambio  [línea 1784]

  void registrar_cambio( mixed $fila, string $estado  )

Fuerza una cambio directo a la estructura interna que mantiene registro de los cambios
Parámetros:
mixed   $fila:  Id. interno de la fila
string   $estado: 

Access:  protected


reservar_id_fila  [línea 193]

  void reservar_id_fila( )

Reserva un id interno y lo retorna


resetear  [línea 1585]

  void resetear( )

Deja la tabla sin carga alguna, se pierden todos los cambios realizados desde la carga


resetear_cursor  [línea 497]

  void resetear_cursor( )

Asegura que el cursor no se encuentre posicionado en ninguna fila específica


restaurar_cursor  [línea 487]

  void restaurar_cursor( )

Deshace el ultimo seteo de cursor


set  [línea 1093]

  void set( array $fila  )

Cambia el contenido de la fila donde se encuentra el cursor interno

Si la tabla se definio admitiendo a lo sumo un registro, este cursor se posiciona automáticamente en la carga, sino se debe explicitar con el método set_cursor En caso que no existan filas, se crea una nueva y se posiciona el cursor en ella Si la fila es null, se borra la fila actual

Parámetros:
array   $fila:  Contenido total o parcial de la fila a crear o modificar (si es null borra la fila actual)


set_blob  [línea 1136]

  void set_blob( string $columna, resource $blob, [mixed $id_fila = null]  )

Almacena un 'file pointer' en un campo binario o blob de la tabla.
Parámetros:
string   $columna:  Nombre de la columna binaria-blob
resource   $blob:  file pointer o null en caso de querer borrar el valor
mixed   $id_fila:  Id. interno de la fila que contiene la columna, en caso de ser vacio se utiliza el cursor


set_columna_valor  [línea 1022]

  void set_columna_valor( string $columna, mixed $valor, [boolean $con_cursores = false]  )

Cambia el valor de una columna en todas las filas
Parámetros:
string   $columna:  Nombre de la columna a modificar
mixed   $valor:  Nuevo valor comun a toda la columna
boolean   $con_cursores:  Tiene en cuenta los cursores del padre para afectar sus filas hijas, por defecto no


set_cursor  [línea 472]

  void set_cursor( mixed $id  )

Fija el cursor en una fila dada Cuando la tabla tiene un cursor muchas de sus operaciones empiezan a tratar a esta fila como la única y sus tablas padres e hijas también. Por ejemplo al pedir las filas de la tabla hija solo retorna aquellas filas hijas del registro cursor de la tabla padre.
Parámetros:
mixed   $id:  Id. interno de la fila


set_definicion_columna  [línea 185]

  void set_definicion_columna( $columna, $propiedad, $valor  )

Parámetros:
   $columna: 
   $propiedad: 
   $valor: 


set_es_unico_registro  [línea 457]

  void set_es_unico_registro( boolean $unico  )

Indica que la tabla maneja un único registro en memoria, habilitando la api get/set
Parámetros:
boolean   $unico: 


set_fila_columna_valor  [línea 1001]

  void set_fila_columna_valor( mixed $id, string $columna, mixed $valor  )

Cambia el valor de una columna de una fila especifica
Parámetros:
mixed   $id:  Id. interno de la fila de la tabla en memoria
string   $columna:  Columna o campo de la fila
mixed   $valor:  Nuevo valor


set_no_duplicado  [línea 448]

  void set_no_duplicado( $columnas  )

Indica una combinacion de columnas cuyos valores no deben duplicarse (similar a un unique de sql)
Parámetros:
   $columnas: 


set_tope_max_filas  [línea 416]

  void set_tope_max_filas( integer $cantidad  )

Cambia la cantidad maxima de filas que puede contener la tabla
Parámetros:
integer   $cantidad:  0 si no hay tope


set_tope_min_filas  [línea 434]

  void set_tope_min_filas( integer $cantidad  )

Cambia la cantidad mínima de filas que debe contener la tabla
Parámetros:
integer   $cantidad:  0 si no hay tope


sincronizar  [línea 1528]

  integer sincronizar( [ $usar_cursores = false]  )

Sincroniza la tabla en memoria con el medio físico a travéz del administrador de persistencia.
Parámetros:
   $usar_cursores: 

Return:  Cantidad de registros modificados en el medio


sincronizar_filas  [línea 1552]

  integer sincronizar_filas( $filas  )

Sincroniza un conjunto de filas de la tabla en memoria con el medio físico a travéz del administrador de persistencia.
Parámetros:
   $filas: 

Return:  Cantidad de registros modificados en el medio


validar  [línea 1320]

  void validar( [ $filas = array()]  )

Validacion de toda la tabla necesaria previa a la sincronización
Parámetros:
   $filas: 




Desarrollado por SIU.
Documentación generada con phpDocumentor 1.4.3