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 ConditionalRules
when(callable|bool $condition, array|string|Closure $rules, array|string|Closure $defaultRules = [])

Create a new conditional rule set.

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

Get an in constraint builder instance.

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

Get a not_in constraint builder instance.

static RequiredIf
requiredIf(callable|bool $callback)

Get a required_if constraint builder instance.

static ExcludeIf
excludeIf(callable|bool $callback)

Get a exclude_if constraint builder instance.

static ProhibitedIf
prohibitedIf(callable|bool $callback)

Get a prohibited_if constraint builder instance.

static Enum
enum(string $type)

Get an enum constraint builder instance.

static File
file()

Get a file constraint builder instance.

static ImageFile
imageFile()

Get an image file constraint builder instance.

static Dimensions
dimensions(array $constraints = [])

Get a dimensions constraint builder instance.

Details

in Macroable at line 26
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 40
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 60
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 70
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 84
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 110
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Create a new conditional rule set.

Parameters

callable|bool $condition
array|string|Closure $rules
array|string|Closure $defaultRules

Return Value

ConditionalRules

at line 42
static NestedRules forEach(callable $callback)

Create a new nested rule set.

Parameters

callable $callback

Return Value

NestedRules

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

Get a unique constraint builder instance.

Parameters

string $table
string $column

Return Value

Unique

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

Get an exists constraint builder instance.

Parameters

string $table
string $column

Return Value

Exists

at line 77
static In in(Arrayable|array|string $values)

Get an in constraint builder instance.

Parameters

Arrayable|array|string $values

Return Value

In

at line 92
static NotIn notIn(Arrayable|array|string $values)

Get a not_in constraint builder instance.

Parameters

Arrayable|array|string $values

Return Value

NotIn

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

Get a required_if constraint builder instance.

Parameters

callable|bool $callback

Return Value

RequiredIf

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

Get a exclude_if constraint builder instance.

Parameters

callable|bool $callback

Return Value

ExcludeIf

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

Get a prohibited_if constraint builder instance.

Parameters

callable|bool $callback

Return Value

ProhibitedIf

at line 140
static Enum enum(string $type)

Get an enum constraint builder instance.

Parameters

string $type

Return Value

Enum

at line 150
static File file()

Get a file constraint builder instance.

Return Value

File

at line 160
static ImageFile imageFile()

Get an image file constraint builder instance.

Return Value

ImageFile

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

Get a dimensions constraint builder instance.

Parameters

array $constraints

Return Value

Dimensions

Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.