NotEmptyValidator extends AbstractValidator

FinalYes

Validator for not empty values.

Table of Contents

Properties

$acceptsEmptyValues  : bool
This validator always needs to be executed even if the given value is empty.
$emptyMessage  : string
$nullMessage  : string
$options  : array<string|int, mixed>
$request  : ServerRequestInterface|null
$result  : Result
$supportedOptions  : array<string|int, mixed>
This contains the supported options, their default values, types and descriptions.
$translationOptions  : array<string|int, mixed>
Contains an array of property names used for translation handling of error messages.

Methods

getOptions()  : array<string|int, mixed>
Returns the options of this validator
getRequest()  : ServerRequestInterface|null
isValid()  : void
Checks if the given value ($propertyValue) is not empty (NULL, empty string, empty array or empty object).
setOptions()  : void
Receive validator options from framework.
setRequest()  : void
validate()  : Result
Checks if the given value is valid according to the validator, and returns the error messages object which occurred.
addError()  : void
Creates a new validation error object and adds it to $this->result
addErrorForProperty()  : void
Creates a new validation error object for a property and adds it to the proper sub result of $this->result
ensureFileUploadTypes()  : void
Ensures that the provided value is either an instance of UploadedFile or an ObjectStorage containing only UploadedFile instances.
initializeDefaultOptions()  : void
Initialize default options.
initializeTranslationOptions()  : void
Initializes all registered translation options with custom translation options from the given options array
isEmpty()  : bool
TRUE if the given $value is NULL or an empty string ('')
translateErrorMessage()  : string
Translates an error message using LocalizationUtility::translate() method. If the translate key does not start with 'LLL:', the original translate key is returned.

Properties

$acceptsEmptyValues

This validator always needs to be executed even if the given value is empty.

protected bool $acceptsEmptyValues = false

See AbstractValidator::validate()

$emptyMessage

protected string $emptyMessage = 'LLL:EXT:extbase/Resources/Private/Language/locallang.xlf:validator.notempty.empty'

$nullMessage

protected string $nullMessage = 'LLL:EXT:extbase/Resources/Private/Language/locallang.xlf:validator.notempty.null'

$options

protected array<string|int, mixed> $options = []

$request

protected ServerRequestInterface|null $request = null

$supportedOptions

This contains the supported options, their default values, types and descriptions.

protected array<string|int, mixed> $supportedOptions = ['nullMessage' => [null, 'Translation key or message for null value', 'string'], 'emptyMessage' => [null, 'Translation key or message for empty value', 'string']]

$translationOptions

Contains an array of property names used for translation handling of error messages.

protected array<string|int, mixed> $translationOptions = ['nullMessage', 'emptyMessage']

Methods

getOptions()

Returns the options of this validator

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRequest()

public getRequest() : ServerRequestInterface|null
Tags
todo:

Add to ValidatorInterface in TYPO3 v14

Return values
ServerRequestInterface|null

isValid()

Checks if the given value ($propertyValue) is not empty (NULL, empty string, empty array or empty object).

public isValid(mixed $value) : void
Parameters
$value : mixed

setOptions()

Receive validator options from framework.

public setOptions(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>

setRequest()

public setRequest(ServerRequestInterface|null $request) : void
Parameters
$request : ServerRequestInterface|null
Tags
todo:

Add to ValidatorInterface in TYPO3 v14

validate()

Checks if the given value is valid according to the validator, and returns the error messages object which occurred.

public validate(mixed $value) : Result
Parameters
$value : mixed

The value that should be validated

Return values
Result

addError()

Creates a new validation error object and adds it to $this->result

protected addError(string $message, int $code[, array<string|int, mixed> $arguments = [] ][, string $title = '' ]) : void
Parameters
$message : string

The error message

$code : int

The error code (a unix timestamp)

$arguments : array<string|int, mixed> = []

Arguments to be replaced in message

$title : string = ''

title of the error

addErrorForProperty()

Creates a new validation error object for a property and adds it to the proper sub result of $this->result

protected addErrorForProperty(string|array<string|int, mixed> $propertyPath, string $message, int $code[, array<string|int, mixed> $arguments = [] ][, string $title = '' ]) : void
Parameters
$propertyPath : string|array<string|int, mixed>

The property path (string or array)

$message : string

The error message

$code : int

The error code (a unix timestamp)

$arguments : array<string|int, mixed> = []

Arguments to be replaced in message

$title : string = ''

Title of the error

ensureFileUploadTypes()

Ensures that the provided value is either an instance of UploadedFile or an ObjectStorage containing only UploadedFile instances.

protected ensureFileUploadTypes(mixed $value) : void
Parameters
$value : mixed

initializeDefaultOptions()

Initialize default options.

protected initializeDefaultOptions(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>
Tags
throws
InvalidValidationOptionsException

initializeTranslationOptions()

Initializes all registered translation options with custom translation options from the given options array

protected initializeTranslationOptions(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>

isEmpty()

TRUE if the given $value is NULL or an empty string ('')

protected final isEmpty(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

translateErrorMessage()

Translates an error message using LocalizationUtility::translate() method. If the translate key does not start with 'LLL:', the original translate key is returned.

protected translateErrorMessage(string $translateKey[, string $extensionName = '' ][, array<string|int, mixed> $arguments = [] ]) : string
Parameters
$translateKey : string
$extensionName : string = ''
$arguments : array<string|int, mixed> = []
Return values
string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results