Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

phpdoc modelo

Gabriel edited this page Feb 16, 2021 · 55 revisions

\modelo

Clase base de los repositorios del modelo de datos.

Propiedades

tipoEntidad (protegido)

Tipo: string
Tipo de las entidades (asignar entidad::class).

nombre (protegido)

Tipo: string
Nombre de la tabla.

aplicacion (protegido)

Tipo: \aplicacion
Instancia de la clase privada de la aplicación.

ultimoId (protegido)

Tipo: int
Último ID insertado.

Métodos

__construct([$bd])

Constructor.

Parámetro Tipo Descripción Opcional Predeterminado
$bd \bd Instancia de la interfaz de base de datos (por defecto, utilizará la conexión abierta, no iniciará una nueva conexión). Si null

fabricarEntidad([$fila])

Crea y devuelve una instancia de la entidad de este modelo.

Parámetro Tipo Descripción Opcional Predeterminado
$fila mixed Datos a asignar (resultado de la consulta, no un objeto arbitrario u otra instancia de la entidad). Si null

Devuelve: \entidad

obtenerNombreTabla()

Devuelve: string
Devuelve el nombre de la tabla.

obtenerAlias()

Devuelve: string
Devuelve el alias.

obtenerNombre()

Devuelve: string
Devuelve el nombre del modelo.

singular()

Devuelve: string
Devuelve el nombre de las entidades.

fabricarModelo($modelo[,$bd,$replicarConfiguracion])

Crea y devuelve una instancia del modelo especificado.

Parámetro Tipo Descripción Opcional Predeterminado
$modelo string Nombre del modelo.
$bd \bd Instancia de la interfaz de base de datos (por defecto, utilizará la conexión abierta, no iniciará una nueva conexión). Si null
$replicarConfiguracion bool Crea el modelo con la misma configuración que esta instancia con respecto al procesamiento de relaciones, campos ocultos, etc. Si true

Devuelve: \modelo

cargarEstructura() (protegido)

Carga la configuración desde los metadatos de la clase de la entidad.

obtenerCampos()

Devuelve: object
Devuelve los campos de las entidades de este modelo.

reiniciar([$preservarConfiguracion])

Reinicia el repositorio.

Parámetro Tipo Descripción Opcional Predeterminado
$preservarConfiguracion bool Mantener la configuración relacionada al procesamiento de relaciones, campos ocultos, bloqueos, y registros eliminados. Si true

Devuelve: \modelo

obtenerUltimaConsulta()

Devuelve: object
Devuelve la información de la última consulta realizada.

mostrarSql() (protegido)

Devuelve: string
Devuelve la última consulta SQL ejecutada en formato para exportar.

obtenerId()

Devuelve: int|null
Devuelve el ID de la entidad. Tras la inserción de una fila, será el último ID insertado.

id()

Devuelve: int|null
Alias de obtenerId().

seleccionar($campos)

Establece los campos a seleccionar.

Parámetro Tipo Descripción Opcional Predeterminado
...$campos string Nombres de los campos.

Devuelve: \modelo

establecerAlias($alias)

Establece el alias para la próxima consulta.

Parámetro Tipo Descripción Opcional Predeterminado
$alias string Alias.

Devuelve: \modelo

relacionar($campo,$tipo,$modelo,$alias,$condicion[,$parametros,$relacionarSiempre])

Establece una relación con otro modelo, dado su nombre, clase o instancia. Pueden insertarse parámetros adicionales en la condición con el formato @nombre.

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo a relacionar. Si no es necesario que la entidad se asigne a un campo, especificar null.
$tipo string Tipo de relación (1:0, 1:1, 1:N)
$modelo string Nombre del modelo a relacionar.
$alias string Alias a asignar al modelo relacionado.
$condicion string Condición, como SQL.
$parametros array Listado de parámetros [nombre=>valor] utilizados en la condición. Si null
$relacionarSiempre bool Siempre realizar la relación, aunque se haya solicitado omitirlas. Este parámetro en general debe ser true para relaciones agregadas manualmente, desde el código fuente, y será siempre false para las relaciones automáticas (estas últimas siempre respetarán las instrucciones de omitir o procesar relaciones). Si true

Devuelve: \modelo

relacionarUnoAUno($campo,$modelo,$alias,$condicion[,$parametros,$relacionarSiempre])

