Class gvHidraForm_DB

Description

gvHidraForm_DB extension gvHidra que permite mantener un FORM mediante un CRUD sobre una base de datos relacional. Debe indicarse el DSN de conexion a la misma y la correlacion campos de pantalla con campos de la bd (matching).

  • author: Toni: <felix_ant@gva.es>
  • version: $Id: gvHidraForm_DB.php,v 1.31.2.5 2011/10/04 11:19:40 afelixf Exp $

Located in /include/gvh_patterns/gvHidraForm_DB.php (line 50)

Object
   |
   --Action
      |
      --gvHidraForm
         |
         --gvHidraForm_DB
Direct descendents
Class Description
IgepPeticionesD gvHidraForm_DB extension gvHidra que permite mantener un FORM mediante un CRUD sobre una base de datos relacional. Debe indicarse el DSN de conexion a la misma y la correlacion campos de pantalla con campos de la bd (matching).
IgepPeticiones gvHidraForm_DB extension gvHidra que permite mantener un FORM mediante un CRUD sobre una base de datos relacional. Debe indicarse el DSN de conexion a la misma y la correlacion campos de pantalla con campos de la bd (matching).
IgepNovedades gvHidraForm_DB extension gvHidra que permite mantener un FORM mediante un CRUD sobre una base de datos relacional. Debe indicarse el DSN de conexion a la misma y la correlacion campos de pantalla con campos de la bd (matching).
gvHidraTreePattern gvHidraTreePattern es la clase que contiene la información y el comportamiento para crear un patrón árbol de gvHidra
Variable Summary
Method Summary
gvHidraForm_DB gvHidraForm_DB ([ $dsn = ''], [ $nombreTablas = null])
none addConstante (nombre $nombre, valor $valor)
none addList (obj_lista $objLista)
none addMatching (campoTpl $campoTpl, campoBD $campoBD, tablaBD $tablaBD)
integer calcularSecuencia (tabla $tabla, campoSecuencia $campoSecuencia, camposDependientes $camposDependientes, [valorInicial $valorInicial = 1])
integer calcularSecuenciaBD (nombreSecuencia $nombreSecuencia)
array consultar (string $str_consulta, [array $tipo = NULL])
object getConnection ()
void getDSN ()
string getFilterForEdit (none 0)
string getFilterForSearch (none 0)
integer getTipoConsulta ()
integer operar (string $str_operacion)
integer postBorrar ()
integer postInsertar ( $objDatos)
integer postModificar ( $m_datos)
void prepareDataSourceDetails ( $detail,  $masterData)
void processDelete ()
void processInsert ()
void processUpdate ()
none recoverData ()
void recoverDataEdit ()
void regenerarInstancia ([ $dsn = ''])
none setFilterForEdit (newFilter $newFilter)
none setFilterForSearch (newFilter $newFilter)
none setLimiteConsulta (integer $int_limite)
void setOrderByForEditQuery (String $query)
void setOrderByForSearchQuery (String $query)
integer setParametrosBusqueda (string $str_where)
void setPKForQueries (array $fieldsForSearchQuery, [array $fieldsForEditQuery = array()])
integer setSearchParameters (string $str_where)
void setSelectForEditQuery (String $query)
void setSelectForSearchQuery (String $query)
none setTipoConsulta (integer $valorTipoConsulta)
void setWhereForEditQuery (String $query)
void setWhereForSearchQuery (String $query)
none showOnlyNewRecordsAfterInsert (boolean $value)
Variables
string $str_orderBy (line 86)

string que contiene el ORDER BY de la SELECT

  • var: str_orderBy
string $str_orderByEditar (line 117)

Esta variable contiene el ORDER BY que se aplicará al segundo panel de edición.

string $str_select (line 79)

string que contiene la SELECT que define el contenido del panel en su pestaña principal (la que se mostrará tras lanzar el panel de busqueda). Esta select debe ser inicializada por el programador en la clase contenida en actions

  • var: str_select
string $str_selectEditar (line 105)

Esta variable contiene la SELECT que se aplicará al segundo panel de edición.

string $str_where (line 99)

Esta variable contiene la WHERE que se aplicará a la Select de búsqueda

string $str_whereEditar (line 111)

Esta variable contiene la WHERE que se aplicará al segundo panel de edición.

Inherited Variables

Inherited from gvHidraForm

