0 follower

Abstract Class Yiisoft\Validator\Rule\Date\BaseDate

All Classes | Methods
InheritanceYiisoft\Validator\Rule\Date\BaseDate
ImplementsYiisoft\Validator\RuleInterface, Yiisoft\Validator\SkipOnEmptyInterface, Yiisoft\Validator\SkipOnErrorInterface, Yiisoft\Validator\WhenInterface
Uses TraitsYiisoft\Validator\Rule\Trait\SkipOnEmptyTrait, Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait, Yiisoft\Validator\Rule\Trait\WhenTrait
SubclassesYiisoft\Validator\Rule\Date\Date, Yiisoft\Validator\Rule\Date\DateTime, Yiisoft\Validator\Rule\Date\Time

See also Yiisoft\Validator\Rule\Date\BaseDateHandler.

Psalm Types

Name Value
IntlDateFormatterFormat \IntlDateFormatter::FULL|\IntlDateFormatter::LONG|\IntlDateFormatter::MEDIUM|\IntlDateFormatter::SHORT|\IntlDateFormatter::NONE

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Validator\Rule\Date\BaseDate
getFormat() Yiisoft\Validator\Rule\Date\BaseDate
getHandler() A matching handler name or an instance used for processing this rule. Yiisoft\Validator\RuleInterface
getIncorrectInputMessage() Yiisoft\Validator\Rule\Date\BaseDate
getLocale() Yiisoft\Validator\Rule\Date\BaseDate
getMax() Yiisoft\Validator\Rule\Date\BaseDate
getMessageFormat() Yiisoft\Validator\Rule\Date\BaseDate
getMin() Yiisoft\Validator\Rule\Date\BaseDate
getName() Yiisoft\Validator\Rule\Date\BaseDate
getSkipOnEmpty() A getter for $skipOnEmpty property. Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait
getTimeZone() Yiisoft\Validator\Rule\Date\BaseDate
getTooEarlyMessage() Yiisoft\Validator\Rule\Date\BaseDate
getTooLateMessage() Yiisoft\Validator\Rule\Date\BaseDate
getWhen() A getter for $when property. Yiisoft\Validator\Rule\Trait\WhenTrait
shouldSkipOnError() A getter for $skipOnError property. Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait
skipOnEmpty() An immutable setter to change $skipOnEmpty property. Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait
skipOnError() An immutable setter to change $skipOnError property. Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait
when() An immutable setter to change $when property. Yiisoft\Validator\Rule\Trait\WhenTrait

Method Details

Hide inherited methods

__construct() public method

public __construct( string|null $format, string|null $timeZone, string|null $locale, integer|string|DateTimeInterface|null $min, integer|string|DateTimeInterface|null $max, string|null $messageFormat, string|null $incorrectInputMessage, string|null $tooEarlyMessage, string|null $tooLateMessage, boolean|callable|null $skipOnEmpty, boolean $skipOnError, Closure|null $when ): mixed
$format string|null
$timeZone string|null
$locale string|null
$min integer|string|DateTimeInterface|null
$max integer|string|DateTimeInterface|null
$messageFormat string|null
$incorrectInputMessage string|null
$tooEarlyMessage string|null
$tooLateMessage string|null
$skipOnEmpty boolean|callable|null
$skipOnError boolean
$when Closure|null 

                public function __construct(
    private ?string $format,
    private ?string $timeZone,
    private ?string $locale,
    private int|string|DateTimeInterface|null $min,
    private int|string|DateTimeInterface|null $max,
    private ?string $messageFormat,
    private ?string $incorrectInputMessage,
    private ?string $tooEarlyMessage,
    private ?string $tooLateMessage,
    bool|callable|null $skipOnEmpty,
    private bool $skipOnError,
    private ?Closure $when,
) {
    $this->skipOnEmpty = $skipOnEmpty;
}
getFormat() public method

public getFormat( ): string|null

                public function getFormat(): ?string
{
    return $this->format;
}
getHandler() public abstract method

Defined in: Yiisoft\Validator\RuleInterface::getHandler()

A matching handler name or an instance used for processing this rule.

