Phalcon Filter

Filter\Exception

Phalcon\Filter\Exception

Exceptions thrown in Phalcon\Filter will use this class

Filter\Exceptions\FilterNotRegistered

Uses Phalcon\Filter\Exception

Method Summary

Methods

__construct()

public function __construct( string $name );

Filter\Filter

Lazy loads, stores and exposes sanitizer objects

@method int absint(mixed $input) @method string alnum(mixed $input) @method string alpha(mixed $input) @method bool bool(mixed $input) @method string email(string $input) @method float float(mixed $input) @method int int(string $input) @method string|false ip(string $input, int $filter = FILTER_FLAG_NONE) @method string lower(string $input) @method string lowerfirst(string $input) @method mixed regex(mixed $input, mixed $pattern, mixed $replace) @method mixed remove(mixed $input, mixed $replace) @method mixed replace(mixed $input, mixed $source, mixed $target) @method string special(string $input) @method string specialfull(string $input) @method string string(string $input) @method string stringlegacy(mixed $input) @method string striptags(string $input) @method string trim(string $input) @method string upper(string $input) @method string upperFirst(string $input) @method string|null upperWords(string $input) @method string|null url(string $input)

@property array $mapper @property array $services

Uses Phalcon\Filter\Exceptions\FilterNotRegistered · Phalcon\Filter\Sanitize\AbsInt · Phalcon\Filter\Sanitize\Alnum · Phalcon\Filter\Sanitize\Alpha · Phalcon\Filter\Sanitize\BoolVal · Phalcon\Filter\Sanitize\Email · Phalcon\Filter\Sanitize\FloatVal · Phalcon\Filter\Sanitize\IntVal · Phalcon\Filter\Sanitize\Ip · Phalcon\Filter\Sanitize\Lower · Phalcon\Filter\Sanitize\LowerFirst · Phalcon\Filter\Sanitize\Regex · Phalcon\Filter\Sanitize\Remove · Phalcon\Filter\Sanitize\Replace · Phalcon\Filter\Sanitize\Special · Phalcon\Filter\Sanitize\SpecialFull · Phalcon\Filter\Sanitize\StringVal · Phalcon\Filter\Sanitize\StringValLegacy · Phalcon\Filter\Sanitize\Striptags · Phalcon\Filter\Sanitize\Trim · Phalcon\Filter\Sanitize\Upper · Phalcon\Filter\Sanitize\UpperFirst · Phalcon\Filter\Sanitize\UpperWords · Phalcon\Filter\Sanitize\Url

Method Summary

Constants

Properties

Methods

__call()

public function __call(
    string $name,
    array $args
);

Magic call to make the helper objects available as methods.

__construct()

public function __construct( array $mapper = [] );

Filter constructor.

get()

public function get( string $name ): mixed;

Get a service. If it is not in the mapper array, create a new object, set it and then return it.

getDefaultMapper()

public static function getDefaultMapper(): array;

Returns the default sanitizer name to class map. This is the single source for the built-in sanitizer registry: when adding a sanitizer, add its FILTER_* constant and its entry here.

has()

public function has( string $name ): bool;

Checks if a service exists in the map array

sanitize()

public function sanitize(
    mixed $value,
    mixed $sanitizers,
    bool $noRecursive = false
): mixed;

Sanitizes a value with a specified single or set of sanitizers

Array policy: when $value is an array and $noRecursive is false (the default), each element is passed to the sanitizer individually and an array is returned - recursion is one level deep only. Elements that are themselves arrays are passed to the sanitizer as-is, which raises a TypeError for sanitizers that type their value parameter (e.g. trim). When $noRecursive is true, the whole array is passed to the sanitizer as a single value.

set()

public function set(
    string $name,
    mixed $service
): void;

Set a new service to the mapper array

init()

protected function init( array $mapper ): void;

Loads the objects in the internal mapper array

Filter\FilterFactory

Class FilterFactory

@package Phalcon\Filter

Uses Phalcon\Filter\Filter

Method Summary

Methods

newInstance()

public function newInstance(): FilterInterface;

Returns a Locator object with all the helpers defined in anonymous functions

getServices()

protected function getServices(): array;

Returns the available adapters

Filter\FilterInterface

Lazy loads, stores and exposes sanitizer objects

Method Summary

Methods

sanitize()

public function sanitize(
    mixed $value,
    mixed $sanitizers,
    bool $noRecursive = false
): mixed;

