W3cubDocs

/Laravel 8

DatabaseRule

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, array|string|int|null $value = null)

Set a "where" constraint on the query.
$this whereNot(string $column, 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, array $values)

Set a "where in" constraint on the query.
$this whereNotIn(string $column, array $values)

Set a "where not in" constraint on the query.
$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, array|string|int|null $value = null)

Set a "where" constraint on the query.

Parameters

Closure|string $column
array|string|int|null $value

Return Value

$this

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

Set a "where not" constraint on the query.

Parameters

string $column
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, array $values)

Set a "where in" constraint on the query.

Parameters

string $column
array $values

Return Value

$this

$this whereNotIn(string $column, array $values)

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

Parameters

string $column
array $values

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

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Validation/Rules/DatabaseRule.html