gvHidraForm::$comunica
gvHidraForm::$obj_errorNegocio
gvHidraForm::$obj_mensaje
gvHidraForm::$obj_ultimaConsulta
gvHidraForm::$str_nombrePadre
gvHidraForm::$v_hijos
Methods
Constructor gvHidraForm_DB (line 186)

constructor. Generará a partir de los parámetros que se le pasen una conexión a al base de datos y un array de manejadores de tablas (una por cada una de las que mantenga el panel hijo).

gvHidraForm_DB gvHidraForm_DB ([ $dsn = ''], [ $nombreTablas = null])
  • $dsn
  • $nombreTablas
addConstante (line 981)

Función encargada de almacenar constantes que se añaden al DBResult que se muestra en un panel.

Es importante tener en cuenta que no se pueden añadir constantes en consultas con el operador SQL DISTINCT afectando a todo la tupla.

  • access: public
none addConstante (nombre $nombre, valor $valor)
  • nombre $nombre: nombre que se le da a la constante
  • valor $valor: valor que va a tomar la constante
addList (line 942)

Función encargada de indicar a Negocio que existe una definición de una nueva Lista

  • access: public
none addList (obj_lista $objLista)
  • obj_lista $objLista: objetivo de tipo gvHidraList.

Redefinition of:
gvHidraForm::addList()
Función encargada de indicar a Negocio que existe una definición de una nueva Lista
addMatching (line 919)

Función encargada de indicar a Negocio la correspondencia de los campos de la TPL con los campos de la BD.

En principio sólo deben de indicarse los campos que se almacenarán en la BD.

  • access: public
none addMatching (campoTpl $campoTpl, campoBD $campoBD, tablaBD $tablaBD)
  • campoTpl $campoTpl: corresponde con el nombre del campo en la Tpl
  • campoBD $campoBD: indica el nombre del campo en la tabla de la BD
  • tablaBD $tablaBD: indica el nombre de la tabla a la que corresponde.

Redefined in descendants as:
calcularSecuencia (line 892)

Este método calcula una secuencia compuesta por varios campos de la misma tabla.

  • access: public
integer calcularSecuencia (tabla $tabla, campoSecuencia $campoSecuencia, camposDependientes $camposDependientes, [valorInicial $valorInicial = 1])
  • tabla $tabla: string nombre de la tabla de la BD
  • campoSecuencia $campoSecuencia: string campo del que se quiere obtener la secuencia
  • camposDependientes $camposDependientes: array contiene el nombre de los campos de los cuales va a depender la secuencia y sus valores. Estructura [nombreBD] = valor
  • valorInicial $valorInicial: integer Fija el valor inicial que devuelve calcularSecuencia en el caso de que no exístan tuplas en la tabla el valor por defecto es 1
calcularSecuenciaBD (line 872)

Este método devuelve el valor de una secuencia programada en la base de datos para la conexión del panel

  • access: public
integer calcularSecuenciaBD (nombreSecuencia $nombreSecuencia)
  • nombreSecuencia $nombreSecuencia: string nombre de la secuencia en la BD
consultar (line 997)

Función que realiza una consulta a la Base de datos con la conexión actual Es la función que el programador debe gastar para realizar una consulta SQL

  • return: devuelve un array si todo ha ido bien o -1 en caso de error.
  • access: public
array consultar (string $str_consulta, [array $tipo = NULL])
  • string $str_consulta: que contiene la consulta.
  • array $tipo: vector que indica si queremos convertir los datos
getConnection (line 248)

Devuelve el objeto conexión al que se está conectado.

  • access: public
object getConnection ()
getDSN (line 235)
void getDSN ()
getFilterForEdit (line 629)

Permite obtener el filtro actual que se está utilizando sobre la EditQuery.

Devuelve la construcción que ha realizado el FW tras ejecutarse la accion buscar. Es el WHERE que obtiene los registros que se muestran en ese momento en el panel EditQuery

  • access: public
string getFilterForEdit (none 0)
  • none 0
getFilterForSearch (line 602)

Permite obtener el filtro actual que se está utilizando sobre la SearchQuery.

Devuelve la construcción que ha realizado el FW tras ejecutarse la accion buscar. Es el WHERE que obtiene los registros que se muestran en ese momento en el panel SearhQuery

  • access: public
string getFilterForSearch (none 0)
  • none 0
getTipoConsulta (line 1080)

Método que sirve para obtener el tipo de consulta del panel. Las posibilidades son: (0) Se contruye la Where igualando los campos a los valores.