Establece una relación 1:1 con otro modelo, dado su nombre, clase o instancia. Pueden insertarse parámetros adicionales en la condición con el formato @nombre.

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo a relacionar. Si no es necesario que la entidad se asigne a un campo, especificar null.
$modelo string Nombre del modelo a relacionar.
$alias string Alias a asignar al modelo relacionado.
$condicion string Condición, como SQL.
$parametros array Listado de parámetros [nombre=>valor] utilizados en la condición. Si null
$relacionarSiempre bool Siempre realizar la relación, aunque se haya solicitado omitirlas. Este parámetro en general debe ser true para relaciones agregadas manualmente, desde el código fuente, y será siempre false para las relaciones automáticas (estas últimas siempre respetarán las instrucciones de omitir o procesar relaciones). Si true

Devuelve: \modelo

relacionarUnoAUnoNulo($campo,$modelo,$alias,$condicion[,$parametros,$relacionarSiempre])

Establece una relación 1:0 con otro modelo, dado su nombre, clase o instancia. Pueden insertarse parámetros adicionales en la condición con el formato @nombre.

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo a relacionar. Si no es necesario que la entidad se asigne a un campo, especificar null.
$modelo string Nombre del modelo a relacionar.
$alias string Alias a asignar al modelo relacionado.
$condicion string Condición, como SQL.
$parametros array Listado de parámetros [nombre=>valor] utilizados en la condición. Si null
$relacionarSiempre bool Siempre realizar la relación, aunque se haya solicitado omitirlas. Este parámetro en general debe ser true para relaciones agregadas manualmente, desde el código fuente, y será siempre false para las relaciones automáticas (estas últimas siempre respetarán las instrucciones de omitir o procesar relaciones). Si true

Devuelve: \modelo

relacionarUnoAMuchos($campo,$modelo,$alias,$condicion[,$parametros,$relacionarSiempre])

Establece una relación 1:N con otro modelo, dado su nombre, clase o instancia. Pueden insertarse parámetros adicionales en la condición con el formato @nombre.

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo a relacionar. Si no es necesario que la entidad se asigne a un campo, especificar null.
$modelo string Nombre del modelo a relacionar.
$alias string Alias a asignar al modelo relacionado.
$condicion string Condición, como SQL.
$parametros array Listado de parámetros [nombre=>valor] utilizados en la condición. Si null
$relacionarSiempre bool Siempre realizar la relación, aunque se haya solicitado omitirlas. Este parámetro en general debe ser true para relaciones agregadas manualmente, desde el código fuente, y será siempre false para las relaciones automáticas (estas últimas siempre respetarán las instrucciones de omitir o procesar relaciones). Si true

Devuelve: \modelo

omitirRelaciones($campos)

Omite los campos relacionales.

Parámetro Tipo Descripción Opcional Predeterminado
...$campos string Si se especifica al menos un argumento, omitirá únicamente el procesamiento de estos campos. En caso contrario, se omitirán todos los campos relacionales.

Devuelve: \modelo

omitirRelacionesUnoAMuchos()

Devuelve: \modelo
Omite solo las relaciones 1:N.

incluirRelaciones($campos)

Fuerza el procesamiento de campos relacionales aún cuando estén desactivados o excluídos mediante @omitir. Este método puede utilizarse para incluir campos específicos cuando todos los demás se hayan desactivado mediante omitirReleaciones() o omitirRelacionesUnoAMuchos(), o en casos en los que explícitamente se requiera procesar relaciones que normalmente se deben omitir.

Parámetro Tipo Descripción Opcional Predeterminado
...$campos string Si se especifica al menos un argumento, forzará únicamente el procesamiento de estos campos. En caso contrario, se forzará el procesamiento de todos los campos relacionales.

Devuelve: \modelo

preservarRelacionados()

Devuelve: \modelo
Al actualizar una fila, preservará las filas relacionadas en campos 1:N que no se incluyan en el listado. Esto significa que, con cada consulta, solo se actualizarán y se agregarán las nuevas relaciones, pero nunca se eliminarán. Por defecto, esto está desactivado.

limpiarRelacionados()

Devuelve: \modelo
Al actualizar una fila, se eliminarán las filas relacionadas en campos 1:N que no existan en el listado. Esto significa que, con cada consulta, solo se preservarán las relaciones que estén explícitamente asignadas a la entidad. Este es el comportamiento por defecto.

incluirOcultos()

Devuelve: \modelo
Incluye los valores de campos ocultos en la próxima consulta.

excluirOcultos()

