Documentation

Key extends Model
in package
Uses Validation

Thiocyn\ApiAuth\Models\Key

Tags
mixin

\Eloquent

Table of Contents

$attachMany  : mixed
$attachOne  : mixed
$belongsTo  : mixed
$belongsToMany  : mixed
$created_at  : Carbon|null
$expire_datetime  : string|null
$hasMany  : mixed
$hasOne  : array<string|int, mixed>
$id  : int
$key  : string
$morphMany  : mixed
$morphOne  : mixed
$morphTo  : mixed
$rules  : array<string|int, mixed>
$table  : string
$updated_at  : Carbon|null
$user_id  : int
$validationDefaultAttrNames  : array<string|int, mixed>
$validationErrors  : MessageBag
all()  :
beforeCreate()  : mixed
Generate a ApiKey
bootValidation()  : void
Boot the validation trait for this model.
errors()  : MessageBag
Get validation error message collection for the Model
forceSave()  : bool
Force save the model even if validation fails.
get()  :
getUserIdOptions()  : mixed
isAttributeRequired()  : bool
Determines if an attribute is required based on the validation rules.
newModelQuery()  :
newQuery()  :
query()  :
setValidationAttributeName()  : void
Programatically sets the validation attribute names, will take lower priority to model defined attribute names found in `$attributeNames`.
setValidationAttributeNames()  : void
Programatically sets multiple validation attribute names.
validate()  : bool
Validate the model instance
validated()  : void
Create a new native event for handling afterValidate().
validating()  : void
Create a new native event for handling beforeValidate().
whereCreatedAt()  :
whereExpireDatetime()  :
whereId()  :
whereKey()  :
whereUpdatedAt()  :
whereUserId()  :
getRelationValidationValue()  : mixed
Attachments validate differently to their simple values.
getValidationAttributes()  : array<string|int, mixed>
Returns the model data used for validation.
makeValidator()  : Validator
Instantiates the validator used by the validation process, depending if the class is being used inside or outside of Laravel. Optional connection string to make the validator use a different database connection than the default connection.
processRuleFieldNames()  : array<string|int, mixed>
Processes field names in a rule array.
processValidationRules()  : mixed
Process rules
processValidationUniqueRule()  : string
Rebuilds the unique validation rule to force for the existing ID

Properties

$attachMany

public mixed $attachMany = []

$attachOne

public mixed $attachOne = []

$belongsTo

public mixed $belongsTo = ['user' => ['RainLab\User\Models\User']]

$belongsToMany

public mixed $belongsToMany = []

$expire_datetime

public string|null $expire_datetime

$hasMany

public mixed $hasMany = []

$hasOne

public array<string|int, mixed> $hasOne = []

Relations

$key

public string $key

$morphMany

public mixed $morphMany = []

$morphOne

public mixed $morphOne = []

$morphTo

public mixed $morphTo = []

$rules

public array<string|int, mixed> $rules = []

Validation rules

$table

public string $table = 'thiocyn_apiauth_keys'

The database table used by the model.

$user_id

public int $user_id

$validationDefaultAttrNames

protected array<string|int, mixed> $validationDefaultAttrNames = []

Default custom attribute names.

$validationErrors

protected MessageBag $validationErrors

The message bag instance containing validation error messages

Methods

all()

public static all(mixed $columns) :
Parameters
$columns : mixed
Return values
—

beforeCreate()

Generate a ApiKey

public beforeCreate() : mixed
Return values
mixed —

bootValidation()

Boot the validation trait for this model.

public static bootValidation() : void
Return values
void —

forceSave()

Force save the model even if validation fails.

public forceSave([mixed $options = null ][, mixed $sessionKey = null ]) : bool
Parameters
$options : mixed = null
$sessionKey : mixed = null
Return values
bool —

get()

public static get(mixed $columns) :
Parameters
$columns : mixed
Return values
—

getUserIdOptions()

public getUserIdOptions() : mixed
Return values
mixed —

isAttributeRequired()

Determines if an attribute is required based on the validation rules.

public isAttributeRequired(string $attribute[, bool $checkDependencies = true ]) : bool
Parameters
$attribute : string
$checkDependencies : bool = true

Checks the attribute dependencies (for required_if & required_with rules). Note that it will only be checked up to the next level, if another dependent rule is found then it will just assume the field is required

Return values
bool —

newModelQuery()

public static newModelQuery() :
Return values
—

newQuery()

public static newQuery() :
Return values
—

query()

public static query() :
Return values
—

setValidationAttributeName()

Programatically sets the validation attribute names, will take lower priority to model defined attribute names found in `$attributeNames`.

public setValidationAttributeName(string $attr, string $name) : void
Parameters
$attr : string
$name : string
Return values
void —

setValidationAttributeNames()

Programatically sets multiple validation attribute names.

public setValidationAttributeNames(array<string|int, mixed> $attributeNames) : void
Parameters
$attributeNames : array<string|int, mixed>
Return values
void —

validate()

Validate the model instance

public validate([mixed $rules = null ][, mixed $customMessages = null ][, mixed $attributeNames = null ]) : bool
Parameters
$rules : mixed = null
$customMessages : mixed = null
$attributeNames : mixed = null
Return values
bool —

validated()

Create a new native event for handling afterValidate().

public static validated(Closure|string $callback) : void
Parameters
$callback : Closure|string
Return values
void —

validating()

Create a new native event for handling beforeValidate().

public static validating(Closure|string $callback) : void
Parameters
$callback : Closure|string
Return values
void —

whereCreatedAt()

public static whereCreatedAt(mixed $value) :
Parameters
$value : mixed
Return values
—

whereExpireDatetime()

public static whereExpireDatetime(mixed $value) :
Parameters
$value : mixed
Return values
—

whereId()

public static whereId(mixed $value) :
Parameters
$value : mixed
Return values
—

whereKey()

public static whereKey(mixed $value) :
Parameters
$value : mixed
Return values
—

whereUpdatedAt()

public static whereUpdatedAt(mixed $value) :
Parameters
$value : mixed
Return values
—

whereUserId()

public static whereUserId(mixed $value) :
Parameters
$value : mixed
Return values
—

getRelationValidationValue()

Attachments validate differently to their simple values.

protected getRelationValidationValue(mixed $relationName) : mixed
Parameters
$relationName : mixed
Return values
mixed —

getValidationAttributes()

Returns the model data used for validation.

protected getValidationAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

makeValidator()

Instantiates the validator used by the validation process, depending if the class is being used inside or outside of Laravel. Optional connection string to make the validator use a different database connection than the default connection.

protected static makeValidator(mixed $data, mixed $rules, mixed $customMessages, mixed $attributeNames[, mixed $connection = null ]) : Validator
Parameters
$data : mixed
$rules : mixed
$customMessages : mixed
$attributeNames : mixed
$connection : mixed = null
Return values
Validator —

processRuleFieldNames()

Processes field names in a rule array.

protected processRuleFieldNames(array<string|int, mixed> $rules) : array<string|int, mixed>

Converts any field names using array notation (ie. field[child]) into dot notation (ie. field.child)

Parameters
$rules : array<string|int, mixed>

Rules array

Return values
array<string|int, mixed> —

processValidationRules()

Process rules

protected processValidationRules(mixed $rules) : mixed
Parameters
$rules : mixed
Return values
mixed —

processValidationUniqueRule()

Rebuilds the unique validation rule to force for the existing ID

protected processValidationUniqueRule(string $definition, string $fieldName) : string
Parameters
$definition : string
$fieldName : string
Return values
string —

Search results