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 Jun 28, 2021 · 55 revisions

\modelo

Clase base de los repositorios del modelo de datos.

Extiende: \modeloBase

Métodos

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

Agrega una relación.

Parámetro Tipo Descripción Opcional Predeterminado
$tipo int Tipo de relación: modelo::relacion1N (1:N), modelo::relacion11 (1:1), modelo::relacion10 (1:0, es decir 1:1 o nulo).
$modelo string Nombre del modelo foráneo.
$alias string Alias del modelo foráneo.
$condicion string Condición como SQL.
$parametros array|object Parámetros para la condición (opcional). Si null
$destino string Nombre de la propiedad en la que se asignará la entidad foránea (por defecto, será igual al nombrer del modelo). Si null

Devuelve: \modelo

Sobrecarga 2: relacionar($tipo,$modelo,$alias,$condicion[,$parametros])

Agrega una relación.

Parámetro Tipo Descripción Opcional Predeterminado
$tipo int Tipo de relación: modelo::relacion1N (1:N), modelo::relacion11 (1:1), modelo::relacion10 (1:0, es decir 1:1 o nulo).
$modelo string Nombre del modelo foráneo.
$alias string Alias del modelo foráneo.
$condicion string Condición como SQL.
$parametros string Nombre de la propiedad en la que se asignará la entidad foránea (por defecto, será igual al nombrer del modelo). Si null

Devuelve: \modelo

guardar([$id])

Guarda los valores actualmente asignados. Actualizará o creará el registro según esté asignada o no el campo id o el parámetro $id.

Parámetro Tipo Descripción Opcional Predeterminado
$id int ID a actualizar. Si null

Devuelve: \modeloBase

oDonde()

Agrega una condición O (OR). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDonde()

Agrega una condición XOR (O exclusivo). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDonde()

Agrega una condición Y (AND). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeNo()

Agrega una condición negada. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeNo()

Agrega una condición O (OR) por desigualdad (<>). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeNo()

Agrega una condición XOR (O exclusivo) por desigualdad (<>). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeNo()

Agrega una condición Y (AND) por desigualdad (<>). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeComo()

Agrega una condición por búsqueda parcial (LIKE). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeComo()

Agrega una condición O (OR) por búsqueda parcial (LIKE). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeComo()

Agrega una condición OX (O exclusivo) por búsqueda parcial (LIKE). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeComo()

Agrega una condición Y (AND) por búsqueda parcial (LIKE). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeNoComo()

Agrega una condición por búsqueda parcial no coincidente (NOT LIKE). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeNoComo()

Agrega una condición O (OR) por búsqueda parcial no coincidente (NOT LIKE). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeNoComo()

Agrega una condición XOR (O exclusivo) por búsqueda parcial no coincidente (NOT LIKE). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeNoComo()

Agrega una condición Y (AND) por búsqueda parcial no coincidente (NOT LIKE). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeEn()

Agrega una condición por listado de valores (IN()). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeEn()

Agrega una condición O (OR) por listado de valores (IN()). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeEn()

Agrega una condición XOR (O exclusivo) por listado de valores (IN()). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeEn()

Agrega una condición Y (AND) por listado de valores (IN()). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeNoEn()

Agrega una condición por listado de valores no coincidentes (NOT IN()). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeNoEn()

Agrega una condición O (OR) por listado de valores no coincidentes (NOT IN()). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeNoEn()

Agrega una condición XOR (O exclusivo) por listado de valores no coincidentes (NOT IN()). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeNoEn()

Agrega una condición Y (AND) por listado de valores no coincidentes (NOT IN()). Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeMayor()

Agrega una condición donde el valor del campo es mayor (>) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeMayor()

Agrega una condición O (OR) donde el valor del campo es mayor (>) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeMayor()

Agrega una condición XOR (O exclusivo) donde el valor del campo es mayor (>) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeMayor()

Agrega una condición Y (AND) donde el valor del campo es mayor (>) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeMayorIgual()

Agrega una condición donde el valor del campo es mayor o igual (>=) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeMayorIgual()

Agrega una condición O (OR) donde el valor del campo es mayor o igual (>=) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeMayorIgual()

Agrega una condición XOR (O exclusivo) donde el valor del campo es mayor o igual (>=) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeMayorIgual()

Agrega una condición Y (AND) donde el valor del campo es mayor o igual (>=) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeMenor()

Agrega una condición donde el valor del campo es menor (<) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeMenor()

Agrega una condición O (OR) donde el valor del campo es menor (<) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeMenor()

Agrega una condición XOR (O exclusivo) donde el valor del campo es menor (<) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeMenor()

Agrega una condición Y (AND) donde el valor del campo es menor (<) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

dondeMenorIgual()

Agrega una condición donde el valor del campo es menor o igual (<=) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oDondeMenorIgual()

Agrega una condición O (OR) donde el valor del campo es menor o igual (<=) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

oxDondeMenorIgual()

Agrega una condición XOR (O exclusivo) donde el valor del campo es menor o igual (<=) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

yDondeMenorIgual()

Agrega una condición Y (AND) donde el valor del campo es menor o igual (<=) que el valor dado. Ver donde() para información sobre los parámetros.
Devuelve: \modelo

donde($entidad,$operador)

Agrega una condición Y (AND).

