StringLength Class Reference

Public Member Functions
	__construct ($options=[])
	Sets validator options.
	getMin ()
	Returns the min option.
	setMin ($min)
	Sets the min option.
	getMax ()
	Returns the max option.
	setMax ($max)
	Sets the max option.
	getStringWrapper ()
	Get the string wrapper to detect the string length.
	setStringWrapper (StringWrapper $stringWrapper)
	Set the string wrapper to detect the string length.
	getEncoding ()
	Returns the actual encoding.
	setEncoding ($encoding)
	Sets a new encoding to use.
	isValid ($value)
	Returns true if and only if the string length of $value is at least the min option and no greater than the max option (when the max option is not null).
Public Member Functions inherited from AbstractValidator
	__construct ($options=null)
	Abstract constructor for all validators A validator should accept following parameters:
	getOption ($option)
	Returns an option.
	getOptions ()
	Returns all available options.
	setOptions ($options=[])
	Sets one or multiple options.
	getMessages ()
	Returns array of validation failure messages.
	__invoke ($value)
	Invoke as command.
	getMessageVariables ()
	Returns an array of the names of variables that are used in constructing validation failure messages.
	getMessageTemplates ()
	Returns the message templates from the validator.
	setMessage ($messageString, $messageKey=null)
	Sets the validation failure message template for a particular key.
	setMessages (array $messages)
	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.
	__get ($property)
	Magic function returns the value of the requested property, if and only if it is the value or a message variable.
	setValueObscured ($flag)
	Set flag indicating whether or not value should be obfuscated in messages.
	isValueObscured ()
	Retrieve flag indicating whether or not value should be obfuscated in messages.
	setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set translation object.
	getTranslator ()
	Return translation object.
	hasTranslator ()
	Does this validator have its own specific translator?
	setTranslatorTextDomain ($textDomain= 'default')
	Set translation text domain.
	getTranslatorTextDomain ()
	Return the translation text domain.
	setTranslatorEnabled ($flag=true)
	Indicate whether or not translation should be enabled.
	isTranslatorEnabled ()
	Is translation enabled?
Public Member Functions inherited from TranslatorAwareInterface
	setTranslator (TranslatorInterface $translator=null, $textDomain=null)
	Sets translator to use in helper.

Public Attributes
const	INVALID = 'stringLengthInvalid'
const	TOO_SHORT = 'stringLengthTooShort'
const	TOO_LONG = 'stringLengthTooLong'

Protected Attributes
	$messageTemplates
	$messageVariables
	$options
	$stringWrapper
Protected Attributes inherited from AbstractValidator
	$value
	$abstractOptions

Additional Inherited Members
Static Public Member Functions inherited from AbstractValidator
static	setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
	Set default translation object for all validate objects.
static	getDefaultTranslator ()
	Get default translation object for all validate objects.
static	hasDefaultTranslator ()
	Is there a default translation object set?
static	setDefaultTranslatorTextDomain ($textDomain= 'default')
	Set default translation text domain for all validate objects.
static	getDefaultTranslatorTextDomain ()
	Get default translation text domain for all validate objects.
static	getMessageLength ()
	Returns the maximum allowed message length.
static	setMessageLength ($length=-1)
	Sets the maximum allowed message length.
Protected Member Functions inherited from AbstractValidator
	createMessage ($messageKey, $value)
	Constructs and returns a validation failure message with the given message key and value.
	error ($messageKey, $value=null)
	getValue ()
	Returns the validation value.
	setValue ($value)
	Sets the value to be validated and clears the messages and errors arrays.
	translateMessage ($messageKey, $message)
	Translate a validation message.
Static Protected Attributes inherited from AbstractValidator
static	$defaultTranslator
static	$defaultTranslatorTextDomain = 'default'
static	$messageLength = -1

Constructor & Destructor Documentation

__construct

(

$options = []

)

Sets validator options.

Parameters

int | array | \Traversable

$options

Member Function Documentation

getEncoding

(

)

Returns the actual encoding.

Returns

string

getMax

(

)

Returns the max option.

Returns

int|null

getMin

(

)

Returns the min option.

Returns

int

getStringWrapper

(

)

Get the string wrapper to detect the string length.

Returns

StringWrapper

isValid

(

$value

)

Returns true if and only if the string length of $value is at least the min option and no greater than the max option (when the max option is not null).

Parameters

string

$value

Returns

bool

Implements ValidatorInterface.

setEncoding

(

$encoding

)

Sets a new encoding to use.

Parameters

string

$encoding

Returns

StringLength

Exceptions

Exception\InvalidArgumentException

setMax

(

$max

)

Sets the max option.

Parameters

int | null

$max

Exceptions

Exception\InvalidArgumentException

Returns

StringLength Provides a fluent interface

setMin

(

$min

)

Sets the min option.

Parameters

int

$min

Exceptions

Exception\InvalidArgumentException

Returns

StringLength Provides a fluent interface

setStringWrapper

(

StringWrapper

$stringWrapper

)

Set the string wrapper to detect the string length.

Parameters

StringWrapper

$stringWrapper

Returns

StringLength

Member Data Documentation

$messageTemplates

protected

Initial value:

= [
        self::INVALID   => "Invalid type given. String expected"

$messageVariables

protected

Initial value:

= [
        'min' => ['options' => 'min'],
        'max' => ['options' => 'max'],
    ]

$options

protected

Initial value:

= [
        'min'      => 0

$stringWrapper

protected

Initial value:

=> null,    
        'encoding' => 'UTF-8', 
    ]

const INVALID = 'stringLengthInvalid'

const TOO_LONG = 'stringLengthTooLong'

const TOO_SHORT = 'stringLengthTooShort'