Validator for counting all words in a file

category Zend
package Zend_Validator

 Methods

Sets validator options

__construct(integer | array | \Traversable $options) 
Inherited

Min limits the file count, when used with max=null it is the maximum file count It also accepts an array with the keys 'min' and 'max'

If $options is a integer, it will be used as maximum file count As Array is accepts the following keys: 'min': Minimum filecount 'max': Maximum filecount

inherited_from \Zend\Validator\File\Count::__construct()

Parameters

$options

integerarray\Traversable

Options for the adapter

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

__get(string $property) : mixed
Inherited

inherited_from \Zend\Validator\AbstractValidator::__get()
inherited_from \Zend\Validator\File\Count::__get()

Parameters

$property

string

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Returns

mixed

Invoke as command

__invoke(mixed $value) : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::__invoke()
inherited_from \Zend\Validator\File\Count::__invoke()

Parameters

$value

mixed

Returns

bool

Adds a file for validation

addFile(string | array $file) : \Zend\Validator\File\Count
Inherited

inherited_from \Zend\Validator\File\Count::addFile()

Parameters

$file

stringarray

Returns

Get default translation object for all validate objects

getDefaultTranslator() : \Zend\I18n\Translator\Translator | null
Inherited

inherited_from \Zend\Validator\AbstractValidator::getDefaultTranslator()
inherited_from \Zend\Validator\File\Count::getDefaultTranslator()

Returns

Get default translation text domain for all validate objects

getDefaultTranslatorTextDomain() : string
Inherited

inherited_from \Zend\Validator\AbstractValidator::getDefaultTranslatorTextDomain()
inherited_from \Zend\Validator\File\Count::getDefaultTranslatorTextDomain()

Returns

string

Returns the maximum file count

getMax() : integer
Inherited

inherited_from \Zend\Validator\File\Count::getMax()

Returns

integer

Returns the maximum allowed message length

getMessageLength() : integer
Inherited

inherited_from \Zend\Validator\AbstractValidator::getMessageLength()
inherited_from \Zend\Validator\File\Count::getMessageLength()

Returns

integer

Returns the message templates from the validator

getMessageTemplates() : array
Inherited

inherited_from \Zend\Validator\AbstractValidator::getMessageTemplates()
inherited_from \Zend\Validator\File\Count::getMessageTemplates()

Returns

array

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

getMessageVariables() : array
Inherited

inherited_from \Zend\Validator\AbstractValidator::getMessageVariables()
inherited_from \Zend\Validator\File\Count::getMessageVariables()

Returns

array

Returns array of validation failure messages

getMessages() : array
Inherited

The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

inherited_from \Zend\Validator\AbstractValidator::getMessages()
inherited_from \Zend\Validator\File\Count::getMessages()

Returns

array

Returns the minimum file count

getMin() : integer
Inherited

inherited_from \Zend\Validator\File\Count::getMin()

Returns

integer

Returns an option

getOption(string $option) : mixed
Inherited

inherited_from \Zend\Validator\AbstractValidator::getOption()
inherited_from \Zend\Validator\File\Count::getOption()

Parameters

$option

string

Option to be returned

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Returns

mixedReturned option

Returns all available options

getOptions() : array
Inherited

inherited_from \Zend\Validator\AbstractValidator::getOptions()
inherited_from \Zend\Validator\File\Count::getOptions()

Returns

arrayArray with all available options

Return translation object

getTranslator() : \Zend\I18n\Translator\Translator | null
Inherited

inherited_from \Zend\Validator\AbstractValidator::getTranslator()
inherited_from \Zend\Validator\File\Count::getTranslator()

Returns

Return the translation text domain

getTranslatorTextDomain() : string
Inherited

inherited_from \Zend\Validator\AbstractValidator::getTranslatorTextDomain()
inherited_from \Zend\Validator\File\Count::getTranslatorTextDomain()

Returns

string

Is there a default translation object set?