Parámetro Tipo Descripción Opcional Predeterminado
$entidad \entidad Utilizar las propiedades definidas de la entidad como condiciones.
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 2: donde($union,$entidad,$operador)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$union int Unión (modelo::y, modelo:o, modelo::ox).
$entidad \entidad Utilizar las propiedades definidas de la entidad como condiciones.
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 3: donde($condiciones,$operador)

Agrega una condición Y (AND).

Parámetro Tipo Descripción Opcional Predeterminado
$condiciones array|object Objeto o array asociativo [campo=>valor].
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 4: donde($union,$condiciones,$operador)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$union int Unión (modelo::y, modelo:o, modelo::ox).
$condiciones array|object Objeto o array asociativo [campo=>valor].
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 5: donde($campo,$valor,$operador)

Agrega una condición Y (AND).

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valor mixed Valor.
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 6: donde($union,$campo,$valor,$operador)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$union int Unión (modelo::y, modelo:o, modelo::ox).
$campo string Campo.
$valor mixed Valor.
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 7: donde($sql,$parametros,$valor)

Agrega una condición Y (AND).

Parámetro Tipo Descripción Opcional Predeterminado
$sql string Condición como SQL.
$parametros array|object Array asociativo de parámetros (opcional).
$valor array|mixed Array asociativo de tipos de datos ([parametro=>tipo], opcional).

Devuelve: \modelo

Sobrecarga 8: donde($union,$sql,$parametros,$valor)

Agrega una condición.

Parámetro Tipo Descripción Opcional Predeterminado
$union int Unión (modelo::y, modelo:o, modelo::ox).
$sql string Condición como SQL.
$parametros array|object Array asociativo de parámetros (opcional).
$valor array|mixed Array asociativo de tipos de datos ([parametro=>tipo], opcional).

Devuelve: \modelo

teniendo($entidad,$operador)

Agrega una condición HAVING Y (AND).

Parámetro Tipo Descripción Opcional Predeterminado
$entidad \entidad Utilizar las propiedades definidas de la entidad como condiciones.
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 2: teniendo($union,$entidad,$operador)

Agrega una condición HAVING.

Parámetro Tipo Descripción Opcional Predeterminado
$union int Unión (modelo::y, modelo:o, modelo::ox).
$entidad \entidad Utilizar las propiedades definidas de la entidad como condiciones.
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 3: teniendo($condiciones,$operador)

Agrega una condición HAVING Y (AND).

Parámetro Tipo Descripción Opcional Predeterminado
$condiciones array|object Objeto o array asociativo [campo=>valor].
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 4: teniendo($union,$condiciones,$operador)

Agrega una condición HAVING.

Parámetro Tipo Descripción Opcional Predeterminado
$union int Unión (modelo::y, modelo:o, modelo::ox).
$condiciones array|object Objeto o array asociativo [campo=>valor].
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 5: teniendo($campo,$valor,$operador)

Agrega una condición HAVING Y (AND).

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Campo.
$valor mixed Valor.
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 6: teniendo($union,$campo,$valor,$operador)

Agrega una condición HAVING.

Parámetro Tipo Descripción Opcional Predeterminado
$union int Unión (modelo::y, modelo:o, modelo::ox).
$campo string Campo.
$valor mixed Valor.
$operador int Operador (=, <, <=, >, >=, <>, modelo::como, modelo::noComo) a utilizar para comparar los valores (por defecto, =).

Devuelve: \modelo

Sobrecarga 7: teniendo($sql,$parametros,$valor)

Agrega una condición HAVING Y (AND).

Parámetro Tipo Descripción Opcional Predeterminado
$sql string Condición como SQL.
$parametros array|object Array asociativo de parámetros (opcional).
$valor array|mixed Array asociativo de tipos de datos ([parametro=>tipo], opcional).

Devuelve: \modelo

Sobrecarga 8: teniendo($union,$sql,$parametros,$valor)

Agrega una condición HAVING.

Parámetro Tipo Descripción Opcional Predeterminado
$union int Unión (modelo::y, modelo:o, modelo::ox).
$sql string Condición como SQL.
$parametros array|object Array asociativo de parámetros (opcional).
$valor array|mixed Array asociativo de tipos de datos ([parametro=>tipo], opcional).

Devuelve: \modelo

dondeTeniendo() (protegido)

Agrega una condición WHERE o HAVING. El primer parámetro debe ser siempre el tipo de condición (condicion::donde o condicion::teniendo) mientras que el resto de los parámetros son idénticos a los de donde() y teniendo().
Devuelve: \modelo

pagina($cantidad,$numero)

Establece la paginación.

Parámetro Tipo Descripción Opcional Predeterminado
$cantidad int Cantidad de elementos por página.
$numero int Número de página, comenzando desde 1.

Devuelve: \modelo

entidad()

Devuelve la entidad actual.
Devuelve: \entidadBase

id()

Devuelve el ID del último registro insertado.
Devuelve: int|null

cantidad()

Devuelve la cantidad de filas seleccionadas o afectadas en la última consulta.
Devuelve: int|null

establecer($campo,$valor)

Establece el valor de un solo campo.

Parámetro Tipo Descripción Opcional Predeterminado
$campo string Nombre del campo.
$valor mixed Valor a asignar.

Devuelve: \modelo

instalar()

Inicializa la tabla luego de la primer sincronización desde el gestor de aplicaciones.

Clone this wiki locally