FacturaScripts

ApiKey extends ApiKey

in package

• Application

Class created by Core/Internal/PluginsDeploy

Table of Contents

Properties

$apikey  : mixed

Clave utilizada para autenticarse en la API.

$creationdate  : mixed

Fecha de creación de la clave API.

$description  : mixed

Descripción de la clave API.

$enabled  : mixed

Indica si la clave API está habilitada.

$fullaccess  : mixed

Indica si la clave permite acceder a todos los recursos de la API.

$id  : mixed

Identificador único de la clave API.

$lastactivity  : mixed

Fecha y hora de la última actividad de la clave API.

$lastip  : mixed

Dirección IP desde la que se utilizó la clave API por última vez.

$nick  : mixed

Nombre del usuario asociado a la clave API.

$attributes  : array<string|int, mixed>

The model's attributes.

$dataBase  : DataBase

It provides direct access to the database.

$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.

addAccess()  : bool

Adds a new API access entry for the given resource with the specified permissions.

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.

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.

clear()  : void

Restablece los campos del modelo a sus valores predeterminados.

clearCache()  : void

Elimina de la caché los datos relacionados con el modelo y su tabla.

count()  : int

countWhereEq()  : int

Cuenta los registros donde el campo es igual al valor.

create()  : static|null

delete()  : bool

Elimina el registro actual de la base de datos.

deleteWhere()  : bool

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.

getAccess()  : ApiAccess|null

Retrieves the API access entry for the specified resource.

getAccesses()  : array<string|int, mixed>

getApiFieldsToHide()  : array<string|int, string>

Devuelve los nombres de campos que no deben exponerse en la API.

getDirty()  : array<string|int, mixed>

Devuelve un array asociativo con los campos modificados y sus valores actuales.

getModelFields()  : array<string|int, mixed>

Returns the list of fields in the table.

getOriginal()  : mixed|null

Devuelve el valor original de un campo, si no se indica campo devuelve todo el array original

hasAccess()  : bool

Comprueba si esta API key tiene permiso para la operación indicada sobre el recurso.

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

Devuelve el SQL inicial necesario para instalar los datos del modelo.

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.

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

primaryColumnValue()  : mixed

Devuelve el valor de la clave primaria del modelo.

primaryDescription()  : mixed

Devuelve la descripción principal del registro.

primaryDescriptionColumn()  : string

Devuelve el nombre de la columna utilizada como descripción principal.

reload()  : bool

Vuelve a cargar desde la base de datos el registro actual.

save()  : bool

Guarda el modelo en la base de datos después de ejecutar las comprobaciones `$this->test()`

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

Realiza pruebas de validación sobre los campos del modelo antes de guardarlo.

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

updateActivity()  : bool

updateOrCreate()  : static|null

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 un campo modificado antes de actualizar el registro.

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 llama al actualizar un registro en la base de datos.

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.