hasDefaultTranslator() : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::hasDefaultTranslator()
inherited_from \Zend\Validator\File\Count::hasDefaultTranslator()

Returns

bool

Does this validator have its own specific translator?

hasTranslator() : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::hasTranslator()
inherited_from \Zend\Validator\File\Count::hasTranslator()

Returns

bool

Is translation enabled?

isTranslatorEnabled() : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::isTranslatorEnabled()
inherited_from \Zend\Validator\File\Count::isTranslatorEnabled()

Returns

bool

Returns true if and only if the counted words are at least min and not bigger than max (when max is not null).

isValid(string $value, array $file) : bool

Attention: When checking with set min you must give all files with the first call, otherwise you will get an false.

Parameters

$value

string

Filename to check for word count

$file

array

File data from \Zend\File\Transfer\Transfer

Exceptions

\Zend\Validator\Exception\RuntimeException If validation of $value is impossible

Returns

bool

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

isValueObscured() : bool
Inherited

inherited_from \Zend\Validator\AbstractValidator::isValueObscured()
inherited_from \Zend\Validator\File\Count::isValueObscured()

Returns

bool

Set default translation object for all validate objects

setDefaultTranslator(\Zend\I18n\Translator\Translator $translator, string $textDomain) : void
Inherited

inherited_from \Zend\Validator\AbstractValidator::setDefaultTranslator()
inherited_from \Zend\Validator\File\Count::setDefaultTranslator()

Parameters

$textDomain

string

(optional)

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Set default translation text domain for all validate objects

setDefaultTranslatorTextDomain(string $textDomain) : void
Inherited

inherited_from \Zend\Validator\AbstractValidator::setDefaultTranslatorTextDomain()
inherited_from \Zend\Validator\File\Count::setDefaultTranslatorTextDomain()

Parameters

$textDomain

string

Sets the maximum file count

setMax(integer | array $max) : \Zend\Validator\File\Count
Inherited

inherited_from \Zend\Validator\File\Count::setMax()

Parameters

$max

integerarray

The maximum file count

Exceptions

\Zend\Validator\Exception\InvalidArgumentException When max is smaller than min

Returns

\Zend\Validator\File\CountProvides a fluent interface

Sets the validation failure message template for a particular key

setMessage(string $messageString, string $messageKey) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setMessage()
inherited_from \Zend\Validator\File\Count::setMessage()

Parameters

$messageString

string

$messageKey

string

OPTIONAL

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Returns

\Zend\Validator\AbstractValidatorProvides a fluent interface

Sets the maximum allowed message length

setMessageLength(integer $length) 
Inherited

inherited_from \Zend\Validator\AbstractValidator::setMessageLength()
inherited_from \Zend\Validator\File\Count::setMessageLength()

Parameters

$length

integer

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.

setMessages(array $messages) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setMessages()
inherited_from \Zend\Validator\File\Count::setMessages()

Parameters

$messages

array

Returns

Sets the minimum file count

setMin(integer | array $min) : \Zend\Validator\File\Count
Inherited

inherited_from \Zend\Validator\File\Count::setMin()

Parameters

$min

integerarray

The minimum file count

Exceptions

\Zend\Validator\Exception\InvalidArgumentException When min is greater than max

Returns

\Zend\Validator\File\CountProvides a fluent interface

Sets one or multiple options

setOptions(array | \Traversable $options) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setOptions()
inherited_from \Zend\Validator\File\Count::setOptions()

Parameters

$options

array\Traversable

Options to set

Exceptions

\Zend\Validator\Exception\InvalidArgumentException If $options is not an array or Traversable

Returns

\Zend\Validator\AbstractValidatorProvides fluid interface

Set translation object

setTranslator(\Zend\I18n\Translator\Translator $translator, string $textDomain) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setTranslator()
inherited_from \Zend\Validator\File\Count::setTranslator()

Parameters

$textDomain

string

(optional)

Exceptions

\Zend\Validator\Exception\InvalidArgumentException

Returns

Indicate whether or not translation should be enabled

