trait DatabaseRule (View source)

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

void
__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.

$this
where(Closure|string $column, Arrayable|BackedEnum|Closure|array|string|int|bool|null $value = null)

Set a "where" constraint on the query.

$this
whereNot(string $column, Arrayable|BackedEnum|array|string $value)

Set a "where not" constraint on the query.

$this
whereNull(string $column)

Set a "where null" constraint on the query.

$this
whereNotNull(string $column)

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

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

Set a "where in" constraint on the query.

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

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

$this
withoutTrashed(string $deletedAtColumn = 'deleted_at')

Ignore soft deleted models during the existence check.

$this
onlyTrashed(string $deletedAtColumn = 'deleted_at')

Only include soft deleted models during the existence check.

$this
using(Closure $callback)

Register a custom query callback.

array
queryCallbacks()

Get the custom query callbacks for the rule.

string
formatWheres()

Format the where clauses.

Details

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

Create a new rule instance.

Parameters

string $table
string $column

Return Value

void

string resolveTableName(string $table)

Resolves the name of the table from the given string.

Parameters

string $table

Return Value

string

$this where(Closure|string $column, Arrayable|BackedEnum|Closure|array|string|int|bool|null $value = null)

Set a "where" constraint on the query.

Parameters

Closure|string $column
Arrayable|BackedEnum|Closure|array|string|int|bool|null $value

Return Value

$this

$this whereNot(string $column, Arrayable|BackedEnum|array|string $value)

Set a "where not" constraint on the query.

Parameters

string $column
Arrayable|BackedEnum|array|string $value

Return Value

$this

$this whereNull(string $column)

Set a "where null" constraint on the query.

Parameters

string $column

Return Value

$this

$this whereNotNull(string $column)

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

Parameters

string $column

Return Value

$this

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

Set a "where in" constraint on the query.

Parameters

string $column
Arrayable|BackedEnum|array $values

Return Value

$this

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

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

Parameters

string $column
Arrayable|BackedEnum|array $values

Return Value

$this

$this withoutTrashed(string $deletedAtColumn = 'deleted_at')

Ignore soft deleted models during the existence check.

Parameters

string $deletedAtColumn

Return Value

$this

$this onlyTrashed(string $deletedAtColumn = 'deleted_at')

Only include soft deleted models during the existence check.

Parameters

string $deletedAtColumn

Return Value

$this

$this using(Closure $callback)

Register a custom query callback.

Parameters

Closure $callback

Return Value

$this

array queryCallbacks()

Get the custom query callbacks for the rule.

Return Value

array

protected string formatWheres()

Format the where clauses.

Return Value

string