1. trait
  2. Hypervel
  3. \
  4. Validation
  5. \
  6. Rules
  7. \
  8. DatabaseRule

DatabaseRule

trait DatabaseRule

Properties

protected string $table

The table to run the query against.
protected string $column

The column to check on.
protected array $wheres

The extra where clauses for the query.
protected array $using

The array of custom query callbacks.

Methods

__construct(string $table, string $column = 'NULL')

Create a new rule instance.

string
resolveTableName(string $table)

Resolves the name of the table from the given string.

DatabaseRule
where(Closure|string $column, mixed $value = null)

Set a "where" constraint on the query.

DatabaseRule
whereNot(string $column, mixed $value)

Set a "where not" constraint on the query.

DatabaseRule
whereNull(string $column)

Set a "where null" constraint on the query.

DatabaseRule
whereNotNull(string $column)

Set a "where not null" constraint on the query.

DatabaseRule
whereIn(string $column, array|Arrayable|BackedEnum $values)

Set a "where in" constraint on the query.

DatabaseRule
whereNotIn(string $column, array|Arrayable|BackedEnum $values)

Set a "where not in" constraint on the query.

DatabaseRule
withoutTrashed(string $deletedAtColumn = 'deleted_at')

Ignore soft deleted models during the existence checks.

DatabaseRule
onlyTrashed(string $deletedAtColumn = 'deleted_at')

Only include soft deleted models during the existence check.

DatabaseRule
using(Closure $callback)

Register a custom query callback.

array
queryCallbacks()

Get the custom query callbacks for the rule.

mixed
normalizeWhereValue(mixed $value)

Normalize a where value for string serialization.

string
formatWheres()

Format the where clauses.

Details

at line 40
__construct(string $table, string $column = 'NULL')

Create a new rule instance.

Parameters

string $table
string $column

at line 50
string resolveTableName(string $table)

Resolves the name of the table from the given string.

Parameters

string $table

Return Value

string

at line 76
DatabaseRule where(Closure|string $column, mixed $value = null)

Set a "where" constraint on the query.

Parameters

Closure|string $column
mixed $value

Return Value

DatabaseRule

at line 102
DatabaseRule whereNot(string $column, mixed $value)

Set a "where not" constraint on the query.

Parameters

string $column
mixed $value

Return Value

DatabaseRule

at line 118
DatabaseRule whereNull(string $column)

Set a "where null" constraint on the query.

Parameters

string $column

Return Value

DatabaseRule

at line 128
DatabaseRule whereNotNull(string $column)

Set a "where not null" constraint on the query.

Parameters

string $column

Return Value

DatabaseRule

at line 138
DatabaseRule whereIn(string $column, array|Arrayable|BackedEnum $values)

Set a "where in" constraint on the query.

Parameters

string $column
array|Arrayable|BackedEnum $values

Return Value

DatabaseRule

at line 150
DatabaseRule whereNotIn(string $column, array|Arrayable|BackedEnum $values)

Set a "where not in" constraint on the query.

Parameters

string $column
array|Arrayable|BackedEnum $values

Return Value

DatabaseRule

at line 162
DatabaseRule withoutTrashed(string $deletedAtColumn = 'deleted_at')

Ignore soft deleted models during the existence checks.

Parameters

string $deletedAtColumn

Return Value

DatabaseRule

at line 174
DatabaseRule onlyTrashed(string $deletedAtColumn = 'deleted_at')

Only include soft deleted models during the existence check.

Parameters

string $deletedAtColumn

Return Value

DatabaseRule

at line 186
DatabaseRule using(Closure $callback)

Register a custom query callback.

Parameters

Closure $callback

Return Value

DatabaseRule

at line 196
array queryCallbacks()

Get the custom query callbacks for the rule.

Return Value

array

at line 204
protected mixed normalizeWhereValue(mixed $value)

Normalize a where value for string serialization.

Parameters

mixed $value

Return Value

mixed

at line 214
protected string formatWheres()

Format the where clauses.

Return Value

string