Sanitizes a value with a specified single or set of sanitizers

Array policy: when $value is an array and $noRecursive is false (the default), each element is sanitized individually and an array is returned - recursion is one level deep only. When $noRecursive is true, the whole array is passed to the sanitizer as a single value.

Filter\Sanitize\AbsInt

Phalcon\Filter\Sanitize\AbsInt

Sanitizes a value to absolute integer

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\Alnum

Phalcon\Filter\Sanitize\Alnum

Sanitizes a value to an alphanumeric value

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\Alpha

Phalcon\Filter\Sanitize\Alpha

Sanitizes a value to an alpha value

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\BoolVal

Phalcon\Filter\Sanitize\BoolVal

Sanitizes a value to boolean

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\Email

Phalcon\Filter\Sanitize\Email

Sanitizes an email string

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\FloatVal

Phalcon\Filter\Sanitize\FloatVal

Sanitizes a value to float

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\IntVal

Phalcon\Filter\Sanitize\IntVal

Sanitizes a value to integer

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\Ip

Phalcon\Filter\Sanitize\IP

Sanitizes a value to an ip address or CIDR range

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke(
    string $input,
    int $filter = 0
): string|false;

Filter\Sanitize\Lower

Phalcon\Filter\Sanitize\Lower

Sanitizes a value to lowercase

Uses Phalcon\Contracts\Filter\Sanitizer · Phalcon\Traits\Php\MbCaseTrait

Method Summary

Methods

__invoke()

public function __invoke( string $input );

Filter\Sanitize\LowerFirst

Phalcon\Filter\Sanitize\LowerFirst

Sanitizes a value to lcfirst

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( string $input );

Filter\Sanitize\Regex

Phalcon\Filter\Sanitize\Regex

Sanitizes a value performing preg_replace

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke(
    mixed $input,
    mixed $pattern,
    mixed $replace
);

Filter\Sanitize\Remove

Phalcon\Filter\Sanitize\Remove

Sanitizes a value removing parts of a string

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke(
    mixed $input,
    mixed $replace
);

Filter\Sanitize\Replace

Phalcon\Filter\Sanitize\Replace

Sanitizes a value replacing parts of a string

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke(
    mixed $input,
    mixed $from,
    mixed $to
);

Filter\Sanitize\Special

Phalcon\Filter\Sanitize\Special

Sanitizes a value special characters

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\SpecialFull

Phalcon\Filter\Sanitize\SpecialFull

Sanitizes a value special characters (htmlspecialchars() and ENT_QUOTES)

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\StringVal

Sanitizes a value to string

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke(
    string $input,
    int $flags = 11
): string;

Filter\Sanitize\StringValLegacy

Sanitizes a value to string using filter_var(). The filter provides backwards compatibility with versions prior to v5. For PHP higher or equal to 8.1, the filter will remain the string unchanged. If anything other than a string is passed, the method will return false

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Sanitize\Striptags

Phalcon\Filter\Sanitize\Striptags

Sanitizes a value striptags

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( string $input );

Filter\Sanitize\Trim

Phalcon\Filter\Sanitize\Trim

Sanitizes a value removing leading and trailing spaces

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( string $input );

Filter\Sanitize\Upper

Phalcon\Filter\Sanitize\Upper

Sanitizes a value to uppercase

Uses Phalcon\Contracts\Filter\Sanitizer · Phalcon\Traits\Php\MbCaseTrait

Method Summary

Methods

__invoke()

public function __invoke( string $input );

Filter\Sanitize\UpperFirst

Phalcon\Filter\Sanitize\UpperFirst

Sanitizes a value to ucfirst

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( string $input );

Filter\Sanitize\UpperWords

Phalcon\Filter\Sanitize\UpperWords

Sanitizes a value to uppercase the first character of each word

Uses Phalcon\Contracts\Filter\Sanitizer · Phalcon\Traits\Php\MbCaseTrait

Method Summary

Methods

__invoke()

public function __invoke( string $input );

Filter\Sanitize\Url

Phalcon\Filter\Sanitize\Url

Sanitizes a value url

Uses Phalcon\Contracts\Filter\Sanitizer

Method Summary

Methods

__invoke()

public function __invoke( mixed $input );

Filter\Validation

Allows to validate data using custom or built-in validators