Devuelve: \modelo
Excluye los valores de campos ocultos en la próxima consulta.

seleccionarEliminados()

Devuelve: \modelo
Permite que se seleccionen registros eliminados en la próxima consulta.

procesarRelaciones([$item,$procesarOmitidos,$procesar1n,&$cadenaRelaciones])

Procesa los campos relacionados sobre la instancia especificada luego de haber realizado una consulta con las relaciones desactivadas, o cuando la entidad tenga campos con @omitir.

Parámetro Tipo Descripción Opcional Predeterminado
$item \entidad Item (entidad) a procesar. Si se omite, se procesará la entidad actualmente asignada a la instancia. Si null
$procesarOmitidos bool Fuerza el procesamiento de los campos con @omitir. Si true
$procesar1n bool Procesar las relaciones 1:n. Si true
&$cadenaRelaciones string[] Relaciones procesadas previamente p Si null

Devuelve: \modelo

abrirGrupo()

Devuelve: \modelo
Inicia un grupo de condiciones (agrupará todas las condiciones que se agreguen a continuación hasta que sea invocado cerrarGrupo()).

cerrarGrupo()

Devuelve: \modelo
Cierra un grupo de condiciones abierto previamente con abrirGrupo().

donde($condicion[,$parametros])

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion string Condición como cadena SQL. Pueden insertarse parámetros con el formato @nombre.
$parametros object Array parámetro/valor. Si null

Devuelve: \modelo

Sobrecarga 2: donde($condicion)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Array campo=>valor a utilizar como filtro.

Devuelve: \modelo

Sobrecarga 3: donde($condicion)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Instancia de la entidad cuyos campos se utilizarán como filtro.

Devuelve: \modelo

dondeComparar($condicion,$operador[,$valor])

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Nombre del campo a filtrar.
$operador string Operador, como cadena (<,<=,<>,>,>=,like).
$valor mixed Valor a evaluar. Si null

Devuelve: \modelo

Sobrecarga 2: dondeComparar($condicion,$operador)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Array campo=>valor a utilizar como filtro.
$operador string Operador, como cadena (<,<=,<>,>,>=,like).

Devuelve: \modelo

Sobrecarga 3: dondeComparar($condicion,$operador)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Instancia de la entidad cuyos campos se utilizarán como filtro.
$operador string Operador, como cadena (<,<=,<>,>,>=,like).

Devuelve: \modelo

oDonde($condicion[,$parametros])

Agrega una condición OR.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion string Condición como cadena SQL. Pueden insertarse parámetros con el formato @nombre.
$parametros object Array parámetro/valor. Si null

Devuelve: \modelo

Sobrecarga 2: oDonde($condicion)

Agrega una condición OR.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Array campo=>valor a utilizar como filtro.

Devuelve: \modelo

Sobrecarga 3: oDonde($condicion)

Agrega una condición OR.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Instancia de la entidad cuyos campos se utilizarán como filtro.

Devuelve: \modelo

oDondeComparar($condicion,$operador[,$valor])

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Nombre del campo a filtrar.
$operador string Operador, como cadena (<,<=,<>,>,>=,like).
$valor mixed Valor a evaluar. Si null

Devuelve: \modelo

Sobrecarga 2: oDondeComparar($condicion,$operador)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Array campo=>valor a utilizar como filtro.
$operador string Operador, como cadena (<,<=,<>,>,>=,like).

Devuelve: \modelo

Sobrecarga 3: oDondeComparar($condicion,$operador)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Instancia de la entidad cuyos campos se utilizarán como filtro.
$operador string Operador, como cadena (<,<=,<>,>,>=,like).

Devuelve: \modelo

dondeNo($condicion)

Agrega una condición negativa (los valores deben ser distintos al filtro).

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Array u objeto campo=>valor a utilizar como filtro.

Devuelve: \modelo

Sobrecarga 2: dondeNo($condicion)

Agrega una condición negativa (los valores deben ser distintos a los de la entidad).

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Instancia de la entidad cuyos campos se utilizarán como filtro.

Devuelve: \modelo

oDondeNo($condicion)

Agrega una condición negativa (los valores deben ser distintos al filtro) OR.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Array u objeto campo=>valor a utilizar como filtro.

Devuelve: \modelo

Sobrecarga 2: oDondeNo($condicion)

Agrega una condición negativa (los valores deben ser distintos a los de la entidad) OR.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Instancia de la entidad cuyos campos se utilizarán como filtro.

Devuelve: \modelo