setTranslatorEnabled(bool $flag) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setTranslatorEnabled()
inherited_from \Zend\Validator\File\Count::setTranslatorEnabled()

Parameters

$flag

bool

Returns

Set translation text domain

setTranslatorTextDomain(string $textDomain) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setTranslatorTextDomain()
inherited_from \Zend\Validator\File\Count::setTranslatorTextDomain()

Parameters

$textDomain

string

Returns

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

setValueObscured(bool $flag) : \Zend\Validator\AbstractValidator
Inherited

inherited_from \Zend\Validator\AbstractValidator::setValueObscured()
inherited_from \Zend\Validator\File\Count::setValueObscured()

Parameters

$flag

bool

Returns

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

createMessage(string $messageKey, string | array | object $value) : string
Inherited

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.

inherited_from \Zend\Validator\AbstractValidator::createMessage()
inherited_from \Zend\Validator\File\Count::createMessage()

Parameters

$messageKey

string

$value

stringarrayobject

Returns

string

error()

error(string $messageKey, string $value) : void
Inherited

inherited_from \Zend\Validator\AbstractValidator::error()
inherited_from \Zend\Validator\File\Count::error()

Parameters

$messageKey

string

$value

string

OPTIONAL

Returns the validation value

getValue() : mixed
Inherited

inherited_from \Zend\Validator\AbstractValidator::getValue()
inherited_from \Zend\Validator\File\Count::getValue()

Returns

mixedValue to be validated

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

setValue(mixed $value) : void
Inherited

inherited_from \Zend\Validator\AbstractValidator::setValue()
inherited_from \Zend\Validator\File\Count::setValue()

Parameters

$value

mixed

Throws an error of the given type

throwError(string $file, string $errorType) : false
Inherited

inherited_from \Zend\Validator\File\Count::throwError()

Parameters

$file

string

$errorType

string

Returns

false

Translate a validation message

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

inherited_from \Zend\Validator\AbstractValidator::translateMessage()
inherited_from \Zend\Validator\File\Count::translateMessage()

Parameters

$messageKey

string

$message

string

Returns

string

 Properties

 

$abstractOptions

$abstractOptions 
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$abstractOptions
inherited_from \Zend\Validator\File\Count::$$abstractOptions
 

Actual filecount

$count : integer
Inherited

inherited_from \Zend\Validator\File\Count::$$count
 

Default translation object for all validate objects

$defaultTranslator : \Zend\I18n\Translator\Translator
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$defaultTranslator
inherited_from \Zend\Validator\File\Count::$$defaultTranslator
 

Default text domain to be used with translator

$defaultTranslatorTextDomain : string
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$defaultTranslatorTextDomain
inherited_from \Zend\Validator\File\Count::$$defaultTranslatorTextDomain
 

Internal file array

$files : array
Inherited

inherited_from \Zend\Validator\File\Count::$$files
 

Limits the maximum returned length of a error message

$messageLength : Integer
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$messageLength
inherited_from \Zend\Validator\File\Count::$$messageLength
 

<p>Error message templates</p>

$messageTemplates : array

 

<p>Error message template variables</p>

$messageVariables : array
Inherited

inherited_from \Zend\Validator\File\Count::$$messageVariables
 

Options for this validator

$options : array
Inherited

inherited_from \Zend\Validator\File\Count::$$options
 

The value to be validated

$value : mixed
Inherited

inherited_from \Zend\Validator\AbstractValidator::$$value
inherited_from \Zend\Validator\File\Count::$$value

 Constants

 

NOT_FOUND

NOT_FOUND 

 

TOO_FEW

TOO_FEW 
Inherited

inherited_from \Zend\Validator\File\Count::TOO_FEW
 

TOO_LESS

TOO_LESS 

 

TOO_MANY

TOO_MANY 
Inherited

inherited_from \Zend\Validator\File\Count::TOO_MANY
 

TOO_MUCH

TOO_MUCH 

const string Error constants