Uses Phalcon\Di\Di · Phalcon\Di\DiInterface · Phalcon\Di\Injectable · Phalcon\Filter\FilterInterface · Phalcon\Filter\Validation\AbstractCombinedFieldsValidator · Phalcon\Filter\Validation\Exception · Phalcon\Filter\Validation\Exceptions\FilterServiceUnavailable · Phalcon\Filter\Validation\Exceptions\InvalidFieldType · Phalcon\Filter\Validation\Exceptions\InvalidFilterService · Phalcon\Filter\Validation\Exceptions\InvalidValidationData · Phalcon\Filter\Validation\Exceptions\InvalidValidator · Phalcon\Filter\Validation\Exceptions\InvalidValidatorScope · Phalcon\Filter\Validation\Exceptions\NoDataToValidate · Phalcon\Filter\Validation\Exceptions\NoValidators · Phalcon\Filter\Validation\Exceptions\ValidationEntityNotObject · Phalcon\Filter\Validation\ValidationInterface · Phalcon\Filter\Validation\ValidatorInterface · Phalcon\Messages\MessageInterface · Phalcon\Messages\Messages

Method Summary

Properties

Methods

__construct()

public function __construct( array $validators = [] );

Phalcon\Filter\Validation constructor

add()

public function add(
    mixed $field,
    ValidatorInterface $validator
): static;

Adds a validator to a field

appendMessage()

public function appendMessage( MessageInterface $message ): static;

Appends a message to the messages list

bind()

public function bind(
    mixed $entity,
    mixed $data,
    array $whitelist = []
): static;

Assigns the data to an entity The entity is used to obtain the validation values

$entity = new Author();
$fields = ['name', 'email', 'imageUrl'];
$validation = new AuthorValidation();
$validation->bind($entity, $_POST, $fields);
$validation->validate();

fails()

public function fails(): bool;

Verify if validation fails by verifying if there are messages in the current validation

getData()

public function getData(): mixed;

getDefaultMessage()

public static function getDefaultMessage( string $validatorClassName ): string;

Returns the default message registered for a validator class, or an empty string when none has been registered.

getEntity()

public function getEntity(): mixed;

Returns the bound entity

getFilters()

public function getFilters( string|null $field = null ): mixed|null;

Returns all the filters or a specific one

getLabel()

public function getLabel( mixed $field ): string;

Get label for field

getMessages()

public function getMessages(): Messages;

Returns the registered validators

getValidators()

public function getValidators(): array;

Returns the validators added to the validation

getValue()

public function getValue( string $field ): mixed|null;

Gets the a value to validate in the array/object data source

getValueByData()

public function getValueByData(
    mixed $data,
    string $field
): mixed|null;

Gets the a value to validate in the array/object data source

getValueByEntity()

public function getValueByEntity(
    mixed $entity,
    string $field
): mixed|null;

Gets the a value to validate in the object entity source

rule()

public function rule(
    mixed $field,
    ValidatorInterface $validator
): static;

Alias of add method

rules()

public function rules(
    mixed $field,
    array $validators
): static;

Adds the validators to a field

setDefaultMessages()

public static function setDefaultMessages( array $messages = [] ): array;

Registers default messages for validators, keyed by validator class name. A registered default is used when a validator does not define its own message; a message set on the validator instance still wins. Calls are merged, so defaults can be registered incrementally.

setEntity()

public function setEntity( mixed $entity ): void;

Sets the bound entity

setFilters()

public function setFilters(
    mixed $field,
    mixed $filters
): static;

Adds filters to the field

setLabels()

public function setLabels( array $labels ): void;

Adds labels for fields

setValidators()

public function setValidators( array $validators ): static;

Sets the validator array

validate()

public function validate(
    mixed $data = null,
    mixed $entity = null,
    array $whitelist = []
): Messages|bool;

Validate a set of data according to a set of rules

You can use $validation->bind(entity, data, whitelist)->validate() When you use bind(), the this->data is already set, so you can reuse it here

// using bind() with $whitelist fields
$entity = new Author();
$fields = ['name', 'email', 'imageUrl'];
$validation = new AuthorValidation();
$validation->bind($entity, $_POST, $fields);
$validation->validate();

// directly using validate
$validation = new AuthorValidation();
$validation->validate($_POST, $entity, $fields);

preChecking()

protected function preChecking(
    mixed $field,
    ValidatorInterface $validator
): bool;

Internal validations, if it returns true, then skip the current validator

Filter\Validation\AbstractCombinedFieldsValidator

