PresupuestoCliente
extends PresupuestoCliente
in package
Class created by Core/Internal/PluginsDeploy
Table of Contents
Constants
- MODEL_NAMESPACE : mixed = '\FacturaScripts\Dinamic\Model\\'
Properties
- $apartado : string
- Apartado de correos del cliente.
- $cifnif : string
- CIF/NIF del cliente o proveedor.
- $ciudad : string
- Ciudad del cliente.
- $codagente : string
- Código del agente comercial asociado al documento.
- $codalmacen : string
- Almacén del documento.
- $codcliente : string
- Código del cliente asociado al documento.
- $coddivisa : string
- Código de la divisa utilizada en el documento.
- $codejercicio : string
- Código del ejercicio contable asociado.
- $codigo : string
- Identificador único para humanos.
- $codigoenv : string
- Código de seguimiento del envío.
- $codpago : mixed
- Código de la forma de pago asociada.
- $codpais : string
- Código del país del cliente.
- $codpostal : string
- Código postal del cliente.
- $codserie : mixed
- Código de la serie asociada.
- $codtrans : string
- Código de la agencia de transporte del envío.
- $direccion : string
- Dirección del cliente.
- $dtopor1 : float
- Primer porcentaje de descuento global del documento.
- $dtopor2 : float
- Segundo porcentaje de descuento global del documento.
- $editable : bool
- Indica si el documento es editable.
- $fecha : string
- Fecha del documento.
- $femail : string
- Fecha en la que se envió el documento por email.
- $finoferta : mixed
- Fecha hasta la que se mantiene la validez del presupuesto.
- $hora : string
- Hora del documento.
- $idcontactoenv : int
- Identificador del contacto de envío.
- $idcontactofact : int
- Identificador del contacto de facturación.
- $idempresa : mixed
- Identificador de la empresa asociada.
- $idestado : int
- Estado del documento, del modelo EstadoDocumento.
- $idestado_ant : int|null
- Estado anterior del documento, del modelo EstadoDocumento.
- $idpresupuesto : mixed
- Identificador único del presupuesto de cliente.
- $irpf : float|int
- Retención por defecto del documento. Cada línea puede tener una retención diferente.
- $neto : float|int
- Suma del pvptotal de las líneas. Total del documento antes de impuestos.
- $netosindto : float|int
- Suma del pvptotal de las líneas. Total del documento antes de impuestos y descuentos globales.
- $nick : string
- Usuario que creó este documento. Modelo User.
- $nombrecliente : string
- Nombre del cliente.
- $numdocs : int
- Número de documentos adjuntos.
- $numero : string
- Número del documento. Único dentro de la serie.
- $numero2 : string
- Número opcional disponible para el usuario.
- $observaciones : string
- Observaciones del documento.
- $operacion : string
- Tipo de operación fiscal del documento, por ejemplo intracomunitaria.
- $provincia : string
- Provincia del cliente.
- $tasaconv : float|int
- Tasa de conversión a euros de la divisa seleccionada.
- $total : float|int
- Suma total del documento, con impuestos.
- $totalbeneficio : float
- Suma total del beneficio de las líneas.
- $totalcoste : float
- Suma total del coste de las líneas.
- $totaleuros : float|int
- Total expresado en euros, si no fuera la divisa del documento.
- $totalirpf : float|int
- Suma total de las retenciones de IRPF de las líneas.
- $totaliva : float|int
- Suma del IVA de las líneas.
- $totalrecargo : float|int
- Suma total del recargo de equivalencia de las líneas.
- $totalsuplidos : float|int
- Suma total de las líneas de suplidos.
- $attributes : array<string|int, mixed>
- The model's attributes.
- $dataBase : DataBase
- It provides direct access to the database.
- $dont_copy_fields : mixed
- Campos que no se deben copiar al duplicar o transformar el documento.
- $fields : array<string|int, mixed>
- Lista de campos de la tabla del modelo.
- $original : array<string|int, mixed>
- The model's original attributes.
Methods
- __construct() : mixed
- Inicializa el modelo, comprueba su tabla y carga los datos proporcionados.
- __get() : mixed
- Devuelve el valor de un atributo dinámico.
- __isset() : bool
- Comprueba si existe un atributo dinámico con valor no nulo.
- __set() : void
- Asigna el valor de un atributo dinámico.
- __unset() : void
- Elimina un atributo dinámico.
- addApiFieldToHide() : void
- Añade un campo a la lista de campos que no deben exponerse en la API.
- addExtension() : void
- Añade una extensión al modelo con la prioridad indicada.
- addUnlockedField() : void
- Añade un campo a la lista de campos desbloqueados (editables aunque el documento no sea editable).
- all() : array<string|int, static>
- Devuelve todos los registros que cumplen las condiciones.
- allWhereEq() : array<string|int, static>
- Devuelve todos los registros donde el campo es igual al valor.
- changeId() : bool
- Cambia el valor de la clave primaria del registro.
- changePrimaryColumnValue() : bool
- Cambia el valor de la clave primaria del registro.
- childrenDocuments() : array<string|int, TransformerDocument>
- Devuelve todos los documentos hijos de este.
- clear() : void
- Restablece los valores de todas las propiedades del modelo.
- clearCache() : void
- Elimina de la caché los datos relacionados con el modelo y su tabla.
- count() : int
- country() : string
- countWhereEq() : int
- Cuenta los registros donde el campo es igual al valor.
- create() : static|null
- delete() : bool
- Elimina este documento de la base de datos.
- deleteWhere() : bool
- dontCopyField() : void
- dontCopyFields() : array<string|int, mixed>
- exists() : bool
- Comprueba si el registro actual existe en la base de datos.
- find() : static|null
- findOrCreate() : static|null
- findWhere() : static|null
- findWhereEq() : static|null
- get() : static|false
- Busca un registro mediante su clave primaria y devuelve una nueva instancia.
- getApiFieldsToHide() : array<string|int, string>
- Devuelve los nombres de campos que no deben exponerse en la API (ni en GET, ni en el schema). Los modelos con datos sensibles deben sobrescribir este método fusionando con parent::getApiFieldsToHide().
- getAttachedFiles() : array<string|int, mixed>
- getAuditChannel() : string
- getAvailableStatus() : array<string|int, EstadoDocumento>
- Devuelve todos los estados disponibles para este tipo de documento.
- getCompany() : Empresa
- getDirty() : array<string|int, mixed>
- Devuelve un array asociativo con los campos modificados y sus valores actuales.
- getEUDiscount() : float
- Devuelve el Descuento Unificado Equivalente.
- getExercise() : Ejercicio
- getLines() : array<string|int, LineaPresupuestoCliente>
- Returns the lines associated with the estimation.
- getModelFields() : array<string|int, mixed>
- Returns the list of fields in the table.
- getNewLine() : LineaPresupuestoCliente
- Returns a new line for this document.
- getNewProductLine() : SalesDocumentLine
- Devuelve una nueva línea de documento con los datos del producto.
- getOriginal() : mixed|null
- Devuelve el valor original de un campo, si no se indica campo devuelve todo el array original
- getPaymentMethod() : FormaPago
- getPreviousStatus() : EstadoDocumento|null
- Devuelve el modelo EstadoDocumento anterior de este documento.
- getRate() : Tarifa
- getSerie() : Serie
- getStatus() : EstadoDocumento
- Devuelve el modelo EstadoDocumento de este documento.
- getSubject() : Cliente
- Devuelve el sujeto de este documento.
- getTotalDiscounts() : float
- Devuelve el descuento total de todo el documento.
- getUnlockedFields() : array<string|int, mixed>
- Devuelve la lista de campos desbloqueados (editables aunque el documento no sea editable).
- hasChanged() : bool
- hasColumn() : bool
- Comprueba si el modelo contiene la columna indicada.
- hasExtension() : bool
- Comprueba si el modelo tiene registrada la extensión indicada.
- id() : mixed
- Devuelve el valor de la clave primaria del modelo.
- install() : string
- Esta función se ejecuta al crear la tabla del modelo. Devuelve el SQL que se ejecutará después de la creación de la tabla. Útil para insertar valores por defecto.
- isDirty() : bool
- Comprueba si los campos del modelo han sido modificados.
- load() : bool
- Carga un modelo dada su primary key
- loadFromCode() : bool
- Carga un registro del modelo utilizando un código y opcionalmente condiciones adicionales.
- loadFromData() : void
- Carga los campos y atributos del modelo desde un array.
- loadWhere() : bool
- Carga el primer registro que coincida con las condiciones especificadas.
- loadWhereEq() : bool
- Carga el primer registro cuyo campo coincide con el valor indicado.
- maxLength() : int
- Devuelve la longitud máxima de un campo de texto, o 0 si no tiene límite o no es un campo de texto.
- modelClassName() : string
- Returns the name of the class of the model.
- newCode() : int
- Calcula el siguiente código numérico disponible para un campo.
- paid() : bool
- parentDocuments() : array<string|int, TransformerDocument>
- Devuelve todos los documentos padre de este.
- pipe() : mixed
- Ejecuta las extensiones asociadas al punto indicado y devuelve su resultado.
- pipeFalse() : bool
- Ejecuta las extensiones y devuelve false si alguna cancela la operación.
- primaryColumn() : string
- Devuelve el nombre de la columna que actúa como clave primaria.
- primaryColumnValue() : mixed
- Devuelve el valor de la clave primaria del modelo.
- primaryDescription() : mixed
- Devuelve la descripción principal del registro.
- primaryDescriptionColumn() : string
- Devuelve la descripción de la columna que es la clave primaria del modelo.
- reload() : bool
- Vuelve a cargar desde la base de datos el registro actual.
- removeUnlockedField() : void
- Elimina un campo de la lista de campos desbloqueados.
- save() : bool
- Guarda los datos en la base de datos.
- setAuthor() : bool
- Establece el autor de este documento.
- setCurrency() : void
- setDate() : bool
- Asigna la fecha y busca un ejercicio contable.
- setDocumentGeneration() : void
- setIntracomunitaria() : bool
- setSubject() : bool
- Asigna el cliente al documento.
- setWarehouse() : bool
- Establece el almacén y la empresa de este documento.
- subjectColumn() : string
- Devuelve el nombre de la columna del sujeto.
- subjectColumnValue() : string
- syncOriginal() : void
- Sincroniza los valores actuales con la copia original del modelo.
- table() : DbQuery
- tableName() : string
- Devuelve el nombre de la tabla asociada al modelo.
- test() : bool
- Devuelve True si no hay errores en los valores de las propiedades.
- toArray() : array<string|int, mixed>
- Devuelve un array con los campos y valores del modelo.
- totalSum() : float
- update() : bool
- Actualiza el modelo con los valores proporcionados en el array
- updateOrCreate() : static|null
- updateSubject() : bool
- Actualiza los datos del sujeto en este documento.
- url() : string
- Genera una URL para el modelo según el tipo especificado.
- belongsTo() : object|null
- Define una relación uno a uno.
- db() : DataBase
- hasMany() : array<string|int, mixed>
- Define una relación uno a muchos.
- loadModelFields() : void
- onChange() : bool
- Comprueba los campos modificados antes de actualizar la base de datos.
- onDelete() : void
- Este método se llama al eliminar un registro de la base de datos.
- onInsert() : void
- Este método se llama al insertar un nuevo registro en la base de datos (saveInsert).
- onUpdate() : void
- Este método se ejecuta después de actualizar un registro en la base de datos (saveUpdate).
- saveInsert() : bool
- Inserta un nuevo registro en la base de datos.
- saveUpdate() : bool
- Este método se llama al actualizar un registro existente en la base de datos.
- setContact() : bool
- setCustomer() : bool
Constants
MODEL_NAMESPACE
public
mixed
MODEL_NAMESPACE
= '\FacturaScripts\Dinamic\Model\\'
Properties
$apartado
Apartado de correos del cliente.
public
string
$apartado
$cifnif
CIF/NIF del cliente o proveedor.
public
string
$cifnif
$ciudad
Ciudad del cliente.
public
string
$ciudad
$codagente
Código del agente comercial asociado al documento.
public
string
$codagente
$codalmacen
Almacén del documento.
public
string
$codalmacen
$codcliente
Código del cliente asociado al documento.
public
string
$codcliente
$coddivisa
Código de la divisa utilizada en el documento.
public
string
$coddivisa
$codejercicio
Código del ejercicio contable asociado.
public
string
$codejercicio
$codigo
Identificador único para humanos.
public
string
$codigo
$codigoenv
Código de seguimiento del envío.
public
string
$codigoenv
$codpago
Código de la forma de pago asociada.
public
mixed
$codpago
@var string
$codpais
Código del país del cliente.
public
string
$codpais
$codpostal
Código postal del cliente.
public
string
$codpostal
$codserie
Código de la serie asociada.
public
mixed
$codserie
@var string
$codtrans
Código de la agencia de transporte del envío.
public
string
$codtrans
$direccion
Dirección del cliente.
public
string
$direccion
$dtopor1
Primer porcentaje de descuento global del documento.
public
float
$dtopor1
$dtopor2
Segundo porcentaje de descuento global del documento.
public
float
$dtopor2
$editable
Indica si el documento es editable.
public
bool
$editable
$fecha
Fecha del documento.
public
string
$fecha
$femail
Fecha en la que se envió el documento por email.
public
string
$femail
$finoferta
Fecha hasta la que se mantiene la validez del presupuesto.
public
mixed
$finoferta
@var string
$hora
Hora del documento.
public
string
$hora
$idcontactoenv
Identificador del contacto de envío.
public
int
$idcontactoenv
$idcontactofact
Identificador del contacto de facturación.
public
int
$idcontactofact
$idempresa
Identificador de la empresa asociada.
public
mixed
$idempresa
@var int|null
$idestado
Estado del documento, del modelo EstadoDocumento.
public
int
$idestado
$idestado_ant
Estado anterior del documento, del modelo EstadoDocumento.
public
int|null
$idestado_ant
$idpresupuesto
Identificador único del presupuesto de cliente.
public
mixed
$idpresupuesto
@var integer
$irpf
Retención por defecto del documento. Cada línea puede tener una retención diferente.
public
float|int
$irpf
$neto
Suma del pvptotal de las líneas. Total del documento antes de impuestos.
public
float|int
$neto
$netosindto
Suma del pvptotal de las líneas. Total del documento antes de impuestos y descuentos globales.
public
float|int
$netosindto
$nick
Usuario que creó este documento. Modelo User.
public
string
$nick
$nombrecliente
Nombre del cliente.
public
string
$nombrecliente
$numdocs
Número de documentos adjuntos.
public
int
$numdocs
$numero
Número del documento. Único dentro de la serie.
public
string
$numero
$numero2
Número opcional disponible para el usuario.
public
string
$numero2
$observaciones
Observaciones del documento.
public
string
$observaciones
$operacion
Tipo de operación fiscal del documento, por ejemplo intracomunitaria.
public
string
$operacion
$provincia
Provincia del cliente.
public
string
$provincia
$tasaconv
Tasa de conversión a euros de la divisa seleccionada.
public
float|int
$tasaconv
$total
Suma total del documento, con impuestos.
public
float|int
$total
$totalbeneficio
Suma total del beneficio de las líneas.
public
float
$totalbeneficio
$totalcoste
Suma total del coste de las líneas.
public
float
$totalcoste
$totaleuros
Total expresado en euros, si no fuera la divisa del documento.
public
float|int
$totaleuros
totaleuros = total / tasaconv No es necesario rellenarlo, al hacer save() se calcula el valor.
$totalirpf
Suma total de las retenciones de IRPF de las líneas.
public
float|int
$totalirpf
$totaliva
Suma del IVA de las líneas.
public
float|int
$totaliva
$totalrecargo
Suma total del recargo de equivalencia de las líneas.
public
float|int
$totalrecargo
$totalsuplidos
Suma total de las líneas de suplidos.
public
float|int
$totalsuplidos
$attributes
The model's attributes.
protected
array<string|int, mixed>
$attributes
= []
$dataBase
It provides direct access to the database.
protected
static DataBase
$dataBase
$dont_copy_fields
Campos que no se deben copiar al duplicar o transformar el documento.
protected
static mixed
$dont_copy_fields
= ['codejercicio', 'codigo', 'codigorect', 'fecha', 'femail', 'hora', 'idasiento', 'idestado', 'idfacturarect', 'neto', 'netosindto', 'numero', 'pagada', 'total', 'totalirpf', 'totaliva', 'totalrecargo', 'totalsuplidos']
@var array
$fields
Lista de campos de la tabla del modelo.
protected
static array<string|int, mixed>
$fields
= []
$original
The model's original attributes.
protected
array<string|int, mixed>
$original
= []
Methods
__construct()
Inicializa el modelo, comprueba su tabla y carga los datos proporcionados.
public
__construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string|int, mixed> = []
__get()
Devuelve el valor de un atributo dinámico.
public
__get(string $key) : mixed
Parameters
- $key : string
__isset()
Comprueba si existe un atributo dinámico con valor no nulo.
public
__isset(string $key) : bool
Parameters
- $key : string
Return values
bool__set()
Asigna el valor de un atributo dinámico.
public
__set(string $key, mixed $value) : void
Parameters
- $key : string
- $value : mixed
__unset()
Elimina un atributo dinámico.
public
__unset(string $key) : void
Parameters
- $key : string
addApiFieldToHide()
Añade un campo a la lista de campos que no deben exponerse en la API.
public
static addApiFieldToHide(string $field) : void
Solo permite añadir: los campos ocultos por el core no se pueden quitar.
Parameters
- $field : string
addExtension()
Añade una extensión al modelo con la prioridad indicada.
public
abstract static addExtension(mixed $extension[, int $priority = 100 ]) : void
Parameters
- $extension : mixed
- $priority : int = 100
addUnlockedField()
Añade un campo a la lista de campos desbloqueados (editables aunque el documento no sea editable).
public
static addUnlockedField(string $field) : void
Parameters
- $field : string
all()
Devuelve todos los registros que cumplen las condiciones.
public
static all([array<string|int, mixed> $where = [] ][, array<string|int, mixed> $order = [] ][, int $offset = 0 ][, int $limit = 0 ]) : array<string|int, static>
Parameters
- $where : array<string|int, mixed> = []
- $order : array<string|int, mixed> = []
- $offset : int = 0
- $limit : int = 0
Return values
array<string|int, static>allWhereEq()
Devuelve todos los registros donde el campo es igual al valor.
public
static allWhereEq(string $field, mixed $value[, array<string|int, mixed> $order = [] ]) : array<string|int, static>
Parameters
- $field : string
- $value : mixed
- $order : array<string|int, mixed> = []
Return values
array<string|int, static>changeId()
Cambia el valor de la clave primaria del registro.
public
changeId(mixed $new_id) : bool
Parameters
- $new_id : mixed
Return values
boolchangePrimaryColumnValue()
Cambia el valor de la clave primaria del registro.
public
changePrimaryColumnValue(mixed $new_id) : bool
replace with changeId()
Parameters
- $new_id : mixed
Return values
boolchildrenDocuments()
Devuelve todos los documentos hijos de este.
public
childrenDocuments() : array<string|int, TransformerDocument>
Return values
array<string|int, TransformerDocument>clear()
Restablece los valores de todas las propiedades del modelo.
public
clear() : void
clearCache()
Elimina de la caché los datos relacionados con el modelo y su tabla.
public
clearCache() : void
count()
public
static count([array<string|int, mixed> $where = [] ]) : int
Parameters
- $where : array<string|int, mixed> = []
Return values
intcountry()
public
country() : string
Return values
stringcountWhereEq()
Cuenta los registros donde el campo es igual al valor.
public
static countWhereEq(string $field, mixed $value) : int
Parameters
- $field : string
- $value : mixed
Return values
intcreate()
public
static create(array<string|int, mixed> $data) : static|null
Parameters
- $data : array<string|int, mixed>
Return values
static|nulldelete()
Elimina este documento de la base de datos.
public
delete() : bool
Return values
booldeleteWhere()
public
static deleteWhere(array<string|int, mixed> $where) : bool
Parameters
- $where : array<string|int, mixed>
Return values
booldontCopyField()
public
static dontCopyField(string $field) : void
Parameters
- $field : string
dontCopyFields()
public
static dontCopyFields() : array<string|int, mixed>
Return values
array<string|int, mixed>exists()
Comprueba si el registro actual existe en la base de datos.
public
exists() : bool
Return values
boolfind()
public
static find(mixed $code) : static|null
Parameters
- $code : mixed
Return values
static|nullfindOrCreate()
public
static findOrCreate(array<string|int, mixed> $where[, array<string|int, mixed> $data = [] ]) : static|null
Parameters
- $where : array<string|int, mixed>
- $data : array<string|int, mixed> = []
Return values
static|nullfindWhere()
public
static findWhere(array<string|int, mixed> $where[, array<string|int, mixed> $order = [] ]) : static|null
Parameters
- $where : array<string|int, mixed>
- $order : array<string|int, mixed> = []
Return values
static|nullfindWhereEq()
public
static findWhereEq(string $field, mixed $value) : static|null
Parameters
- $field : string
- $value : mixed
Return values
static|nullget()
Busca un registro mediante su clave primaria y devuelve una nueva instancia.
public
get(mixed $code) : static|false
Use find() instead
Parameters
- $code : mixed
Return values
static|falsegetApiFieldsToHide()
Devuelve los nombres de campos que no deben exponerse en la API (ni en GET, ni en el schema). Los modelos con datos sensibles deben sobrescribir este método fusionando con parent::getApiFieldsToHide().
public
getApiFieldsToHide() : array<string|int, string>
Return values
array<string|int, string>getAttachedFiles()
public
getAttachedFiles() : array<string|int, mixed>
Return values
array<string|int, mixed>getAuditChannel()
public
getAuditChannel() : string
Return values
stringgetAvailableStatus()
Devuelve todos los estados disponibles para este tipo de documento.
public
getAvailableStatus() : array<string|int, EstadoDocumento>
Return values
array<string|int, EstadoDocumento>getCompany()
public
getCompany() : Empresa
Return values
EmpresagetDirty()
Devuelve un array asociativo con los campos modificados y sus valores actuales.
public
getDirty() : array<string|int, mixed>
Return values
array<string|int, mixed>getEUDiscount()
Devuelve el Descuento Unificado Equivalente.
public
getEUDiscount() : float
Return values
floatgetExercise()
public
getExercise([string $codejercicio = '' ]) : Ejercicio
Parameters
- $codejercicio : string = ''
Return values
EjerciciogetLines()
Returns the lines associated with the estimation.
public
getLines() : array<string|int, LineaPresupuestoCliente>
Return values
array<string|int, LineaPresupuestoCliente>getModelFields()
Returns the list of fields in the table.
public
getModelFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getNewLine()
Returns a new line for this document.
public
getNewLine([array<string|int, mixed> $data = [] ][, array<string|int, mixed> $exclude = ['actualizastock', 'idlinea', 'idpresupuesto', 'servido'] ]) : LineaPresupuestoCliente
Parameters
- $data : array<string|int, mixed> = []
- $exclude : array<string|int, mixed> = ['actualizastock', 'idlinea', 'idpresupuesto', 'servido']
Return values
LineaPresupuestoClientegetNewProductLine()
Devuelve una nueva línea de documento con los datos del producto.
public
getNewProductLine(string $reference) : SalesDocumentLine
Busca el producto por referencia o código de barras.
Parameters
- $reference : string
Return values
SalesDocumentLinegetOriginal()
Devuelve el valor original de un campo, si no se indica campo devuelve todo el array original
public
getOriginal([string|null $key = null ]) : mixed|null
Parameters
- $key : string|null = null
Return values
mixed|null —Devuelve el valor original del campo o null si no existe
getPaymentMethod()
public
getPaymentMethod() : FormaPago
Return values
FormaPagogetPreviousStatus()
Devuelve el modelo EstadoDocumento anterior de este documento.
public
getPreviousStatus() : EstadoDocumento|null
Return values
EstadoDocumento|nullgetRate()
public
getRate() : Tarifa
Return values
TarifagetSerie()
public
getSerie() : Serie
Return values
SeriegetStatus()
Devuelve el modelo EstadoDocumento de este documento.
public
getStatus() : EstadoDocumento
Return values
EstadoDocumentogetSubject()
Devuelve el sujeto de este documento.
public
getSubject() : Cliente
Return values
ClientegetTotalDiscounts()
Devuelve el descuento total de todo el documento.
public
getTotalDiscounts() : float
Este cálculo tiene en cuenta tanto los descuentos globales aplicados al documento como los descuentos individuales aplicados en cada una de las líneas.
OJO, sin tener en cuenta impuestos. Se redondea el resultado con los decimales configurados por el sistema para evitar problemas de precisión en coma flotante.
Return values
float —Descuento total calculado.
getUnlockedFields()
Devuelve la lista de campos desbloqueados (editables aunque el documento no sea editable).
public
static getUnlockedFields() : array<string|int, mixed>
Return values
array<string|int, mixed>hasChanged()
public
hasChanged(string $field) : bool
replace with isDirty()
Parameters
- $field : string
Return values
boolhasColumn()
Comprueba si el modelo contiene la columna indicada.
public
hasColumn(string $columnName) : bool
Parameters
- $columnName : string
Return values
boolhasExtension()
Comprueba si el modelo tiene registrada la extensión indicada.
public
abstract hasExtension(mixed $extension) : bool
Parameters
- $extension : mixed
Return values
boolid()
Devuelve el valor de la clave primaria del modelo.
public
id() : mixed
install()
Esta función se ejecuta al crear la tabla del modelo. Devuelve el SQL que se ejecutará después de la creación de la tabla. Útil para insertar valores por defecto.
public
install() : string
Return values
stringisDirty()
Comprueba si los campos del modelo han sido modificados.
public
isDirty([string|null $key = null ]) : bool
Devuelve true si hay cambios, false en caso contrario.
Si introduces un parámetro key, comprueba solo ese campo
Parameters
- $key : string|null = null
Return values
bool —true si ha sido modificado, false en caso contrario
load()
Carga un modelo dada su primary key
public
load(mixed $code) : bool
Parameters
- $code : mixed
-
Código o identificador del registro a cargar
Return values
bool —Devuelve true si se encontró y cargó un registro exitosamente.
loadFromCode()
Carga un registro del modelo utilizando un código y opcionalmente condiciones adicionales.
public
loadFromCode(mixed $code[, array<string|int, mixed> $where = [] ][, array<string|int, mixed> $order = [] ]) : bool
Usar load() cuando solo se necesita cargar por código, o loadWhere() cuando se requieren condiciones WHERE u ordenamiento adicionales.
IMPORTANTE: Este método está deprecado. Se recomienda usar las alternativas siguientes:
- Si solo se proporciona $code: usar directamente load($code)
- Si se proporciona $code junto con $where o $order: usar loadWhere() con las condiciones apropiadas
Este método actúa como wrapper que redirige a load() cuando solo se proporciona el código, o a loadWhere() cuando se incluyen condiciones WHERE u ordenamiento adicionales.
Parameters
- $code : mixed
-
Código o identificador del registro a cargar. Se usa únicamente cuando no se proporcionan condiciones WHERE adicionales.
- $where : array<string|int, mixed> = []
-
Array de instancias de Where o DatabaseWhere que definen condiciones de filtrado adicionales. Si se proporciona, el método delega a loadWhere(). Por defecto es un array vacío.
- $order : array<string|int, mixed> = []
-
Array asociativo que define el ordenamiento de los resultados. Las claves son nombres de columnas y los valores la dirección del ordenamiento. Por defecto es un array vacío.
Return values
bool —Retorna true si se encontró y cargó un registro exitosamente. Retorna false si no se encontró ningún registro.
loadFromData()
Carga los campos y atributos del modelo desde un array.
public
loadFromData([array<string|int, mixed> $data = [] ][, array<string|int, mixed> $exclude = [] ][, bool $sync = true ]) : void
Parameters
- $data : array<string|int, mixed> = []
- $exclude : array<string|int, mixed> = []
-
Campos que no se deben cargar.
- $sync : bool = true
-
Indica si se deben sincronizar los valores originales.
loadWhere()
Carga el primer registro que coincida con las condiciones especificadas.
public
loadWhere(array<string|int, mixed> $where[, array<string|int, mixed> $order = [] ]) : bool
Este método consulta la tabla asociada al modelo aplicando las condiciones WHERE proporcionadas y el ordenamiento especificado. Si encuentra un registro, carga sus datos en la instancia actual del modelo. Si no encuentra ningún registro, limpia la instancia y retorna false.
Parameters
- $where : array<string|int, mixed>
-
Array de instancias de Where o DatabaseWhere que definen las condiciones de filtrado para la consulta. Cada elemento representa una condición que debe cumplir el registro a cargar.
- $order : array<string|int, mixed> = []
-
Array asociativo que define el ordenamiento de los resultados. Las claves son nombres de columnas y los valores indican la dirección del ordenamiento (ej: ['id' => 'DESC', 'nombre' => 'ASC']). Por defecto es un array vacío (sin ordenamiento específico).
Return values
bool —Retorna true si se encontró y cargó un registro exitosamente. Retorna false si no se encontró ningún registro que cumpla las condiciones.
loadWhereEq()
Carga el primer registro cuyo campo coincide con el valor indicado.
public
loadWhereEq(string $field, mixed $value) : bool
Parameters
- $field : string
- $value : mixed
Return values
boolmaxLength()
Devuelve la longitud máxima de un campo de texto, o 0 si no tiene límite o no es un campo de texto.
public
maxLength(string $field) : int
Parameters
- $field : string
-
Nombre del campo
Return values
int —Longitud máxima del campo
modelClassName()
Returns the name of the class of the model.
public
modelClassName() : string
Return values
stringnewCode()
Calcula el siguiente código numérico disponible para un campo.
public
newCode([string $field = '' ][, array<string|int, mixed> $where = [] ]) : int
Parameters
- $field : string = ''
- $where : array<string|int, mixed> = []
Return values
intpaid()
public
paid() : bool
Return values
boolparentDocuments()
Devuelve todos los documentos padre de este.
public
parentDocuments() : array<string|int, TransformerDocument>
Return values
array<string|int, TransformerDocument>pipe()
Ejecuta las extensiones asociadas al punto indicado y devuelve su resultado.
public
abstract pipe(mixed $name, mixed ...$arguments) : mixed
Parameters
- $name : mixed
- $arguments : mixed
pipeFalse()
Ejecuta las extensiones y devuelve false si alguna cancela la operación.
public
abstract pipeFalse(mixed $name, mixed ...$arguments) : bool
Parameters
- $name : mixed
- $arguments : mixed
Return values
boolprimaryColumn()
Devuelve el nombre de la columna que actúa como clave primaria.
public
static primaryColumn() : string
Return values
stringprimaryColumnValue()
Devuelve el valor de la clave primaria del modelo.
public
primaryColumnValue() : mixed
Use id() instead
Attributes
- #[Deprecated]
- $reason: 'Use id() instead'
- $replacement: '%class%->id()'
primaryDescription()
Devuelve la descripción principal del registro.
public
primaryDescription() : mixed
primaryDescriptionColumn()
Devuelve la descripción de la columna que es la clave primaria del modelo.
public
primaryDescriptionColumn() : string
Return values
stringreload()
Vuelve a cargar desde la base de datos el registro actual.
public
reload() : bool
Return values
boolremoveUnlockedField()
Elimina un campo de la lista de campos desbloqueados.
public
static removeUnlockedField(string $field) : void
Parameters
- $field : string
save()
Guarda los datos en la base de datos.
public
save() : bool
Return values
boolsetAuthor()
Establece el autor de este documento.
public
setAuthor(User $user) : bool
Parameters
- $user : User
Return values
boolsetCurrency()
public
setCurrency(string $coddivisa[, bool $purchase = false ]) : void
Parameters
- $coddivisa : string
- $purchase : bool = false
setDate()
Asigna la fecha y busca un ejercicio contable.
public
setDate(string $date, string $hour) : bool
Parameters
- $date : string
- $hour : string
Return values
boolsetDocumentGeneration()
public
setDocumentGeneration(bool $value) : void
Parameters
- $value : bool
setIntracomunitaria()
public
setIntracomunitaria() : bool
Return values
boolsetSubject()
Asigna el cliente al documento.
public
setSubject(Cliente|Contacto $subject) : bool
Parameters
Return values
boolsetWarehouse()
Establece el almacén y la empresa de este documento.
public
setWarehouse(string $codalmacen) : bool
Parameters
- $codalmacen : string
Return values
boolsubjectColumn()
Devuelve el nombre de la columna del sujeto.
public
subjectColumn() : string
Return values
stringsubjectColumnValue()
public
subjectColumnValue() : string
Return values
stringsyncOriginal()
Sincroniza los valores actuales con la copia original del modelo.
public
syncOriginal() : void
table()
public
static table() : DbQuery
Return values
DbQuerytableName()
Devuelve el nombre de la tabla asociada al modelo.
public
static tableName() : string
Return values
stringtest()
Devuelve True si no hay errores en los valores de las propiedades.
public
test() : bool
Return values
booltoArray()
Devuelve un array con los campos y valores del modelo.
public
toArray([bool $dynamic_attributes = false ]) : array<string|int, mixed>
Parameters
- $dynamic_attributes : bool = false
-
Si es true, añade también los atributos dinámicos al array resultante
Return values
array<string|int, mixed> —Array asociativo con los campos y valores del modelo
totalSum()
public
static totalSum(string $field[, array<string|int, mixed> $where = [] ]) : float
Parameters
- $field : string
- $where : array<string|int, mixed> = []
Return values
floatupdate()
Actualiza el modelo con los valores proporcionados en el array
public
update(array<string|int, mixed> $values) : bool
Parameters
- $values : array<string|int, mixed>
-
Array asociativo con los campos y valores a actualizar
Return values
bool —Devuelve true si la actualización se ha realizado correctamente, false en caso
updateOrCreate()
public
static updateOrCreate(array<string|int, mixed> $where, array<string|int, mixed> $data) : static|null
Parameters
- $where : array<string|int, mixed>
- $data : array<string|int, mixed>
Return values
static|nullupdateSubject()
Actualiza los datos del sujeto en este documento.
public
updateSubject() : bool
Return values
boolurl()
Genera una URL para el modelo según el tipo especificado.
public
url([string $type = 'auto' ][, string $list = 'List' ]) : string
Parameters
- $type : string = 'auto'
-
Tipo de URL a generar. Puede ser 'auto', 'edit', 'list' o 'new'.
- $list : string = 'List'
-
Nombre de la lista a utilizar en la URL cuando el tipo es 'list' o 'auto'.
Return values
string —URL generada para el modelo
belongsTo()
Define una relación uno a uno.
protected
belongsTo(string $modelName, string $foreignKey) : object|null
Parameters
- $modelName : string
- $foreignKey : string
Return values
object|nulldb()
protected
abstract static db() : DataBase
Return values
DataBasehasMany()
Define una relación uno a muchos.
protected
hasMany(string $modelName, string $foreignKey[, array<string|int, mixed> $where = [] ][, array<string|int, mixed> $order = [] ][, bool $cached = false ]) : array<string|int, mixed>
Parameters
- $modelName : string
- $foreignKey : string
- $where : array<string|int, mixed> = []
- $order : array<string|int, mixed> = []
- $cached : bool = false
-
usar solo en relaciones de solo lectura y de listas pequeñas y cerradas
Return values
array<string|int, mixed>loadModelFields()
protected
loadModelFields() : void
onChange()
Comprueba los campos modificados antes de actualizar la base de datos.
protected
onChange(string $field) : bool
Parameters
- $field : string
Return values
boolonDelete()
Este método se llama al eliminar un registro de la base de datos.
protected
onDelete() : void
onInsert()
Este método se llama al insertar un nuevo registro en la base de datos (saveInsert).
protected
onInsert() : void
onUpdate()
Este método se ejecuta después de actualizar un registro en la base de datos (saveUpdate).
protected
onUpdate() : void
saveInsert()
Inserta un nuevo registro en la base de datos.
protected
saveInsert() : bool
Return values
boolsaveUpdate()
Este método se llama al actualizar un registro existente en la base de datos.
protected
saveUpdate() : bool
Return values
bool —Devuelve true si la actualización se realizó correctamente, false en caso contrario
setContact()
protected
setContact(Contacto $subject) : bool
Parameters
- $subject : Contacto
Return values
boolsetCustomer()
protected
setCustomer(Cliente $subject) : bool
Parameters
- $subject : Cliente