Document
extends Model
in package
Uses
Validation, SoftDelete
Thiocyn\PaymentReminders\Models\Document
Tags
Table of Contents
- $attachOne : mixed
- $belongsTo : mixed
- $created_at : Carbon|null
- $deleted_at : Carbon|null
- $file : File
- $hasOneThrough : mixed
- $id : int
- $level : int
- $order : Order
- $payment_date : Carbon|null
- $reminder : Reminder
- $reminder_id : int
- $rules : array<string|int, mixed>
- $sent_at : Carbon|null
- $sent_date : mixed
- $status : string
- $table : string
- $type : string
- $updated_at : Carbon|null
- $dates : mixed
- $forceDeleting : bool
- Indicates if the model is currently force deleting.
- $validationDefaultAttrNames : array<string|int, mixed>
- $validationErrors : MessageBag
- all() :
- bootSoftDelete() : void
- Boot the soft deleting trait for a model.
- bootValidation() : void
- Boot the validation trait for this model.
- errors() : MessageBag
- Get validation error message collection for the Model
- forceDelete() : void
- Force a hard delete on a soft deleted model.
- forceSave() : bool
- Force save the model even if validation fails.
- get() :
- getDeletedAtColumn() : string
- Get the name of the "deleted at" column.
- getNextReminderDate() : Carbon|false
- getPaymentDateAttribute() : Carbon|null
- getQualifiedDeletedAtColumn() : string
- Get the fully qualified "deleted at" column.
- getSentDateAttribute() : mixed
- isAttributeRequired() : bool
- Determines if an attribute is required based on the validation rules.
- isSoftDelete() : bool
- Helper method to check if the model is currently being hard or soft deleted, useful in events.
- newModelQuery() :
- newQuery() :
- onlyTrashed() : Builder|static
- Get a new query builder that only includes soft deletes.
- pdfOutput() : mixed
- pdfSave() : mixed
- pdfStream() : mixed
- query() :
- restore() : bool|null
- Restore a soft-deleted model instance.
- restored() : void
- Register a restored model event with the dispatcher.
- restoring() : void
- Register a restoring model event with the dispatcher.
- send() : bool
- sendEmail() : bool
- 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.
- trashed() : bool
- Determine if the model instance has been soft-deleted.
- 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() :
- whereDeletedAt() :
- whereId() :
- whereLevel() :
- whereReminderId() :
- whereSentAt() :
- whereStatus() :
- whereType() :
- whereUpdatedAt() :
- withTrashed() : Builder|static
- Get a new query builder that includes soft deletes.
- 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.
- performDeleteOnModel() : mixed
- Perform the actual delete query on this model instance.
- performRestoreOnRelations() : void
- Locates relations with softDelete flag and cascades the restore event.
- performSoftDeleteOnRelations() : void
- Locates relations with softDelete flag and cascades the delete event.
- 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
- runSoftDelete() : void
- Perform the actual delete query on this model instance.
- getAddress() : array<string|int, mixed>
- getEMailTemplate() : mixed
- getEPostTemplate() : mixed
- getVars() : array<string|int, mixed>
- sendPost() : false
Properties
$attachOne
public
mixed
$attachOne
= ['file' => ['System\Models\File', 'public' => false]]
$belongsTo
public
mixed
$belongsTo
= ['reminder' => ThiocynPaymentRemindersModelsReminder::class]
$created_at
public
Carbon|null
$created_at
$deleted_at
public
Carbon|null
$deleted_at
$file
public
File
$file
$hasOneThrough
public
mixed
$hasOneThrough
= ['order' => [ThiocynOrdersModelsOrder::class, 'key' => 'reminder_id', 'throughKey' => 'order_id', 'otherKey' => 'id', 'through' => ThiocynPaymentRemindersModelsReminder::class]]
$id
public
int
$id
$level
public
int
$level
$order
public
Order
$order
$payment_date read-only
public
Carbon|null
$payment_date
$reminder
public
Reminder
$reminder
$reminder_id
public
int
$reminder_id
$rules
public
array<string|int, mixed>
$rules
= []
Validation rules
$sent_at
public
Carbon|null
$sent_at
$sent_date read-only
public
mixed
$sent_date
$status
public
string
$status
$table
public
string
$table
= 'thiocyn_paymentreminders_documents'
The database table used by the model.
$type
public
string
$type
$updated_at
public
Carbon|null
$updated_at
$dates
protected
mixed
$dates
= ['sent_at', 'deleted_at']
$forceDeleting
Indicates if the model is currently force deleting.
protected
bool
$forceDeleting
= false
$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
—bootSoftDelete()
Boot the soft deleting trait for a model.
public
static bootSoftDelete() : void
Return values
void —bootValidation()
Boot the validation trait for this model.
public
static bootValidation() : void
Return values
void —errors()
Get validation error message collection for the Model
public
errors() : MessageBag
Return values
MessageBag —forceDelete()
Force a hard delete on a soft deleted model.
public
forceDelete() : 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
—getDeletedAtColumn()
Get the name of the "deleted at" column.
public
getDeletedAtColumn() : string
Return values
string —getNextReminderDate()
public
getNextReminderDate() : Carbon|false
Return values
Carbon|false —getPaymentDateAttribute()
public
getPaymentDateAttribute() : Carbon|null
Return values
Carbon|null —getQualifiedDeletedAtColumn()
Get the fully qualified "deleted at" column.
public
getQualifiedDeletedAtColumn() : string
Return values
string —getSentDateAttribute()
public
getSentDateAttribute() : 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 —isSoftDelete()
Helper method to check if the model is currently being hard or soft deleted, useful in events.
public
isSoftDelete() : bool
Return values
bool —newModelQuery()
public
static newModelQuery() :
Return values
—newQuery()
public
static newQuery() :
Return values
—onlyTrashed()
Get a new query builder that only includes soft deletes.
public
static onlyTrashed() : Builder|static
Return values
Builder|static —pdfOutput()
public
pdfOutput([string|null $template = null ]) : mixed
Parameters
- $template : string|null = null
Return values
mixed —pdfSave()
public
pdfSave([null|string $filename = null ][, string|null $template = null ]) : mixed
Parameters
- $filename : null|string = null
- $template : string|null = null
Return values
mixed —pdfStream()
public
pdfStream() : mixed
Return values
mixed —query()
public
static query() :
Return values
—restore()
Restore a soft-deleted model instance.
public
restore() : bool|null
Return values
bool|null —restored()
Register a restored model event with the dispatcher.
public
static restored(Closure|string $callback) : void
Parameters
- $callback : Closure|string
Return values
void —restoring()
Register a restoring model event with the dispatcher.
public
static restoring(Closure|string $callback) : void
Parameters
- $callback : Closure|string
Return values
void —send()
public
send() : bool
Return values
bool —sendEmail()
public
sendEmail() : bool
Return values
bool —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 —trashed()
Determine if the model instance has been soft-deleted.
public
trashed() : bool
Return values
bool —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
—whereDeletedAt()
public
static whereDeletedAt(mixed $value) :
Parameters
- $value : mixed
Return values
—whereId()
public
static whereId(mixed $value) :
Parameters
- $value : mixed
Return values
—whereLevel()
public
static whereLevel(mixed $value) :
Parameters
- $value : mixed
Return values
—whereReminderId()
public
static whereReminderId(mixed $value) :
Parameters
- $value : mixed
Return values
—whereSentAt()
public
static whereSentAt(mixed $value) :
Parameters
- $value : mixed
Return values
—whereStatus()
public
static whereStatus(mixed $value) :
Parameters
- $value : mixed
Return values
—whereType()
public
static whereType(mixed $value) :
Parameters
- $value : mixed
Return values
—whereUpdatedAt()
public
static whereUpdatedAt(mixed $value) :
Parameters
- $value : mixed
Return values
—withTrashed()
Get a new query builder that includes soft deletes.
public
static withTrashed() : Builder|static
Return values
Builder|static —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 —performDeleteOnModel()
Perform the actual delete query on this model instance.
protected
performDeleteOnModel() : mixed
Return values
mixed —performRestoreOnRelations()
Locates relations with softDelete flag and cascades the restore event.
protected
performRestoreOnRelations() : void
Return values
void —performSoftDeleteOnRelations()
Locates relations with softDelete flag and cascades the delete event.
protected
performSoftDeleteOnRelations() : void
Return values
void —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 —runSoftDelete()
Perform the actual delete query on this model instance.
protected
runSoftDelete() : void
Return values
void —getAddress()
private
getAddress() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEMailTemplate()
private
getEMailTemplate() : mixed
Return values
mixed —getEPostTemplate()
private
getEPostTemplate() : mixed
Return values
mixed —getVars()
private
getVars() : array<string|int, mixed>
Return values
array<string|int, mixed> —sendPost()
private
sendPost() : false