Documentation

Rule
in package
Uses Macroable

Table of Contents

$macros  : array<string|int, mixed>
The registered string macros.
__call()  : mixed
Dynamically handle calls to the class.
__callStatic()  : mixed
Dynamically handle calls to the class.
dimensions()  : Dimensions
Get a dimensions constraint builder instance.
exists()  : Exists
Get a exists constraint builder instance.
hasMacro()  : bool
Checks if macro is registered.
in()  : In
Get an in constraint builder instance.
macro()  : void
Register a custom macro.
mixin()  : void
Mix another object into the class.
notIn()  : NotIn
Get a not_in constraint builder instance.
unique()  : Unique
Get a unique constraint builder instance.

Properties

$macros

The registered string macros.

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

Methods

__call()

Dynamically handle calls to the class.

public __call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
$method : string
$parameters : array<string|int, mixed>
Tags
throws
BadMethodCallException
Return values
mixed —

__callStatic()

Dynamically handle calls to the class.

public static __callStatic(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
$method : string
$parameters : array<string|int, mixed>
Tags
throws
BadMethodCallException
Return values
mixed —

dimensions()

Get a dimensions constraint builder instance.

public static dimensions([array<string|int, mixed> $constraints = [] ]) : Dimensions
Parameters
$constraints : array<string|int, mixed> = []
Return values
Dimensions —

exists()

Get a exists constraint builder instance.

public static exists(string $table[, string $column = 'NULL' ]) : Exists
Parameters
$table : string
$column : string = 'NULL'
Return values
Exists —

hasMacro()

Checks if macro is registered.

public static hasMacro(string $name) : bool
Parameters
$name : string
Return values
bool —

in()

Get an in constraint builder instance.

public static in(array<string|int, mixed>|string $values) : In
Parameters
$values : array<string|int, mixed>|string
Return values
In —

macro()

Register a custom macro.

public static macro(string $name, object|callable $macro) : void
Parameters
$name : string
$macro : object|callable
Return values
void —

mixin()

Mix another object into the class.

public static mixin(object $mixin) : void
Parameters
$mixin : object
Return values
void —

notIn()

Get a not_in constraint builder instance.

public static notIn(array<string|int, mixed>|string $values) : NotIn
Parameters
$values : array<string|int, mixed>|string
Return values
NotIn —

unique()

Get a unique constraint builder instance.

public static unique(string $table[, string $column = 'NULL' ]) : Unique
Parameters
$table : string
$column : string = 'NULL'
Return values
Unique —

Search results