(1) Se construye con like y comodines para cada campo. (2) Por defecto, se contruye con like sólo si el usuario ha especificado comodines.

  • access: public
integer getTipoConsulta ()
limpiarInstancia (line 856)

Método que limpia de variables inncesarias el objeto actual antes de guardarlo en la SESSION

  • access: public
void limpiarInstancia ()

Redefinition of:
gvHidraForm::limpiarInstancia()
Método que limpia de variables inncesarias el objeto actual antes de guardarlo en la SESSION
operar (line 1025)

Función que realiza una operación SQL en la Base de datos con la conexión actual Es la función que el programador debe gastar para realizar una operación SQL

  • return: devuelve 0 si todo ha ido bien o -1 en caso de error
  • access: public
integer operar (string $str_operacion)
  • string $str_operacion: que contiene la operación a realizar.
postBorrar (line 813)

Este método es el método abstracto que ofrece Igep para realizar operaciones una vez realiza la acción de borrar. Todo lo que se realice en este evento está

incluido en la TRANSACTION por lo que podrá cancelarse la operación. Su utilización pude ser:

  • Si se quiere borrar N tuplas en una tabla con relación 1:N con la tabla sobre la que ya hemos borrado. Si no se puede realizar la operación, podemos cancelar toda la transacción.

IMPORTANTE:: Si se quiere interrumpir la ejecución del borrado, el programador debe utilizar el método setError para indicar que se ha producido un error.

  • abstract:
  • access: public
integer postBorrar ()
postInsertar (line 661)

Este método es el método abstracto que ofrece Igep para realizar operaciones una vez realiza la acción de insertar. Todo lo que se realice en este evento está

incluido en la TRANSACTION por lo que podrá cancelarse la operación. Su utilización pude ser:

  • Si se quiere insertar N tuplas en una tabla con relación 1:N con la tabla sobre la que ya hemos insertado. Si no se puede realizar la operación, podemos cancelar toda la transacción.

IMPORTANTE:: Si se quiere interrumpir la ejecución de la Insercion, el programador debe utilizar el método setError para indicar que se ha producido un error.

  • abstract:
  • access: public
integer postInsertar ( $objDatos)
  • $objDatos
postModificar (line 757)

Este método es el método abstracto que ofrece Igep para realizar operaciones una vez realiza la acción de modificar. Todo lo que se realice en este evento está

incluido en la TRANSACTION por lo que podrá cancelarse la operación. Su utilización pude ser:

  • Si se quiere modificar N tuplas en una tabla con relación 1:N con la tabla sobre la que ya hemos modificado. Si no se puede realizar la operación, podemos cancelar toda la transacción.

IMPORTANTE:: Si se quiere interrumpir la ejecución de la modificación, el programador debe utilizar el método setError para indicar que se ha producido un error.

  • abstract:
  • access: public
integer postModificar ( $m_datos)
  • $m_datos
prepareDataSource (line 284)

Método que construye la SQL que se lanzara posteriormente para obtener los datos

  • access: public
none prepareDataSource ()

Redefinition of:
gvHidraForm::prepareDataSource()
Método que se debe sobreescribir por las clases de extension para dar el comportamiento a la preparación de la obtencion de datos.
prepareDataSourceDetails (line 361)
  • access: public
void prepareDataSourceDetails ( $detail,  $masterData)
  • $detail
  • $masterData

Redefinition of:
gvHidraForm::prepareDataSourceDetails()
Método que se encarga de preparar la fuente de datos de un detalle
prepareDataSourceEdit (line 412)
  • access: public
void prepareDataSourceEdit ()

Redefinition of:
gvHidraForm::prepareDataSourceEdit()
processDelete (line 817)
  • access: public
void processDelete ()

Redefinition of:
gvHidraForm::processDelete()
processInsert (line 669)

Método encargado de realizar los INSERTs

  • access: public
void processInsert ()

Redefinition of:
gvHidraForm::processInsert()
processUpdate (line 764)

proceso de actualizacion de los datos

  • access: public
void processUpdate ()

Redefinition of:
gvHidraForm::processUpdate()
recoverData (line 340)

Método que lanza la consulta SQL y retorna los datos

  • access: public
none recoverData ()

Redefinition of:
gvHidraForm::recoverData()
Método que lanza la consulta SQL y retorna los datos
recoverDataDetail (line 394)

