API Documentation

Zend/Validate/File/Count.php

Show: inherited
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 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 24594 2012-01-05 21:27:01Z matthew $  

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  TOO_MANY = 'fileCountTooMany'
Constant  TOO_FEW = 'fileCountTooFew'

Properties

Propertyprotectedinteger  $_count= ''

Actual filecount

Details
Type
integer
Propertyprotectedarray  $_files= ''

Internal file array

Details
Type
array
Propertyprotectedinteger|null  $_max= ''

Maximum file count

If null, there is no maximum file count

Details
Type
integernull
Propertyprotectedarray  $_messageTemplates= 'array( self::TOO_MANY => "Too many files, maximum '%max%' are allowed but '%count%' are given"'

Error message templates
Default valuearray( self::TOO_MANY => "Too many files, maximum '%max%' are allowed but '%count%' are given"Details
Type
array
Propertyprotectedarray  $_messageVariables= 'array( 'min' => '_min''

Error message template variables
Default valuearray( 'min' => '_min'Details
Type
array
Propertyprotectedinteger  $_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
Name Type Description
$options integer|array|\Zend_Config

Options for the adapter

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

Throws an error of the given type

Parameters
Name Type Description
$file string
$errorType string
Returns
Type Description
false
methodpublicaddFile( string|array $file ) : void

Adds a file for validation

Parameters
Name Type Description
$file string|array
methodpublicgetMax( ) : integer

Returns the maximum file count

Returns
Type Description
integer
methodpublicgetMin( ) : integer

Returns the minimum file count

Returns
Type Description
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
Name Type Description
$value string|array

Filenames to check for count

$file array

File data from Zend_File_Transfer

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

Sets the maximum file count

Parameters
Name Type Description
$max integer|array

The maximum file count

Returns
Type Description
\Zend_Validate_StringLength Provides a fluent interface
Throws
Exception Description
\Zend_Validate_Exception When max is smaller than min
methodpublicsetMin( integer|array $min ) : \Zend_Validate_File_Count

Sets the minimum file count

Parameters
Name Type Description
$min integer|array

The minimum file count

Returns
Type Description
\Zend_Validate_File_Count Provides a fluent interface
Throws
Exception Description
\Zend_Validate_Exception When min is greater than max
Documentation was generated by DocBlox 0.15.1.