dondeEn($campo,$valores)

Agrega una condición IN().

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valores array Listado de valores posibles.

Devuelve: \modelo

dondeNoEn($campo,$valores)

Agrega una condición NOT IN() (negado).

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valores array Listado de valores a excluir.

Devuelve: \modelo

oDondeEn($campo,$valores)

Agrega una condición OR IN().

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valores array Listado de valores posibles.

Devuelve: \modelo

oDondeNoEn($campo,$valores)

Agrega una condición OR NOT IN() (negado).

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valores array Listado de valores a excluir.

Devuelve: \modelo

dondeComo($campo,$valor)

Agrega una condición LIKE.

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valor array Valor a evaluar.

Devuelve: \modelo

dondeNoComo($campo,$valor)

Agrega una condición NOT LIKE (negado).

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valor array Valor a evaluar.

Devuelve: \modelo

oDondeComo($campo,$valor)

Agrega una condición OR LIKE.

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valor array Valor a evaluar.

Devuelve: \modelo

oDondeNoComo($campo,$valor)

Agrega una condición OR NOT LIKE (negado).

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valor array Valor a evaluar.

Devuelve: \modelo

agrupadoPor($campos)

Establece el o los campos por los cuales se agruparán los resultados.

Parámetro Tipo Descripción Opcional Predeterminado
...$campos string Nombres de los campos. Si el nombre no incluye un alias, se asume de la tabla de esta instancia.

Devuelve: \modelo

teniendo($condicion[,$parametros])

Establece la condición HAVING.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion string Condición como cadena SQL. Pueden insertarse parámetros con el formato @nombre.
$parametros object Array parámetro/valor. Si null

Devuelve: \modelo

Sobrecarga 2: teniendo($condicion)

Establece la condición HAVING.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Array campo=>valor a utilizar como filtro.

Devuelve: \modelo

Sobrecarga 3: teniendo($condicion)

Establece la condición HAVING.

Parámetro Tipo Descripción Opcional Predeterminado
$condicion object Instancia de la entidad cuyos campos se utilizarán como filtro.

Devuelve: \modelo

generarCondicion($condicion,$parametros[,$union,$operador]) (protegido)

Genera un objeto representando intermanente una condición a partir de cualquera de los tres formatos que admiten donde() y teniendo().

Parámetro Tipo Descripción Opcional Predeterminado
$condicion
$parametros
$union Si 'and'
$operador Si '='

Devuelve: \modelo

limite($limite,$cantidad)

Establece el límite.

Parámetro Tipo Descripción Opcional Predeterminado
$limite int Límite inicial.
$cantidad int Cantidad de registros a seleccionar/afectar.

Devuelve: \modelo

paginacion($cantidad[,$pagina])

Establece la paginación.

Parámetro Tipo Descripción Opcional Predeterminado
$cantidad int Cantidad de registros a seleccionar.
$pagina int Número de página (base 1). Si 1

Devuelve: \modelo

ordenadoPor($campo[,$orden])

Establece el ordenamiento. Puede invocarse múltiples veces para establecer múltiples columnas de ordenamiento.

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo o expresión.
$orden string Orden ascendente o descendente. Omitir si se establece una expresión en $campo. Si null

Devuelve: \modelo

establecerValores($objeto[,$reestablecer])

Establece los valores a guardar. En una segunda llamada a este método con un objeto o array, se asignarán los valores a la entidad establecida previamente. Especificar una entidad siempre reemplazará la entidad previamente asignada (en caso contrario, solo se actualizarán las propiedades incluidas en el objeto o array).

Parámetro Tipo Descripción Opcional Predeterminado
$objeto object|array|\entidad Entidad u objeto o array [propiedad=>valor].
$reestablecer bool Si es true, reemplazará los valores asignado previamente. En caso contrario, solo los reemplazará si se asigna una instancia de \entidad; asignando un objeto o array asociativo solo actualizará las propiedades presentes en el mismo. Si false

Devuelve: \modelo

establecerValor($propiedad,$valor)

Establece un valor a guardar.

Parámetro Tipo Descripción Opcional Predeterminado
$propiedad string Nombre de la propiedad.
$valor mixed Valor a asignar.

Devuelve: \modelo

establecerValoresPublicos($valores)

Crea una nueva entidad, asignando los valores provistos mediante entidad::establecerValoresPublicos(), y la asigna a los valores para la próxima consulta. Nótese que tras invocar este método, las próximas entidades generadas, por ejemplo al procesar campos relacionales, también utilizarán establecerValoresPublicos() hasta que el modelo sea reiniciado.