This is a base class for combined fields validators

Filter\Validation\AbstractValidator

This is a base class for validators

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\Exceptions\FieldNotPrintable · Phalcon\Messages\Message · Phalcon\Support\Helper\Arr\Whitelist

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Phalcon\Filter\Validation\Validator constructor

getOption()

public function getOption(
    string $key,
    mixed $defaultValue = null
): mixed;

Returns an option in the validator’s options Returns null if the option hasn’t set

getTemplate()

public function getTemplate( string|null $field = null ): string;

Get the template message

getTemplates()

public function getTemplates(): array;

Get templates collection object

hasOption()

public function hasOption( string $key ): bool;

Checks if an option is defined

isAllowEmpty()

public function isAllowEmpty(
    Validation $validation,
    string $field
): bool;

Checks whether the field can be considered empty and therefore skipped, honoring the allowEmpty option (boolean flag, list of empty values, or per-field map).

messageFactory()

public function messageFactory(
    Validation $validation,
    mixed $field,
    array $replacements = []
): Message;

Create a default message by factory

setOption()

public function setOption(
    string $key,
    mixed $value
): void;

Sets an option in the validator

setTemplate()

public function setTemplate( string $template ): ValidatorInterface;

Set a new template message

setTemplates()

public function setTemplates( array $templates ): ValidatorInterface;

Clear current templates and set new from an array,

validate()

abstract public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

allowEmpty()

protected function allowEmpty(
    mixed $field,
    mixed $value
): bool;

Checks if field can be empty.

checkArray()

protected function checkArray(
    mixed $value,
    string $field
): mixed;

Checks if a value is an array and returns the element based on the passed field name

prepareCode()

protected function prepareCode( string $field ): int;

Prepares a validation code.

prepareLabel()

protected function prepareLabel(
    Validation $validation,
    string $field
): mixed;

Prepares a label for the field.

Filter\Validation\AbstractValidatorComposite

This is a base class for combined fields validators

@todo Remove in v7. Kept only for backwards compatibility; compose Phalcon\Filter\Validation\Traits\ValidatorCompositeTrait directly (with extends AbstractValidator implements ValidatorCompositeInterface) instead of extending this.

Uses Phalcon\Filter\Validation\Traits\ValidatorCompositeTrait

Filter\Validation\Exception

Exceptions thrown in Phalcon\Filter\Validation* classes will use this class

Filter\Validation\Exceptions\FieldNotPrintable

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\FilterServiceUnavailable

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidAllowedTypes

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidCallbackReturn

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidDomainOption

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidFieldType

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidFilterService

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidStrictOption

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidValidationData

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidValidator

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\InvalidValidatorScope

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\MissingMbstring

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\NoDataToValidate

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\NoValidators

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\NoValidatorsInComposite

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct( string $className );

Filter\Validation\Exceptions\UniquenessConversionMustBeArray

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\UniquenessModelRequired

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\UniquenessOnlyForPhalconModel

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Exceptions\ValidationEntityNotObject

Uses Phalcon\Filter\Validation\Exception

Method Summary

Methods

__construct()

public function __construct();

Filter\Validation\Traits\ValidatorCompositeTrait

Shared validator collection state and combined validation for composite validators.

Used by Phalcon\Filter\Validation\AbstractValidatorComposite

Method Summary

Properties

Methods

getValidators()

public function getValidators(): array;

validate()

