HumHub Documentation (unofficial)

NotEmpty extends AbstractValidator
in package

Application

Constants

ALL = 0b11111111111
BOOLEAN = 0b1
EMPTY_ARRAY = 0b100000
FLOAT = 0b100
INTEGER = 0b10
INVALID = 'notEmptyInvalid'
IS_EMPTY = 'isEmpty'
NULL = 0b1000000
OBJECT = 0b100000000
OBJECT_COUNT = 0b10000000000
OBJECT_STRING = 0b1000000000
PHP = 0b1111111
SPACE = 0b10000000
STRING = 0b1000
ZERO = 0b10000

Properties

$messageTemplates : array<string, string>
$messageVariables : array<string, mixed>
$options : array<string, mixed>
$abstractOptions : AbstractOptions|array<string, mixed>
$constants : array<int, string>
$defaultTranslator : TranslatorInterface: Default translation object for all validate objects
$defaultTranslatorTextDomain : string: Default text domain to be used with translator
$defaultType : array<string|int, mixed>: Default value for types; value = 0b000111101001
$messageLength : int: Limits the maximum returned length of an error message
$messageTemplates : array<string|int, mixed>
$options : array<string|int, mixed>: Options for this validator
$value : mixed: The value to be validated

Methods

__construct() : mixed: Constructor
__get() : mixed: Magic function returns the value of the requested property, if and only if it is the value or a message variable.
__invoke() : bool: Invoke as command
getDefaultTranslator() : TranslatorInterface|null: Get default translation object for all validate objects
getDefaultTranslatorTextDomain() : string: Get default translation text domain for all validate objects
getDefaultType() : false|int|string
getMessageLength() : int: Returns the maximum allowed message length
getMessages() : array<string, string>: Returns array of validation failure messages
getMessageTemplates() : array<string, string>: Returns the message templates from the validator
getMessageVariables() : array<int, string>: Returns an array of the names of variables that are used in constructing validation failure messages
getOption() : mixed: Returns an option
getOptions() : array<string, mixed>: Returns all available options
getTranslator() : TranslatorInterface|null: Return translation object
getTranslatorTextDomain() : string: Return the translation text domain
getType() : int: Returns the set types
hasDefaultTranslator() : bool: Is there a default translation object set?
hasTranslator() : bool: Does this validator have its own specific translator?
isTranslatorEnabled() : bool: Is translation enabled?
isValid() : bool: Returns true if and only if $value is not an empty value.
isValueObscured() : bool: Retrieve flag indicating whether or not value should be obfuscated in messages
setDefaultTranslator() : void: Set default translation object for all validate objects
setDefaultTranslatorTextDomain() : void: Set default translation text domain for all validate objects
setMessage() : $this: Sets the validation failure message template for a particular key
setMessageLength() : void: Sets the maximum allowed message length
setMessages() : $this: Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.
setOptions() : $this: Sets one or multiple options
setTranslator() : $this: Set translation object
setTranslatorEnabled() : $this: Indicate whether or not translation should be enabled
setTranslatorTextDomain() : $this: Set translation text domain
setType() : $this: Set the types
setValueObscured() : $this: Set flag indicating whether or not value should be obfuscated in messages
calculateTypeValue() : false|int|string
createMessage() : null|string: Constructs and returns a validation failure message with the given message key and value.
error() : void
getValue() : mixed: Returns the validation value
setValue() : void: Sets the value to be validated and clears the messages and errors arrays
translateMessage() : string: Translate a validation message

ALL


    public
        mixed
    ALL
    = 0b11111111111

BOOLEAN


    public
        mixed
    BOOLEAN
    = 0b1

EMPTY_ARRAY


    public
        mixed
    EMPTY_ARRAY
    = 0b100000

FLOAT


    public
        mixed
    FLOAT
    = 0b100

INTEGER


    public
        mixed
    INTEGER
    = 0b10

INVALID


    public
        mixed
    INVALID
    = 'notEmptyInvalid'

IS_EMPTY


    public
        mixed
    IS_EMPTY
    = 'isEmpty'

NULL


    public
        mixed
    NULL
    = 0b1000000

OBJECT


    public
        mixed
    OBJECT
    = 0b100000000

OBJECT_COUNT


    public
        mixed
    OBJECT_COUNT
    = 0b10000000000

OBJECT_STRING


    public
        mixed
    OBJECT_STRING
    = 0b1000000000

PHP


    public
        mixed
    PHP
    = 0b1111111

SPACE


    public
        mixed
    SPACE
    = 0b10000000

STRING


    public
        mixed
    STRING
    = 0b1000

ZERO


    public
        mixed
    ZERO
    = 0b10000

$messageTemplates


    public
        array<string, string>
    $messageTemplates

