Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Zend_Validate_File_WordCount Class Reference

Public Member Functions

 isValid ($value, $file=null)
 Defined by Zend_Validate_Interface.
 
- Public Member Functions inherited from Zend_Validate_File_Count
 __construct ($options)
 Sets validator options.
 
 getMin ()
 Returns the minimum file count.
 
 setMin ($min)
 Sets the minimum file count.
 
 getMax ()
 Returns the maximum file count.
 
 setMax ($max)
 Sets the maximum file count.
 
 addFile ($file)
 Adds a file for validation.
 
 isValid ($value, $file=null)
 Defined by Zend_Validate_Interface.
 
- Public Member Functions inherited from Zend_Validate_Abstract
 getMessages ()
 Returns array of validation failure messages.
 
 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.
 
 getErrors ()
 Returns array of validation failure message codes.
 
 setObscureValue ($flag)
 Set flag indicating whether or not value should be obfuscated in messages.
 
 getObscureValue ()
 Retrieve flag indicating whether or not value should be obfuscated in messages.
 
 setTranslator ($translator=null)
 Set translation object.
 
 getTranslator ()
 Return translation object.
 
 hasTranslator ()
 Does this validator have its own specific translator?
 
 setDisableTranslator ($flag)
 Indicate whether or not translation should be disabled.
 
 translatorIsDisabled ()
 Is translation disabled?
 
- Public Member Functions inherited from Zend_Validate_Interface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Public Attributes

const TOO_MUCH = 'fileWordCountTooMuch'
 #@+ string Error constants
 
const TOO_LESS = 'fileWordCountTooLess'
 
const NOT_FOUND = 'fileWordCountNotFound'
 
- Public Attributes inherited from Zend_Validate_File_Count
const TOO_MANY = 'fileCountTooMany'
 #@+ string Error constants
 
const TOO_FEW = 'fileCountTooFew'
 

Protected Member Functions

 _throw ($file, $errorType)
 Throws an error of the given type.
 
- Protected Member Functions inherited from Zend_Validate_File_Count
 _throw ($file, $errorType)
 Throws an error of the given type.
 
- Protected Member Functions inherited from Zend_Validate_Abstract
 _createMessage ($messageKey, $value)
 Constructs and returns a validation failure message with the given message key and value.
 
 _error ($messageKey, $value=null)
 
 _setValue ($value)
 Sets the value to be validated and clears the messages and errors arrays.
 

Protected Attributes

 $_messageTemplates
 
- Protected Attributes inherited from Zend_Validate_File_Count
 $_messageTemplates
 
 $_messageVariables
 
 $_min
 
 $_max
 
 $_count
 
 $_files
 
- Protected Attributes inherited from Zend_Validate_Abstract
 $_value
 
 $_messageVariables = array()
 
 $_messageTemplates = array()
 
 $_messages = array()
 
 $_obscureValue = false
 
 $_errors = array()
 
 $_translator
 
 $_translatorDisabled = false
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Validate_Abstract
static setDefaultTranslator ($translator=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 getMessageLength ()
 Returns the maximum allowed message length.
 
static setMessageLength ($length=-1)
 Sets the maximum allowed message length.
 
- Static Protected Attributes inherited from Zend_Validate_Abstract
static $_defaultTranslator
 
static $_messageLength = -1
 

Member Function Documentation

_throw (   $file,
  $errorType 
)
protected

Throws an error of the given type.

Parameters
string$file
string$errorType
Returns
false
isValid (   $value,
  $file = null 
)

Defined by Zend_Validate_Interface.

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

Parameters
string$valueFilename to check for word count
array$fileFile data from Zend_File_Transfer
Returns
boolean

Member Data Documentation

$_messageTemplates
protected
Initial value:
= array(
self::TOO_MUCH => "Too much words, maximum '%max%' are allowed but '%count%' were counted",
self::TOO_LESS => "Too less words, minimum '%min%' are expected but '%count%' were counted",
self::NOT_FOUND => "File '%value%' is not readable or does not exist",
)
const NOT_FOUND = 'fileWordCountNotFound'
const TOO_LESS = 'fileWordCountTooLess'
const TOO_MUCH = 'fileWordCountTooMuch'

#@+ string Error constants