Public Member Functions
	__construct ()
	validate (mixed $data)
	result ()
	required (bool $required=true)
	empty (bool $empty=true)
	nullable (bool $nullable=true)
	type (Types $type)
	is (string $className)
	lessOrEqual (int\|float\|string\|array\|DateTimeInterface $value)
	less (int\|float\|string\|array\|DateTimeInterface $value)
	greatOrEqual (int\|float\|string\|array\|DateTimeInterface $value)
	great (int\|float\|string\|array\|DateTimeInterface $value)
	between (int\|float\|string\|DateTimeInterface $down, int\|float\|string\|DateTimeInterface $up)
	contains (string\|array $contains)
	file (bool $file=true)
	directory (bool $directory=true)
	exists (bool $exists=true)
	startswith (string $substr)
	endswith (string $substr)

Detailed Description

Definition at line 45 of file Validator.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Construtor da classe Validator.

Não realiza nenhuma configuração inicial; as regras de validação devem ser definidas pelos métodos fluentes (required(), type(), min() etc.) antes de chamar validate().

Definition at line 215 of file Validator.php.

Member Function Documentation

◆ between()

between	(	int\|float\|string\|DateTimeInterface	$down,
		int\|float\|string\|DateTimeInterface	$up )

Define um intervalo (inclusivo) aceito para o valor.

Os limites $down e $up devem ser exatamente do mesmo tipo (verificado via gettype()). Se os tipos forem diferentes, uma RuntimeException é lançada imediatamente, no momento da configuração (antes mesmo de validate() ser executado).

Parameters

int \| float \| string \| DateTimeInterface	$down	O limite inferior do intervalo (inclusivo).
int \| float \| string \| DateTimeInterface	$up	O limite superior do intervalo (inclusivo).

Exceptions

RuntimeException Se $down e $up forem de tipos diferentes.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 1023 of file Validator.php.

◆ contains()

contains ( string|array $contains )

Define um valor (ou lista de valores) que o valor validado deve conter.

Com string, verifica se o valor contém a substring informada (str_contains()). Com array, verifica se o valor informado está presente na lista validada, usando in_array() sem comparação estrita (portanto '1' e 1 são considerados equivalentes).

Parameters

string|array<array-key,mixed> $contains A substring exigida ou a lista de valores aceitos.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 1087 of file Validator.php.

◆ directory()

directory ( bool $directory = true )

Define se o valor (um caminho) deve ser validado como um diretório existente.

A verificação só é executada quando o parâmetro é true; passar false não gera nenhum teste (o resultado permanece null em result()) e não representa uma validação negativa.

Parameters

bool $directory Se true (padrão), valida se o caminho é um diretório existente.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 1167 of file Validator.php.

◆ empty()

empty ( bool $empty = true )

Define se o valor pode ser vazio.

Com true (padrão), o valor pode ser vazio, mas não nulo. Com false, o valor não pode ser vazio (nem nulo, quando a verificação é aplicável).

A verificação é realizada apenas para valores do tipo string ou array.

Parameters

bool $empty Se true, permite valor vazio; se false, não permite.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 453 of file Validator.php.

◆ endswith()

endswith ( string $substr )

Define que o valor (uma string) deve terminar com a substring informada.

A verificação só é executada se o valor validado for uma string.

Parameters

string $substr A substring com a qual o valor deve terminar.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 1262 of file Validator.php.

◆ exists()

exists ( bool $exists = true )

Define se o valor (um caminho) deve existir no sistema de arquivos.

A verificação só é executada quando o parâmetro é true; passar false não gera nenhum teste (o resultado permanece null em result()) e não representa uma validação negativa.

Parameters

bool $exists Se true (padrão), valida se o caminho existe.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 1199 of file Validator.php.

◆ file()

file ( bool $file = true )

Define se o valor (um caminho) deve ser validado como um arquivo existente.

A verificação só é executada quando o parâmetro é true; passar false não gera nenhum teste (o resultado permanece null em result()) e não representa uma validação negativa.

Parameters

bool $file Se true (padrão), valida se o caminho é um arquivo existente.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 1135 of file Validator.php.

◆ great()

great ( int|float|string|array|DateTimeInterface $value )

Define um valor limite inferior exclusivo (estritamente maior).

A comparação depende do tipo do dado: números são comparados por valor, strings pelo comprimento (mb_strlen), arrays pelo número de elementos e datas/horas entre si.

Parameters

