Validate/File/Count.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Validate
- Version
- $Id: Count.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Validate_File_Count
Package: Zend\ValidateValidator for counting all given files
- Parent(s)
- \Zend_Validate_Abstract
- Children
- \Zend_Validate_File_WordCount
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants


TOO_MANY
= 'fileCountTooMany'


TOO_FEW
= 'fileCountTooFew'
Properties



array $_messageTemplates = array(self::TOO_MANY => "Too many files, maximum '%max%' are allowed but '%count%' are given", self::TOO_FEW => "Too few files, minimum '%min%' are expected but '%count%' are given")
Validation failure message template definitions
Default valuearray(self::TOO_MANY => "Too many files, maximum '%max%' are allowed but '%count%' are given", self::TOO_FEW => "Too few files, minimum '%min%' are expected but '%count%' are given")
Details- Type
- array



array $_messageVariables = array('min' => '_min', 'max' => '_max', 'count' => '_count')
Additional variables available for validation failure messages
Default valuearray('min' => '_min', 'max' => '_max', 'count' => '_count')
Details- Type
- array
Methods



__construct(integer | array | \Zend_Config $options) : void
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
ParametersName | Type | Description |
---|
$options | integer | array | \Zend_Config | Options for the adapter |
---|



__get(string $property) : mixed
inheritedMagic function returns the value of the requested property, if and only if it is the value or a
message variable.
Inherited from:
\Zend_Validate_Abstract::__get() ParametersName | Type | Description |
---|
$property | string | |
---|
ReturnsThrows 


_createMessage(string $messageKey, string $value) : 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.
ParametersName | Type | Description |
---|
$messageKey | string | |
---|
$value | string | |
---|
Returns


_error(string $messageKey, string $value = null) : void
ParametersName | Type | Description |
---|
$messageKey | string | |
---|
$value | string | OPTIONAL |
---|



_throw(string $file, string $errorType) : false
Throws an error of the given type
ParametersName | Type | Description |
---|
$file | string | |
---|
$errorType | string | |
---|
Returns 


addFile(string | array $file) : void
Adds a file for validation
ParametersName | Type | Description |
---|
$file | string | array | |
---|



getMessages() : array
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.
Returns


isValid(string | array $value, array $file = null) : boolean
Defined by Zend_Validate_Interface
Returns true if and only if the file count of all checked files is at least min and
not bigger than max (when max is not null). Attention: When checking with set min you
must give all files with the first call, otherwise you will get an false.
ParametersName | Type | Description |
---|
$value | string | array | Filenames to check for count |
---|
$file | array | File data from Zend_File_Transfer |
---|
ReturnsThrows


setMax(integer | array $max) : \Zend_Validate_StringLength
Sets the maximum file count
ParametersName | Type | Description |
---|
$max | integer | array | The maximum file count |
---|
ReturnsThrows 


setMessage(string $messageString, string $messageKey = null) : \Zend_Validate_Abstract
ParametersName | Type | Description |
---|
$messageString | string | |
---|
$messageKey | string | OPTIONAL |
---|
ReturnsThrows 


setMessages(array $messages) : \Zend_Validate_Abstract
inheritedSets 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.
Inherited from:
\Zend_Validate_Abstract::setMessages() ParametersName | Type | Description |
---|
$messages | array | |
---|
Returns 


setMin(integer | array $min) : \Zend_Validate_File_Count
Sets the minimum file count
ParametersName | Type | Description |
---|
$min | integer | array | The minimum file count |
---|
ReturnsThrows