While not required, for naming of handlers' classes it's recommended to use a rule class name with "Handler" suffix, so for FilledAtLeast rule class name the handler class name will be FilledAtLeastHandler and so on.

All packages handlers are stored within the same namespace as rules, but this is not a strict requirement.

public abstract getHandler( ): Yiisoft\Validator\RuleHandlerInterface|string
return Yiisoft\Validator\RuleHandlerInterface|string

A rule handler name (for example my-handler) or an instance (for example new MyRuleHandler()).

 

                public function getHandler(): string|RuleHandlerInterface;
getIncorrectInputMessage() public method

public getIncorrectInputMessage( ): string|null

                public function getIncorrectInputMessage(): ?string
{
    return $this->incorrectInputMessage;
}
getLocale() public method

public getLocale( ): string|null

                public function getLocale(): ?string
{
    return $this->locale;
}
getMax() public method

public getMax( ): DateTimeInterface|integer|string|null

                public function getMax(): DateTimeInterface|int|string|null
{
    return $this->max;
}
getMessageFormat() public method

public getMessageFormat( ): string|null

                public function getMessageFormat(): ?string
{
    return $this->messageFormat;
}
getMin() public method

public getMin( ): DateTimeInterface|integer|string|null

                public function getMin(): DateTimeInterface|int|string|null
{
    return $this->min;
}
getName() public method

public getName( ): string

                public function getName(): string
{
    return 'date';
}
getSkipOnEmpty() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait::getSkipOnEmpty()

A getter for $skipOnEmpty property.

public getSkipOnEmpty( ): boolean|callable|null
return boolean|callable|null

A current raw (non-normalized) value.

 

                public function getSkipOnEmpty(): bool|callable|null
{
    return $this->skipOnEmpty;
}
getTimeZone() public method

public getTimeZone( ): non-empty-string|null

                public function getTimeZone(): ?string
{
    return $this->timeZone;
}
getTooEarlyMessage() public method

public getTooEarlyMessage( ): string|null

                public function getTooEarlyMessage(): ?string
{
    return $this->tooEarlyMessage;
}
getTooLateMessage() public method

public getTooLateMessage( ): string|null

                public function getTooLateMessage(): ?string
{
    return $this->tooLateMessage;
}
getWhen() public method

Defined in: Yiisoft\Validator\Rule\Trait\WhenTrait::getWhen()

A getter for $when property.

public getWhen( ): Closure|null
return Closure|null

Current value:

  • null - always apply the validation.
  • callable - apply the validation depending on a return value: true - apply, false - do not apply.
 

                public function getWhen(): ?Closure
{
    return $this->when;
}
shouldSkipOnError() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait::shouldSkipOnError()

A getter for $skipOnError property.

public shouldSkipOnError( ): boolean
return boolean

Current value. true means to skip the current rule when the previous one errored and false - do not skip.

 

                public function shouldSkipOnError(): bool
{
    return $this->skipOnError;
}
skipOnEmpty() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait::skipOnEmpty()

An immutable setter to change $skipOnEmpty property.

public skipOnEmpty( boolean|callable|null $value ): $this
$value boolean|callable|null

A new value.
return $this

The new instance with a changed value.

 

                public function skipOnEmpty(bool|callable|null $value): static
{
    $new = clone $this;
    $new->skipOnEmpty = $value;
    return $new;
}
skipOnError() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait::skipOnError()

An immutable setter to change $skipOnError property.

public skipOnError( boolean $value ): $this
$value boolean

A new value. true means to skip the current rule when the previous one errored and false - do not skip.
return $this

The new instance with a changed value.

 

                public function skipOnError(bool $value): static
{
    $new = clone $this;
    $new->skipOnError = $value;
    return $new;
}
when() public method

Defined in: Yiisoft\Validator\Rule\Trait\WhenTrait::when()

An immutable setter to change $when property.

public when( Closure|null $value ): $this
$value Closure|null

A new value:

  • null - always apply the validation.
  • callable - apply the validation depending on a return value: true - apply, false - do not apply.
return $this

The new instance with a changed value.

 

                public function when(?Closure $value): static
{
    $new = clone $this;
    $new->when = $value;
    return $new;
}