Parámetro Tipo Descripción Opcional Predeterminado
$valores object|array Valores a asignar.

Devuelve: \modelo

obtenerEntidad()

Devuelve: mixed
Devuelve la entidad con la que se está trabajando.

establecerEntidad($entidad)

Establece la entidad. Equivalente a establecerValores($entidad).

Parámetro Tipo Descripción Opcional Predeterminado
$entidad \entidad Entidad.

Devuelve: mixed

prepararConsulta([$operacion])

Prepara la consulta.

Parámetro Tipo Descripción Opcional Predeterminado
$operacion Si 'seleccionar'

Devuelve: \modelo

reutilizarConsulta()

Devuelve: \modelo
Reutiliza la consulta preparada en la próxima consulta, reemplazando los parámetros, en lugar de crear una nueva.

ejecutarBloqueo()

Devuelve: \modelo
Ejecuta el bloqueo de tablas, si corresponde.

ejecutarConsulta([$operacion])

Ejecuta la consulta, sin devolver ningún elemento.

Parámetro Tipo Descripción Opcional Predeterminado
$operacion Si 'seleccionar'

Devuelve: \modelo

ejecutarConsultasRelacionadas()

Devuelve: \modelo
Ejecuta las consultas de inserción o actualización en los campos relacionales.

ejecutarConsultasRelacionadasUnoAMuchos()

Devuelve: \modelo
Ejecuta las consultas de inserción o actualización en los campos relacionales 1:N.

obtenerUno()

Devuelve: \modelo
Ejecuta la consulta devolviendo un único elemento.

obtenerUnResultado()

Devuelve: object
Ejecuta la consulta devolviendo un único objeto. A diferencia con obtenerUno(), el objeto devuelto no es una entidad, sino que es el primer resultado tal cual proviene de la base de datos.

obtenerItem($id)

Devuelve un registro dado su ID.

Parámetro Tipo Descripción Opcional Predeterminado
$id object ID.

Devuelve: \entidad

obtenerListadoResultados()

Devuelve: array
Ejecuta la consulta y devuelve un array de objetos. A diferencia con obtenerListado() y obtenerListadoAsociativo(), los objetos devueltos no son entidades, sino que son los resultados tal cual provienen de la base de datos.

obtenerListado([$objetoEstandar,$campos])

Ejecuta la consulta y devuelve un array de elementos.

Parámetro Tipo Descripción Opcional Predeterminado
$objetoEstandar boolean Si es true, devolverá un listado de objetos anónimos (stdClass) en lugar de instancias de la entidad. Nótese que solo se incluirán los campos que se correspondan con campos de la entidad. Si false
...$campos string Campos a asignar a la entidad. Si se omite, se asignarán todos los campos disponibles en la consulta. Esto es útil cuando se desee obtener un listado con menos campos que los que se han seleccionado con seleccionar().

Devuelve: array

obtenerListadoAsociativo([$clave,$valor])

Ejecuta la consulta y devuelve un array asociativo [clave=>valor].

Parámetro Tipo Descripción Opcional Predeterminado
$clave string Campo a utilizar como clave del array. Si 'id'
$valor string Campo a utilizar como valor del array. Si se omite, se asignará la entidad completa. Si null

Devuelve: array

Sobrecarga 2: obtenerListadoAsociativo([$clave,$valor])

Ejecuta la consulta y devuelve un array asociativo [clave=>valor].

Parámetro Tipo Descripción Opcional Predeterminado
$clave string Campo a utilizar como clave del array. Si 'id'
$valor callable Función que devuelve el valor dada la entidad. Si se omite, se asignará la entidad completa. Si null

Devuelve: array

obtenerCantidad()

Devuelve: \modelo
Devuelve la cantidad de elementos encontrados o afectados por la última consulta.

estimarCantidad()

Devuelve: int
Calcula la cantidad de elementos totales que arrojaría la consulta (puede ser aproximado) sin considerar el límite.

clonar($clonarRelaciones)

Crea una copia de la entidad asignada.

Parámetro Tipo Descripción Opcional Predeterminado
...$clonarRelaciones string Nombres de los campos relacionales cuyas entidades relacionales también se deben clonar. Nótese que esto afectará solo un nivel (no recursivo).

Devuelve: \modelo

eliminar([$e])