Método que lanza la consulta SQL y retorna los datos del detalle

  • access: public
none recoverDataDetail ()

Redefinition of:
gvHidraForm::recoverDataDetail()
Metodo que se encarga de obtener los datos del detalle
recoverDataEdit (line 457)
  • access: public
void recoverDataEdit ()

Redefinition of:
gvHidraForm::recoverDataEdit()
regenerarInstancia (line 204)
void regenerarInstancia ([ $dsn = ''])
  • $dsn

Redefinition of:
gvHidraForm::regenerarInstancia()

Redefined in descendants as:
setFilterForEdit (line 642)

Permite cambiar el filtro actual que se está utilizando sobre la EditQuery.

Fija el WHERE que se utilizará para refrescar los datos del panel EditQuery

  • access: public
none setFilterForEdit (newFilter $newFilter)
  • newFilter $newFilter: string
setFilterForSearch (line 615)

Permite cambiar el filtro actual que se está utilizando sobre la SearchQuery.

Fija el WHERE que se utilizará para refrescar los datos del panel SearhQuery

  • access: public
none setFilterForSearch (newFilter $newFilter)
  • newFilter $newFilter: string
setLimiteConsulta (line 1047)

Función que debe utilizar el programador para indicar el límite de registros que se pueden recuperar de la base de datos con una consulta.

Por defecto IGEP tiene un límite de 100.

  • access: public
none setLimiteConsulta (integer $int_limite)
  • integer $int_limite: número que indica el límite.
setOrderByForEditQuery (line 525)

Permite especificar la clausula 'ORDER BY' de la query consulta del CRUD de gvHidra que se lanza en la acción editar (paso de tabular a registro en patrón T-R)

  • access: public
void setOrderByForEditQuery (String $query)
  • String $query: Cláusula 'ORDER BY' de sentencia SQL
setOrderByForSearchQuery (line 495)

Permite especificar la clausula 'ORDER BY' de la query consulta del CRUD de gvHidra que se lanza en la acción buscar.

  • access: public
void setOrderByForSearchQuery (String $query)
  • String $query: Cláusula 'ORDER BY' de sentencia SQL
setParametrosBusqueda (line 263)

Este método almacenará una cadena que luego se anexará a la WHERE de la consulta a ejecutar. En esa cadena se pueden incluir condiciones especiales como añadir un EXISTS si cierto campo del panel de busqueda está a true.

  • abstract:
integer setParametrosBusqueda (string $str_where)
  • string $str_where: str_where contiene la cadena que se quiere concatenar a la WHERE de la consulta
setPKForQueries (line 537)

Permite especificar la PK de las dos queries que se pueden definir en el FW. El primer parametro permite definir la PK para el el searchMode. El segundo corresponde con el editMode.

  • access: public
void setPKForQueries (array $fieldsForSearchQuery, [array $fieldsForEditQuery = array()])
  • array $fieldsForSearchQuery: Campos que componen la clave primaria en la query del searchMode
  • array $fieldsForEditQuery: Opcional. Campos que componen la clave primaria en la query del editMode
setSearchParameters (line 274)

Este método almacenará una cadena que luego se anexará a la WHERE de la consulta a ejecutar. En esa cadena se pueden incluir condiciones especiales como añadir un EXISTS si cierto campo del panel de busqueda está a true.

  • abstract:
  • access: public
integer setSearchParameters (string $str_where)
  • string $str_where: str_where contiene la cadena que se quiere concatenar a la WHERE de la consulta
setSelectForEditQuery (line 505)

Permite especificar la cabecera de la query consulta del CRUD de gvHidra que se lanza en la acción editar (paso de tabular a registro en patrón T-R)

  • access: public
void setSelectForEditQuery (String $query)
  • String $query: Cabecera de sentencia SQL
setSelectForSearchQuery (line 475)

Permite especificar la cabecera de la query consulta del CRUD de gvHidra que se lanza en la acción buscar.

  • access: public
void setSelectForSearchQuery (String $query)
  • String $query: Cabecera de sentencia SQL
setTipoConsulta (line 1060)

Método que sirve para fijar el tipo de consulta del panel. Siempre se descartan mayúsculas y marcas diacríticas.

Las posibilidades son: (0) Se contruye la Where igualando los campos a los valores. (1) Se construye con like y comodines para cada campo. (2) Por defecto, se contruye con like sólo si el usuario ha especificado comodines.

  • access: public