$messageVariables


    public
        array<string, mixed>
    $messageVariables

$options


    public
        array<string, mixed>
    $options

$abstractOptions


    protected
        AbstractOptions|array<string, mixed>
    $abstractOptions
     = [
    'messages' => [],
    // Array of validation failure messages
    'messageTemplates' => [],
    // Array of validation failure message templates
    'messageVariables' => [],
    // Array of additional variables available for validation failure messages
    'translator' => null,
    // Translation object to used -> Translator\TranslatorInterface
    'translatorTextDomain' => null,
    // Translation text domain
    'translatorEnabled' => true,
    // Is translation enabled?
    'valueObscured' => false,
]

$constants


    protected
        array<int, string>
    $constants
     = [self::BOOLEAN => 'boolean', self::INTEGER => 'integer', self::FLOAT => 'float', self::STRING => 'string', self::ZERO => 'zero', self::EMPTY_ARRAY => 'array', self::NULL => 'null', self::PHP => 'php', self::SPACE => 'space', self::OBJECT => 'object', self::OBJECT_STRING => 'objectstring', self::OBJECT_COUNT => 'objectcount', self::ALL => 'all']

$defaultTranslator

Default translation object for all validate objects


    protected
    static    TranslatorInterface
    $defaultTranslator

$defaultTranslatorTextDomain

Default text domain to be used with translator


    protected
    static    string
    $defaultTranslatorTextDomain
     = 'default'

$defaultType

Default value for types; value = 0b000111101001


    protected
        array<string|int, mixed>
    $defaultType
     = [self::OBJECT, self::SPACE, self::NULL, self::EMPTY_ARRAY, self::STRING, self::BOOLEAN]

$messageLength

Limits the maximum returned length of an error message


    protected
    static    int
    $messageLength
     = -1

$messageTemplates


    protected
        array<string|int, mixed>
    $messageTemplates
     = [self::IS_EMPTY => "Value is required and can't be empty", self::INVALID => 'Invalid type given. String, integer, float, boolean or array expected']

$options

Options for this validator


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

$value

The value to be validated


    protected
        mixed
    $value

__construct()

Constructor


    public
                    __construct([array<string|int, mixed>|Traversable|int $options = null ]) : mixed

Parameters

$options : array<string|int, mixed>|Traversable|int = null: OPTIONAL

__get()

Magic function returns the value of the requested property, if and only if it is the value or a message variable.


    public
                    __get(string $property) : mixed

Parameters

$property : string

__invoke()