int|float|string|array<array-key,mixed>|DateTimeInterface $value O valor limite inferior exclusivo.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 924 of file Validator.php.

◆ greatOrEqual()

greatOrEqual ( int|float|string|array|DateTimeInterface $value )

Define um valor limite inferior inclusivo (maior ou igual).

A comparação depende do tipo do dado: números são comparados por valor, strings pelo comprimento (mb_strlen), arrays pelo número de elementos e datas/horas entre si.

Parameters

int|float|string|array<array-key,mixed>|DateTimeInterface $value O valor limite inferior inclusivo.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 828 of file Validator.php.

◆ is()

is ( string $className )

Define que o valor deve ser uma instância da classe informada.

A comparação é feita de forma exata (via get_class()), e não com instanceof: instâncias de subclasses da classe informada falham na validação.

A verificação só é executada se o valor for um objeto.

Parameters

class-string $className O nome completo da classe esperada.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 599 of file Validator.php.

◆ less()

less ( int|float|string|array|DateTimeInterface $value )

Define um valor limite superior exclusivo (estritamente menor).

A comparação depende do tipo do dado: números são comparados por valor, strings pelo comprimento (mb_strlen), arrays pelo número de elementos e datas/horas entre si.

Obs.: para valores do tipo data/hora, a verificação utiliza "<=" (menor ou igual), e não estritamente "<".

Parameters

int|float|string|array<array-key,mixed>|DateTimeInterface $value O valor limite superior exclusivo.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 733 of file Validator.php.

◆ lessOrEqual()

lessOrEqual ( int|float|string|array|DateTimeInterface $value )

Define um valor limite superior inclusivo (menor ou igual).

A comparação depende do tipo do valor validado: números são comparados por valor, strings pelo comprimento (mb_strlen), arrays pelo número de elementos e datas/horas entre si.

Parameters

int|float|string|array<array-key,mixed>|DateTimeInterface $value O valor limite superior inclusivo.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 634 of file Validator.php.

◆ nullable()

nullable ( bool $nullable = true )

Define se o valor pode ser nulo.

Parameters

bool $nullable Se true (padrão), permite valor nulo; se false, o valor não pode ser nulo.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 502 of file Validator.php.

◆ required()

required ( bool $required = true )

Define se o valor é obrigatório (não pode ser nulo nem ter comprimento zero).

Parameters

bool $required Se true (padrão), o valor é obrigatório; se false, a regra não impõe obrigatoriedade.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 416 of file Validator.php.

◆ result()

result ( )

Retorna o resultado de todas as regras configuradas ou não.

Cada chave é o nome da regra (ex.: 'required', 'type', 'leq', etc.) e o valor pode ser:

true: a regra passou;
false: a regra falhou;
null: a regra não foi configurada, portanto não foi testada.

Returns: ResultMap O resultado completo das regras.

Definition at line 375 of file Validator.php.

◆ startswith()

startswith ( string $substr )

Define que o valor (uma string) deve começar com a substring informada.

A verificação só é executada se o valor validado for uma string.

Parameters

string $substr A substring com a qual o valor deve começar.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 1230 of file Validator.php.

◆ type()

type ( Types $type )

Define o tipo esperado do valor, de acordo com o enum Types.

O tipo é verificado pelas funções nativas do PHP (is_bool(), is_numeric(), is_int(), etc.), de acordo com o caso do enum informado.

Parameters

Types $type O tipo esperado do valor.

Returns: self Retorna a própria instância para permitir encadeamento de regras.

Definition at line 536 of file Validator.php.

◆ validate()

validate ( mixed $data )

Executa as regras de validação configuradas sobre o valor informado.

Armazena o valor a validar na propriedade interna de dados e, para cada regra previamente configurada (e aplicável ao tipo do valor), executa a verificação correspondente, armazenando o resultado de cada regra em result().

Regras configuradas com valor falsy (por exemplo, file(false), directory(false) ou exists(false)) não são testadas e permanecem com resultado null em result().

Parameters

mixed $data O valor a ser validado.

Returns: bool True se nenhuma regra configurada falhou; caso contrário, false.

Definition at line 235 of file Validator.php.

The documentation for this class was generated from the following file:

src/Validator.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ between()

◆ contains()

◆ directory()

◆ empty()

◆ endswith()

◆ exists()

◆ file()

◆ great()

◆ greatOrEqual()

◆ is()

◆ less()

◆ lessOrEqual()

◆ nullable()

◆ required()

◆ result()

◆ startswith()

◆ type()

◆ validate()