Validate/File/Count.php

Show: PublicProtectedPrivateinherited
Table of Contents
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id$  

\Zend_Validate_File_Count

Package: Zend_Validate
Validator for counting all given files
Parent(s)
\Zend_Validate_Abstract
Children
\Zend_Validate_File_WordCount
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  TOO_MANY = 'fileCountTooMany'
>VConstant  TOO_FEW = 'fileCountTooFew'

Properties

>VPropertyprotectedinteger $_count
Actual filecount
Details
Type
integer
>VPropertyprotectedarray $_files
Internal file array
Details
Type
array
>VPropertyprotectedinteger|null $_max
Maximum file count
If null, there is no maximum file count
Details
Type
integer | null
>VPropertyprotectedarray $_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")

Error message templates

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
>VPropertyprotectedarray $_messageVariables = array('min' => '_min', 'max' => '_max', 'count' => '_count')

Error message template variables

Default valuearray('min' => '_min', 'max' => '_max', 'count' => '_count')Details
Type
array
>VPropertyprotectedinteger $_min
Minimum file count
If null, there is no minimum file count
Details
Type
integer

Methods

methodpublic__construct(integer | array | \Zend_Config $options) : void

Sets validator options

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
Parameters
NameTypeDescription
$optionsinteger | array | \Zend_Config

Options for the adapter

methodprotected_throw(string $file, string $errorType) : false

Throws an error of the given type

Parameters
NameTypeDescription
$filestring
$errorTypestring
Returns
TypeDescription
false
methodpublicaddFile(string | array $file) : void

Adds a file for validation

Parameters
NameTypeDescription
$filestring | array
methodpublicgetMax() : integer

Returns the maximum file count

Returns
TypeDescription
integer
methodpublicgetMin() : integer

Returns the minimum file count

Returns
TypeDescription
integer
methodpublicisValid(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.
Parameters
NameTypeDescription
$valuestring | array

Filenames to check for count

$filearray

File data from Zend_File_Transfer

Returns
TypeDescription
boolean
methodpublicsetMax(integer | array $max) : \Zend_Validate_StringLength

Sets the maximum file count

Parameters
NameTypeDescription
$maxinteger | array

The maximum file count

Returns
TypeDescription
\Zend_Validate_StringLengthProvides a fluent interface
Throws
ExceptionDescription
\Zend_Validate_ExceptionWhen max is smaller than min
methodpublicsetMin(integer | array $min) : \Zend_Validate_File_Count

Sets the minimum file count

Parameters
NameTypeDescription
$mininteger | array

The minimum file count

Returns
TypeDescription
\Zend_Validate_File_CountProvides a fluent interface
Throws
ExceptionDescription
\Zend_Validate_ExceptionWhen min is greater than max
Documentation was generated by phpDocumentor 2.2.0 .