Elimina los elementos que coincidan con la consulta.

Parámetro Tipo Descripción Opcional Predeterminado
$e Si 1

Devuelve: \modelo

restaurar()

Devuelve: \modelo
Restaura los elementos que coincidan con la consulta.

guardar()

Devuelve: \modelo
Guarda el elemento establecido con establecerValores(). El mismo será insertado si no cuenta con campo id, o actualizado en caso contrario.

insertar()

Devuelve: \modelo
Inserta el elemento establecido con establecerValores().

crear()

Devuelve: \modelo
Alias de insertar().

actualizar()

Devuelve: \modelo
Actualiza los elementos que coincidan con la consulta utilizando los campos del el elemento establecido con establecerValores(). Si no se ha establecido una condición, utilizará la propiedad id.

comenzarTransaccion([$modo])

Comienza una transacción. La transacción puede comenzarse, finalizarse o descartarse desde cualquier modelo en uso (aún cuando se esté trabajando con múltiples modelos a la vez, debe solicitarse solo a uno de ellos).

Parámetro Tipo Descripción Opcional Predeterminado
$modo Si self::lecturaEscritura

Devuelve: \modelo

finalizarTransaccion()

Devuelve: \modelo
Finaliza la transacción.

descartarTransaccion()

Devuelve: \modelo
Revierte y descarta la transacción.

bloquear($modo)

Bloqueará todas las tablas involucradas en la próxima consulta. Las tablas se mantendrán bloqueadas hasta que se invoque desbloquear(). Nota: Si se desea ejecutar un bloqueo inmediatamente, debe realizarse con \bd::bloquear().

Parámetro Tipo Descripción Opcional Predeterminado
$modo string Modo (lectura o escritura).

Devuelve: \modelo

noBloquear()

Devuelve: \modelo
Desactivará el bloqueo de tablas en la próxima consulta.

desbloquear()

Devuelve: \modelo
Desbloquea las tablas.

obtenerError()

Devuelve: string
Devuelve el último mensaje de error.

prepararRelaciones(&$alias,$recursivo,&$cadenaRelaciones)

Genera las relaciones automáticas a partir de los campos relacionales.

Parámetro Tipo Descripción Opcional Predeterminado
&$alias
$recursivo
&$cadenaRelaciones

Devuelve: \modelo

construirCamposYRelaciones(&$campos,&$relaciones)

Genera el listado de porciones SQL para selección de campos y tablas relacionadas.

Parámetro Tipo Descripción Opcional Predeterminado
&$campos
&$relaciones

Devuelve: \modelo

actualizarParametros() (protegido)

Devuelve: \modelo
Regenera los parámetros para la próxima consulta.

construirConsulta([$operacion]) (protegido)

Construye la consulta SQL.

Parámetro Tipo Descripción Opcional Predeterminado
$operacion Si 'seleccionar'

Devuelve: \modelo

construirConsultaInsercion() (protegido)

Devuelve: \modelo
Construye la consulta SQL para insertar una fila.

asignarCamposRelacionales() (protegido)

Asigna los valores de las propiedades relacionales a partir de las relaciones 1:1 o 1:0 en consultaValores.

construirCamposInsercionActualizacion($operacion,&$parametros,&$tipos[,$alias]) (protegido)

Construye la porción SQL que contiene los campos a insertar o actualizar.

Parámetro Tipo Descripción Opcional Predeterminado
$operacion
&$parametros
&$tipos
$alias Si true

Devuelve: string

determinarTipo($valor) (protegido)

Determina (o estima) y establece el tipo de un valor dado, devolviendo i, d, s o b.

Parámetro Tipo Descripción Opcional Predeterminado
$valor mixed Valor a analizar.

Devuelve: string

instalar()

Devuelve: string
Instalación de la base de datos. Devuelve el SQL de las consultas ejecutadas.

prepararCadenaBusquedaFonetica($cadena)

Procesa una cadena para realizar una búsqueda fonética o almacenar en el caché de búsqueda fonética.

Parámetro Tipo Descripción Opcional Predeterminado
$cadena string Cadena.

Devuelve: array

generarConsultaBusquedaFonetica($campo,$cadena)

Devuelve la porción de código SQL para realizar una búsqueda fonética. Devuelve un objeto [sql,parametros].

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Nombre del campo de búsqueda, listo para usar (incluyendo alias, apóstrofes, etc.).
$cadena string Cadena a buscar.

Devuelve: object

Clone this wiki locally