Invoke as command


    public
                    __invoke(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

getDefaultTranslator()

Get default translation object for all validate objects


    public
            static        getDefaultTranslator() : TranslatorInterface|null

Return values

TranslatorInterface|null

getDefaultTranslatorTextDomain()

Get default translation text domain for all validate objects


    public
            static        getDefaultTranslatorTextDomain() : string

Return values

string

getDefaultType()


    public
                    getDefaultType() : false|int|string

Return values

false|int|string

getMessageLength()

Returns the maximum allowed message length


    public
            static        getMessageLength() : int

Return values

int

getMessages()

Returns array of validation failure messages


    public
                    getMessages() : array<string, string>

Return values

array<string, string>

getMessageTemplates()

Returns the message templates from the validator


    public
                    getMessageTemplates() : array<string, string>

Return values

array<string, string>

getMessageVariables()

Returns an array of the names of variables that are used in constructing validation failure messages


    public
                    getMessageVariables() : array<int, string>

Return values

array<int, string>

getOption()

Returns an option


    public
                    getOption(string $option) : mixed

Parameters

$option : string: Option to be returned

Return values

mixed —

Returned option

getOptions()

Returns all available options


    public
                    getOptions() : array<string, mixed>

Return values

array<string, mixed> —

Array with all available options

getTranslator()

Return translation object


    public
                    getTranslator() : TranslatorInterface|null

Return values

TranslatorInterface|null

getTranslatorTextDomain()

Return the translation text domain


    public
                    getTranslatorTextDomain() : string

Return values

string

getType()

Returns the set types


    public
                    getType() : int

Return values

int

hasDefaultTranslator()

Is there a default translation object set?


    public
            static        hasDefaultTranslator() : bool

Return values

bool

hasTranslator()

Does this validator have its own specific translator?


    public
                    hasTranslator() : bool

Return values

bool

isTranslatorEnabled()

Is translation enabled?


    public
                    isTranslatorEnabled() : bool

Return values

bool

isValid()

Returns true if and only if $value is not an empty value.


    public
                    isValid(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

isValueObscured()

Retrieve flag indicating whether or not value should be obfuscated in messages


    public
                    isValueObscured() : bool

Return values

bool

setDefaultTranslator()

Set default translation object for all validate objects


    public
            static        setDefaultTranslator([TranslatorInterface|null $translator = null ][, string $textDomain = null ]) : void

Parameters

$translator : TranslatorInterface|null = null
$textDomain : string = null: (optional)

setDefaultTranslatorTextDomain()

Set default translation text domain for all validate objects


    public
            static        setDefaultTranslatorTextDomain([string $textDomain = 'default' ]) : void

Parameters

$textDomain : string = 'default'

setMessage()

Sets the validation failure message template for a particular key


    public
                    setMessage(string $messageString[, string|null $messageKey = null ]) : $this

Parameters

$messageString : string
$messageKey : string|null = null: OPTIONAL

Return values

$this —

Provides a fluent interface

setMessageLength()

Sets the maximum allowed message length


    public
            static        setMessageLength([int $length = -1 ]) : void

Parameters

$length : int = -1

setMessages()

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.


    public
                    setMessages(array<string, string> $messages) : $this

Parameters

$messages : array<string, string>

Return values

$this

setOptions()

Sets one or multiple options


    public
                    setOptions([array<string, mixed>|Traversable<string, mixed> $options = [] ]) : $this

Parameters

$options : array<string, mixed>|Traversable<string, mixed> = []: Options to set

Return values

$this —

Provides fluid interface

setTranslator()

Set translation object


    public
                    setTranslator([TranslatorInterface|null $translator = null ][, string $textDomain = null ]) : $this

Parameters

$translator : TranslatorInterface|null = null: [optional] translator. Default is null, which sets no translator.
$textDomain : string = null: (optional)

Return values

$this

setTranslatorEnabled()

Indicate whether or not translation should be enabled


    public
                    setTranslatorEnabled([bool $enabled = true ]) : $this

Parameters

$enabled : bool = true

Return values

$this

setTranslatorTextDomain()

Set translation text domain


    public
                    setTranslatorTextDomain([string $textDomain = 'default' ]) : $this

Parameters

$textDomain : string = 'default'

Return values

$this

setType()

Set the types


    public
                    setType([int|array<string|int, int> $type = null ]) : $this

Parameters

$type : int|array<string|int, int> = null

Return values

$this

setValueObscured()

Set flag indicating whether or not value should be obfuscated in messages


    public
                    setValueObscured(bool $flag) : $this

Parameters

$flag : bool

Return values

$this

calculateTypeValue()


    protected
                    calculateTypeValue(array<string|int, mixed>|int|string $type) : false|int|string

Parameters

$type : array<string|int, mixed>|int|string

Return values

false|int|string

createMessage()

Constructs and returns a validation failure message with the given message key and value.


    protected
                    createMessage(string $messageKey, string|array<string|int, mixed>|object $value) : null|string

Returns null if and only if $messageKey does not correspond to an existing template.

If a translator is available and a translation exists for $messageKey, the translation will be used.

Parameters

$messageKey : string
$value : string|array<string|int, mixed>|object

Return values

null|string

error()


    protected
                    error(string|null $messageKey[, null|string|array<string|int, mixed>|object $value = null ]) : void

Parameters

$messageKey : string|null
$value : null|string|array<string|int, mixed>|object = null: OPTIONAL

getValue()

Returns the validation value


    protected
                    getValue() : mixed

Return values

mixed —

Value to be validated

setValue()

Sets the value to be validated and clears the messages and errors arrays


    protected
                    setValue(mixed $value) : void

Parameters

$value : mixed

translateMessage()

Translate a validation message


    protected
                    translateMessage(string $messageKey, string $message) : string

Parameters

$messageKey : string
$message : string

Return values

string

NotEmpty extends AbstractValidator in package Application

Table of Contents

Constants

Properties

Methods

Constants

ALL

BOOLEAN

EMPTY_ARRAY

FLOAT

INTEGER

INVALID

IS_EMPTY

NULL

OBJECT

OBJECT_COUNT

OBJECT_STRING

PHP

SPACE

STRING

ZERO

Properties

$messageTemplates

$messageVariables

$options

$abstractOptions

$constants

$defaultTranslator

$defaultTranslatorTextDomain

$defaultType

$messageLength

$messageTemplates

$options

$value

Methods

__construct()

Parameters

__get()

Parameters

Tags

__invoke()

Parameters

Return values

getDefaultTranslator()

Return values

getDefaultTranslatorTextDomain()

Return values

getDefaultType()

Return values

getMessageLength()

Return values

getMessages()

Return values

getMessageTemplates()

Return values

getMessageVariables()

Return values

getOption()

Parameters

Tags

Return values

getOptions()

Return values

getTranslator()

Return values

getTranslatorTextDomain()

Return values

getType()

Return values

hasDefaultTranslator()

Return values

hasTranslator()

Return values

NotEmpty extends AbstractValidator
in package

Application