none setTipoConsulta (integer $valorTipoConsulta)
  • integer $valorTipoConsulta: Entero entre 0 y 2 que indica el tipo deseado.
setWhereForEditQuery (line 515)

Permite especificar la clausula 'WHERE' de la query consulta del CRUD de gvHidra que se lanza en la acción editar (paso de tabular a registro en patrón T-R)

  • access: public
void setWhereForEditQuery (String $query)
  • String $query: Cláusula 'WHERE' de sentencia SQL
setWhereForSearchQuery (line 485)

Permite especificar la clausula 'WHERE' de la query consulta del CRUD de gvHidra que se lanza en la acción buscar.

  • access: public
void setWhereForSearchQuery (String $query)
  • String $query: Cláusula 'WHERE' de sentencia SQL
showOnlyNewRecordsAfterInsert (line 583)

Indica si el filtro se debe regenerar tras una insercion. Tras insertar una tupla, para evitar que dicha tupla no aparezca en el filtro previo, se elimina dicho filtro y se crea uno nuevo que apunta a la nueva tupla insertada (a través de su PK o todos sus campos).

Puede haber casos en los que nos interese que este comportamiento no se produzca. Con este método podemos cambiar el comportamiento por defecto. Los valores que admite son:

-Con valor true, despues de insertar solo se vera la nueva tupla insertada. Valor por defecto -Con valor false no modifica el filtro, por lo que se recarga el panel con el filtro previo.

  • access: public
none showOnlyNewRecordsAfterInsert (boolean $value)
  • boolean $value: value

Inherited Methods

Inherited From gvHidraForm

gvHidraForm::gvHidraForm()
gvHidraForm::accionesParticulares()
gvHidraForm::addAccionInterfaz()
gvHidraForm::addCheckBox()
gvHidraForm::addDefaultData()
gvHidraForm::addFieldType()
gvHidraForm::addHijo()
gvHidraForm::addList()
gvHidraForm::addPadre()
gvHidraForm::addSelectionWindow()
gvHidraForm::buildQuery()
gvHidraForm::buildQueryDetails()
gvHidraForm::buildQueryEdit()
gvHidraForm::deleteSelected()
gvHidraForm::generarListas()
gvHidraForm::getDefaultData()
gvHidraForm::getResultadoBusqueda()
gvHidraForm::getResultadoEdicion()
gvHidraForm::initWindow()
gvHidraForm::insertData()
gvHidraForm::keepFilterValuesAfterSearch()
gvHidraForm::limpiarInstancia()
gvHidraForm::nuevo()
gvHidraForm::openWindow()
gvHidraForm::perform()
gvHidraForm::postBuscar()
gvHidraForm::postEditar()
gvHidraForm::postFocusChanged()
gvHidraForm::postRecargar()
gvHidraForm::preBorrar()
gvHidraForm::preBuscar()
gvHidraForm::preEditar()
gvHidraForm::preFocusChanged()
gvHidraForm::preIniciarVentana()
gvHidraForm::preInsertar()
gvHidraForm::preModificar()
gvHidraForm::preNuevo()
gvHidraForm::prepareDataSource()
gvHidraForm::prepareDataSourceDetails()
gvHidraForm::prepareDataSourceEdit()
gvHidraForm::preRecargar()
gvHidraForm::processDelete()
gvHidraForm::processInsert()
gvHidraForm::processUpdate()
gvHidraForm::recoverData()
gvHidraForm::recoverDataDetail()
gvHidraForm::recoverDataEdit()
gvHidraForm::refreshDetail()
gvHidraForm::refreshEdit()
gvHidraForm::refreshMaster()
gvHidraForm::refreshSearch()
gvHidraForm::regenerarInstancia()
gvHidraForm::regresoAVentana()
gvHidraForm::saltoDeVentana()
gvHidraForm::setResultadoBusqueda()
gvHidraForm::setResultadoEdicion()
gvHidraForm::showMensaje()
gvHidraForm::showMessage()
gvHidraForm::updateSelected()
gvHidraForm::_accionesInterfaz()
gvHidraForm::_focusChanged()
gvHidraForm::_getFilasSeleccionadas()
gvHidraForm::_recalcularListasDependientes()

Inherited From Action

Action::perform()

Inherited From Object

Object::equals()
Object::toString()

Documentation generated on Wed, 05 Oct 2011 10:36:28 +0200 by phpDocumentor 1.4.1