public function validate(
    \Phalcon\Filter\Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\ValidationInterface

Interface for the Phalcon\Filter\Validation component

Uses Phalcon\Di\Injectable · Phalcon\Messages\MessageInterface · Phalcon\Messages\Messages

Method Summary

Methods

add()

public function add(
    mixed $field,
    ValidatorInterface $validator
): ValidationInterface;

Adds a validator to a field

appendMessage()

public function appendMessage( MessageInterface $message ): ValidationInterface;

Appends a message to the messages list

bind()

public function bind(
    mixed $entity,
    mixed $data,
    array $whitelist = []
): ValidationInterface;

Assigns the data to an entity The entity is used to obtain the validation values

getEntity()

public function getEntity(): mixed;

Returns the bound entity

getFilters()

public function getFilters( string|null $field = null ): mixed|null;

Returns all the filters or a specific one

getLabel()

public function getLabel( string $field ): string;

Get label for field

getMessages()

public function getMessages(): Messages;

Returns the registered validators

getValidators()

public function getValidators(): array;

Returns the validators added to the validation

getValue()

public function getValue( string $field ): mixed|null;

Gets the a value to validate in the array/object data source

rule()

public function rule(
    mixed $field,
    ValidatorInterface $validator
): ValidationInterface;

Alias of add method

rules()

public function rules(
    string $field,
    array $validators
): ValidationInterface;

Adds the validators to a field

setFilters()

public function setFilters(
    string $field,
    mixed $filters
): ValidationInterface;

Adds filters to the field

setLabels()

public function setLabels( array $labels ): void;

Adds labels for fields

validate()

public function validate(
    mixed $data = null,
    mixed $entity = null,
    array $whitelist = []
): Messages|bool;

Validate a set of data according to a set of rules

Filter\Validation\ValidatorCompositeInterface

This is a base class for combined fields validators

Uses Phalcon\Filter\Validation

Method Summary

Methods

getValidators()

public function getValidators(): array;

Executes the validation

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\ValidatorFactory

Uses Phalcon\Factory\AbstractFactory · Phalcon\Filter\Validation\Validator\Alnum · Phalcon\Filter\Validation\Validator\Alpha · Phalcon\Filter\Validation\Validator\Between · Phalcon\Filter\Validation\Validator\Callback · Phalcon\Filter\Validation\Validator\Confirmation · Phalcon\Filter\Validation\Validator\CreditCard · Phalcon\Filter\Validation\Validator\Date · Phalcon\Filter\Validation\Validator\Digit · Phalcon\Filter\Validation\Validator\Email · Phalcon\Filter\Validation\Validator\Exception · Phalcon\Filter\Validation\Validator\ExclusionIn · Phalcon\Filter\Validation\Validator\File · Phalcon\Filter\Validation\Validator\Identical · Phalcon\Filter\Validation\Validator\InclusionIn · Phalcon\Filter\Validation\Validator\Ip · Phalcon\Filter\Validation\Validator\Numericality · Phalcon\Filter\Validation\Validator\PresenceOf · Phalcon\Filter\Validation\Validator\Regex · Phalcon\Filter\Validation\Validator\StringLength · Phalcon\Filter\Validation\Validator\Uniqueness · Phalcon\Filter\Validation\Validator\Url

Method Summary

Methods

__construct()

public function __construct( array $services = [] );

TagFactory constructor.

newInstance()

public function newInstance( string $name ): ValidatorInterface;

Creates a new instance

getExceptionClass()

protected function getExceptionClass(): string;

getServices()

protected function getServices(): array;

Returns the available adapters

Filter\Validation\ValidatorInterface

Interface for Phalcon\Filter\Validation\AbstractValidator

Uses Phalcon\Filter\Validation

Method Summary

Methods

getOption()

public function getOption(
    string $key,
    mixed $defaultValue = null
): mixed;

Returns an option in the validator’s options Returns null if the option hasn’t set

getTemplate()

public function getTemplate( string $field ): string;

Get the template message

getTemplates()

public function getTemplates(): array;

Get message templates

hasOption()

public function hasOption( string $key ): bool;

Checks if an option is defined

setTemplate()

public function setTemplate( string $template ): ValidatorInterface;

Set a new template message

setTemplates()

public function setTemplates( array $templates ): ValidatorInterface;

Clear current template and set new from an array,

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Alnum

Check for alphanumeric character(s)

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\Alnum as AlnumValidator;

$validator = new Validation();

$validator->add(
    "username",
    new AlnumValidator(
        [
            "message" => ":field must contain only alphanumeric characters",
        ]
    )
);

$validator->add(
    [
        "username",
        "name",
    ],
    new AlnumValidator(
        [
            "message" => [
                "username" => "username must contain only alphanumeric characters",
                "name"     => "name must contain only alphanumeric characters",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Alpha

Check for alphabetic character(s)

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\Alpha as AlphaValidator;

$validator = new Validation();

$validator->add(
    "username",
    new AlphaValidator(
        [
            "message" => ":field must contain only letters",
        ]
    )
);

$validator->add(
    [
        "username",
        "name",
    ],
    new AlphaValidator(
        [
            "message" => [
                "username" => "username must contain only letters",
                "name"     => "name must contain only letters",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Messages\Message

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Between

Validates that a value is between an inclusive range of two values. For a value x, the test is passed if minimum<=x<=maximum.

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\Between;

$validator = new Validation();

$validator->add(
    "price",
    new Between(
        [
            "minimum" => 0,
            "maximum" => 100,
            "message" => "The price must be between 0 and 100",
        ]
    )
);

$validator->add(
    [
        "price",
        "amount",
    ],
    new Between(
        [
            "minimum" => [
                "price"  => 0,
                "amount" => 0,
            ],
            "maximum" => [
                "price"  => 100,
                "amount" => 50,
            ],
            "message" => [
                "price"  => "The price must be between 0 and 100",
                "amount" => "The amount must be between 0 and 50",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Messages\Message

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Callback

Calls user function for validation

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\Callback as CallbackValidator;
use Phalcon\Filter\Validation\Validator\Numericality as NumericalityValidator;

$validator = new Validation();

$validator->add(
    ["user", "admin"],
    new CallbackValidator(
        [
            "message" => "There must be only an user or admin set",
            "callback" => function($data) {
                if (!empty($data->getUser()) && !empty($data->getAdmin())) {
                    return false;
                }

                return true;
            }
        ]
    )
);

$validator->add(
    "amount",
    new CallbackValidator(
        [
            "callback" => function($data) {
                if (!empty($data->getProduct())) {
                    return new NumericalityValidator(
                        [
                            "message" => "Amount must be a number."
                        ]
                    );
                }
            }
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Filter\Validation\Exceptions\InvalidCallbackReturn · Phalcon\Filter\Validation\ValidatorInterface · Phalcon\Messages\Message · ReflectionFunction

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Confirmation

Checks that two values have the same value

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\Confirmation;

$validator = new Validation();

$validator->add(
    "password",
    new Confirmation(
        [
            "message" => "Password does not match confirmation",
            "with"    => "confirmPassword",
        ]
    )
);

$validator->add(
    [
        "password",
        "email",
    ],
    new Confirmation(
        [
            "message" => [
                "password" => "Password does not match confirmation",
                "email"    => "Email does not match confirmation",
            ],
            "with" => [
                "password" => "confirmPassword",
                "email"    => "confirmEmail",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Filter\Validation\Exception · Phalcon\Filter\Validation\Exceptions\MissingMbstring · Phalcon\Messages\Message · Phalcon\Traits\Php\InfoTrait

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

compare()

final protected function compare(
    string $a,
    string $b
): bool;

Compare strings

Filter\Validation\Validator\CreditCard

Checks if a value has a valid credit card number

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\CreditCard as CreditCardValidator;

$validator = new Validation();

$validator->add(
    "creditCard",
    new CreditCardValidator(
        [
            "message" => "The credit card number is not valid",
        ]
    )
);

$validator->add(
    [
        "creditCard",
        "secondCreditCard",
    ],
    new CreditCardValidator(
        [
            "message" => [
                "creditCard"       => "The credit card number is not valid",
                "secondCreditCard" => "The second credit card number is not valid",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Messages\Message

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Date

Checks if a value is a valid date

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\Date as DateValidator;

$validator = new Validation();

$validator->add(
    "date",
    new DateValidator(
        [
            "format"  => "d-m-Y",
            "message" => "The date is invalid",
        ]
    )
);

$validator->add(
    [
        "date",
        "anotherDate",
    ],
    new DateValidator(
        [
            "format" => [
                "date"        => "d-m-Y",
                "anotherDate" => "Y-m-d",
            ],
            "message" => [
                "date"        => "The date is invalid",
                "anotherDate" => "The another date is invalid",
            ],
        ]
    )
);

Uses DateTime · Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Messages\Message

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Digit

Check for numeric character(s)

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\Digit as DigitValidator;

$validator = new Validation();

$validator->add(
    "height",
    new DigitValidator(
        [
            "message" => ":field must be numeric",
        ]
    )
);

$validator->add(
    [
        "height",
        "width",
    ],
    new DigitValidator(
        [
            "message" => [
                "height" => "height must be numeric",
                "width"  => "width must be numeric",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Messages\Message

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Email

Checks if a value has a correct e-mail format

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\Email as EmailValidator;

$validator = new Validation();

$validator->add(
    "email",
    new EmailValidator(
        [
            "message" => "The e-mail is not valid",
        ]
    )
);

$validator->add(
    [
        "email",
        "anotherEmail",
    ],
    new EmailValidator(
        [
            "message" => [
                "email"        => "The e-mail is not valid",
                "anotherEmail" => "The another e-mail is not valid",
            ],
        ]
    )
);

$validator->add(
    "tä[email protected]",
    new EmailValidator(
        [
            "message" => "The e-mail is not valid",
            "allowUTF8" => true,
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Messages\Message

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\Exception

Exceptions thrown in Phalcon\Filter\Validation\Validator* classes will use this class

Filter\Validation\Validator\ExclusionIn

Check if a value is not included into a list of values

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\ExclusionIn;

$validator = new Validation();

$validator->add(
    "status",
    new ExclusionIn(
        [
            "message" => "The status must not be A or B",
            "domain"  => [
                "A",
                "B",
            ],
        ]
    )
);

$validator->add(
    [
        "status",
        "type",
    ],
    new ExclusionIn(
        [
            "message" => [
                "status" => "The status must not be A or B",
                "type"   => "The type must not be 1 or "
            ],
            "domain" => [
                "status" => [
                    "A",
                    "B",
                ],
                "type"   => [1, 2],
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Filter\Validation\Exception · Phalcon\Filter\Validation\Exceptions\InvalidDomainOption · Phalcon\Filter\Validation\Exceptions\InvalidStrictOption · Phalcon\Messages\Message

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\File

Checks if a value has a correct file

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\File as FileValidator;

$validator = new Validation();

$validator->add(
    "file",
    new FileValidator(
        [
            "maxSize"              => "2M",
            "messageSize"          => ":field exceeds the max file size (:size)",
            "allowedTypes"         => [
                "image/jpeg",
                "image/png",
            ],
            "messageType"          => "Allowed file types are :types",
            "maxResolution"        => "800x600",
            "messageMaxResolution" => "Max resolution of :field is :resolution",
            "messageFileEmpty"     => "File is empty",
            "messageIniSize"       => "Ini size is not valid",
            "messageValid"         => "File is not valid",
        ]
    )
);

$validator->add(
    [
        "file",
        "anotherFile",
    ],
    new FileValidator(
        [
            "maxSize" => [
                "file"        => "2M",
                "anotherFile" => "4M",
            ],
            "messageSize" => [
                "file"        => "file exceeds the max file size 2M",
                "anotherFile" => "anotherFile exceeds the max file size 4M",
            "allowedTypes" => [
                "file"        => [
                    "image/jpeg",
                    "image/png",
                ],
                "anotherFile" => [
                    "image/gif",
                    "image/bmp",
                ],
            ],
            "messageType" => [
                "file"        => "Allowed file types are image/jpeg and image/png",
                "anotherFile" => "Allowed file types are image/gif and image/bmp",
            ],
            "maxResolution" => [
                "file"        => "800x600",
                "anotherFile" => "1024x768",
            ],
            "messageMaxResolution" => [
                "file"        => "Max resolution of file is 800x600",
                "anotherFile" => "Max resolution of file is 1024x768",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidatorComposite · Phalcon\Filter\Validation\Validator\File\MimeType · Phalcon\Filter\Validation\Validator\File\Resolution\AspectRatio · Phalcon\Filter\Validation\Validator\File\Resolution\Equal · Phalcon\Filter\Validation\Validator\File\Resolution\Max · Phalcon\Filter\Validation\Validator\File\Resolution\Min · Phalcon\Filter\Validation\Validator\File\Size\Equal · Phalcon\Filter\Validation\Validator\File\Size\Max · Phalcon\Filter\Validation\Validator\File\Size\Min · Phalcon\Messages\Message · Phalcon\Traits\Support\Helper\Arr\GetTrait

Method Summary

Methods

__construct()

public function __construct( array $options = [] );

Constructor

Filter\Validation\Validator\File\AbstractFile

Checks if a value has a correct file

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\File\Size;

$validator = new Validation();

$validator->add(
    "file",
    new Size(
        [
            "maxSize"              => "2M",
            "messageSize"          => ":field exceeds the max file size (:size)",
        ]
    )
);

$validator->add(
    [
        "file",
        "anotherFile",
    ],
    new FileValidator(
        [
            "maxSize" => [
                "file"        => "2M",
                "anotherFile" => "4M",
            ],
            "messageSize" => [
                "file"        => "file exceeds the max file size 2M",
                "anotherFile" => "anotherFile exceeds the max file size 4M",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\AbstractValidator · Phalcon\Messages\Message

Method Summary

Properties

Methods

checkUpload()

public function checkUpload(
    Validation $validation,
    string $field
): bool;

Check upload

checkUploadIsEmpty()

public function checkUploadIsEmpty(
    Validation $validation,
    string $field
): bool;

Check if upload is empty

checkUploadIsValid()

public function checkUploadIsValid(
    Validation $validation,
    string $field
): bool;

Check if upload is valid

checkUploadMaxSize()

public function checkUploadMaxSize(
    Validation $validation,
    string $field
): bool;

Check if uploaded file is larger than PHP allowed size

getFileSizeInBytes()

public function getFileSizeInBytes( string $size ): float;

Convert a string like “2.5MB” in bytes

getMessageFileEmpty()

public function getMessageFileEmpty(): string;

Empty is empty

getMessageIniSize()

public function getMessageIniSize(): string;

File exceeds the file size set in PHP configuration

getMessageValid()

public function getMessageValid(): string;

File is not valid

isAllowEmpty()

public function isAllowEmpty(
    Validation $validation,
    string $field
): bool;

Check on empty

setMessageFileEmpty()

public function setMessageFileEmpty( string $message ): void;

Empty is empty

setMessageIniSize()

public function setMessageIniSize( string $message ): void;

File exceeds the file size set in PHP configuration

setMessageValid()

public function setMessageValid( string $message ): void;

File is not valid

checkIsUploadedFile()

protected function checkIsUploadedFile( string $name ): bool;

Checks if a file has been uploaded; Internal check that can be overridden in a subclass if you do not want to check uploaded files

Filter\Validation\Validator\File\MimeType

Checks if a value has a correct file mime type

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\File\MimeType;

$validator = new Validation();

$validator->add(
    "file",
    new MimeType(
        [
            "types" => [
                "image/jpeg",
                "image/png",
            ],
            "message" => "Allowed file types are :types"
        ]
    )
);

$validator->add(
    [
        "file",
        "anotherFile",
    ],
    new MimeType(
        [
            "types" => [
                "file"        => [
                    "image/jpeg",
                    "image/png",
                ],
                "anotherFile" => [
                    "image/gif",
                    "image/bmp",
                ],
            ],
            "message" => [
                "file"        => "Allowed file types are image/jpeg and image/png",
                "anotherFile" => "Allowed file types are image/gif and image/bmp",
            ]
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\Exception · Phalcon\Filter\Validation\Exceptions\InvalidAllowedTypes · Phalcon\Messages\Message · Phalcon\Traits\Php\InfoTrait

Method Summary

Properties

Methods

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\File\Resolution\AspectRatio

Checks if a file has the exact aspect ratio

The ratio is compared with integer cross-multiplication, so the image dimensions must match the ratio exactly: 1920x1080 matches “16x9”, 1366x768 does not.

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\File\Resolution\AspectRatio;

$validator = new Validation();

$validator->add(
    "file",
    new AspectRatio(
        [
            "ratio"   => "16x9",
            "message" => "The aspect ratio of the field :field has to be :ratio",
        ]
    )
);

$validator->add(
    [
        "file",
        "anotherFile",
    ],
    new AspectRatio(
        [
            "ratio" => [
                "file"        => "16x9",
                "anotherFile" => "4x3",
            ],
            "message" => [
                "file"        => "Aspect ratio of file has to be 16x9",
                "anotherFile" => "Aspect ratio of anotherFile has to be 4x3",
            ],
        ]
    )
);

Uses Phalcon\Filter\Validation · Phalcon\Filter\Validation\Validator\File\AbstractFile

Method Summary

Properties

Methods

__construct()

public function __construct( array $options = [] );

Constructor

validate()

public function validate(
    Validation $validation,
    mixed $field
): bool;

Executes the validation

Filter\Validation\Validator\File\Resolution\Equal

Checks if a file has the right resolution

use Phalcon\Filter\Validation;
use Phalcon\Filter\Validation\Validator\File\Resolution\Equal;

$validator = new Validation();

$validator->add(
    "file",
    new Equal(
        [
            "resolution" => "800x600",
            "message"    => "The resolution of the field :field has to be equal :resolution",
        ]
    )
);

$validator->add(
    [
        "file",
        "anotherFile",
    ],
    new Equal(
        [
            "resolution" => [
                "file"        => "800x600",
                "anotherFile" => "1024x768",
            ],
            "message" => [
                "file"        => "Equal resolution of file has to be 800x600",
                "anotherFile" => "Equal resolution of file has to be 1024x768",
            ],
        ]
    )
);