1. class
  2. Illuminate
  3. \
  4. Validation
  5. \
  6. Rule

Rule

class Rule (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable

Methods

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
static Can
can(string $ability, mixed ...$arguments)

Get a can constraint builder instance.

static ConditionalRules
when(callable|bool $condition, ValidationRule|InvokableRule|Rule|Closure|array|string $rules, ValidationRule|InvokableRule|Rule|Closure|array|string $defaultRules = [])

Apply the given rules if the given condition is truthy.

static ConditionalRules
unless(callable|bool $condition, ValidationRule|InvokableRule|Rule|Closure|array|string $rules, ValidationRule|InvokableRule|Rule|Closure|array|string $defaultRules = [])

Apply the given rules if the given condition is falsy.

static ArrayRule
array(array|null $keys = null)

Get an array rule builder instance.

static NestedRules
forEach(callable $callback)

Create a new nested rule set.

static Unique
unique(string $table, string $column = 'NULL')

Get a unique constraint builder instance.

static Exists
exists(string $table, string $column = 'NULL')

Get an exists constraint builder instance.

static In
in(Arrayable|BackedEnum|UnitEnum|array|string $values)

Get an in rule builder instance.

static NotIn
notIn(Arrayable|BackedEnum|UnitEnum|array|string $values)

Get a not_in rule builder instance.

static RequiredIf
requiredIf(callable|bool $callback)

Get a required_if rule builder instance.

static ExcludeIf
excludeIf(callable|bool $callback)

Get a exclude_if rule builder instance.

static ProhibitedIf
prohibitedIf(callable|bool $callback)

Get a prohibited_if rule builder instance.

static Date
date()

Get a date rule builder instance.

static Email
email()

Get an email rule builder instance.

static Enum
enum(class-string $type)

Get an enum rule builder instance.

static File
file()

Get a file rule builder instance.

static ImageFile
imageFile(bool $allowSvg = false)

Get an image file rule builder instance.

static Dimensions
dimensions(array $constraints = [])

Get a dimensions rule builder instance.

static Numeric
numeric()

Get a numeric rule builder instance.

static object|stdClass
compile(string $attribute, array $rules, array|null $data = null)

Compile a set of rules for an attribute.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 36
static Can can(string $ability, mixed ...$arguments)

Get a can constraint builder instance.

Parameters

string $ability
mixed ...$arguments

Return Value

Can

at line 49
static ConditionalRules when(callable|bool $condition, ValidationRule|InvokableRule|Rule|Closure|array|string $rules, ValidationRule|InvokableRule|Rule|Closure|array|string $defaultRules = [])

Apply the given rules if the given condition is truthy.

Parameters

callable|bool $condition
ValidationRule|InvokableRule|Rule|Closure|array|string $rules
ValidationRule|InvokableRule|Rule|Closure|array|string $defaultRules

Return Value

ConditionalRules

at line 62
static ConditionalRules unless(callable|bool $condition, ValidationRule|InvokableRule|Rule|Closure|array|string $rules, ValidationRule|InvokableRule|Rule|Closure|array|string $defaultRules = [])

Apply the given rules if the given condition is falsy.

Parameters

callable|bool $condition
ValidationRule|InvokableRule|Rule|Closure|array|string $rules
ValidationRule|InvokableRule|Rule|Closure|array|string $defaultRules

Return Value

ConditionalRules

at line 73
static ArrayRule array(array|null $keys = null)

Get an array rule builder instance.

Parameters

array|null $keys

Return Value

ArrayRule

at line 84
static NestedRules forEach(callable $callback)

Create a new nested rule set.

Parameters

callable $callback

Return Value

NestedRules

at line 96
static Unique unique(string $table, string $column = 'NULL')

Get a unique constraint builder instance.

Parameters

string $table
string $column

Return Value

Unique

at line 108
static Exists exists(string $table, string $column = 'NULL')

Get an exists constraint builder instance.

Parameters

string $table
string $column

Return Value

Exists

at line 119
static In in(Arrayable|BackedEnum|UnitEnum|array|string $values)

Get an in rule builder instance.

Parameters

Arrayable|BackedEnum|UnitEnum|array|string $values

Return Value

In

at line 134
static NotIn notIn(Arrayable|BackedEnum|UnitEnum|array|string $values)

Get a not_in rule builder instance.

Parameters

Arrayable|BackedEnum|UnitEnum|array|string $values

Return Value

NotIn

at line 149
static RequiredIf requiredIf(callable|bool $callback)

Get a required_if rule builder instance.

Parameters

callable|bool $callback

Return Value

RequiredIf

at line 160
static ExcludeIf excludeIf(callable|bool $callback)

Get a exclude_if rule builder instance.

Parameters

callable|bool $callback

Return Value

ExcludeIf

at line 171
static ProhibitedIf prohibitedIf(callable|bool $callback)

Get a prohibited_if rule builder instance.

Parameters

callable|bool $callback

Return Value

ProhibitedIf

at line 181
static Date date()

Get a date rule builder instance.

Return Value

Date

at line 191
static Email email()

Get an email rule builder instance.

Return Value

Email

at line 202
static Enum enum(class-string $type)

Get an enum rule builder instance.

Parameters

class-string $type

Return Value

Enum

at line 212
static File file()

Get a file rule builder instance.

Return Value

File

at line 223
static ImageFile imageFile(bool $allowSvg = false)

Get an image file rule builder instance.

Parameters

bool $allowSvg

Return Value

ImageFile

at line 234
static Dimensions dimensions(array $constraints = [])

Get a dimensions rule builder instance.

Parameters

array $constraints

Return Value

Dimensions

at line 244
static Numeric numeric()

Get a numeric rule builder instance.

Return Value

Numeric

at line 257
static object|stdClass compile(string $attribute, array $rules, array|null $data = null)

Compile a set of rules for an attribute.

Parameters

string $attribute
array $rules
array|null $data

Return Value

object|stdClass