API Documentation

Validate/File/Count.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Validate
version
$Id: Count.php 21326 2010-03-04 20:32:39Z thomas $
Classes
Zend_Validate_File_Count

Description

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.

Zend_Validate_File_Count

Extends from
Zend_Validate_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Validate
Constants
TOO_MANY
TOO_FEW
Properties
$_messageTemplates
$_messageVariables
$_min
$_max
$_count
$_files
Methods
__construct
getMin
setMin
getMax
setMax
addFile
isValid
_throw

Description

Validator for counting all given files

Constants

TOO_MANY

 TOO_MANY = 'fileCountTooMany'

Details

value
fileCountTooMany

TOO_FEW

 TOO_FEW = 'fileCountTooFew'

Details

value
fileCountTooFew

Properties

$_count

integer $_count = ''

Actual filecount

Details

$_count
integer
visibility
protected
default
final
false
static
false

$_files

array $_files = ''

Internal file array

Details

$_files
array
visibility
protected
default
final
false
static
false

$_max

integer|null $_max = ''

Maximum file count

If null, there is no maximum file count

Details

$_max
integer|null
visibility
protected
default
final
false
static
false

$_messageTemplates

array $_messageTemplates = 'array'

Details

$_messageTemplates
array
Error message templates
visibility
protected
default
array
final
false
static
false

$_messageVariables

array $_messageVariables = 'array'

Details

$_messageVariables
array
Error message template variables
visibility
protected
default
array
final
false
static
false

$_min

integer $_min = ''

Minimum file count

If null, there is no minimum file count

Details

$_min
integer
visibility
protected
default
final
false
static
false

Methods

__construct

__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

Arguments
$options
integerarrayZend_Config
Options for the adapter
Details
visibility
public
final
false
static
false

_throw

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

Throws an error of the given type

Arguments
$file
string
$errorType
string
Output
false
Details
visibility
protected
final
false
static
false

addFile

addFile( string|array $file ) :

Adds a file for validation

Arguments
$file
stringarray
Details
visibility
public
final
false
static
false

getMax

getMax( ) : integer

Returns the maximum file count

Output
integer
Details
visibility
public
final
false
static
false

getMin

getMin( ) : integer

Returns the minimum file count

Output
integer
Details
visibility
public
final
false
static
false

isValid

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.

Arguments
$value
stringarray
Filenames to check for count
$file
array
File data from Zend_File_Transfer
Output
boolean
Details
visibility
public
final
false
static
false

setMax

setMax( integer|array $max ) : Zend_Validate_StringLength

Sets the maximum file count

Arguments
$max
integerarray
The maximum file count
Output
Zend_Validate_StringLength
Provides a fluent interface
Details
visibility
public
final
false
static
false
throws
When max is smaller than min

setMin

setMin( integer|array $min ) : Zend_Validate_File_Count

Sets the minimum file count

Arguments
$min
integerarray
The minimum file count
Output
Zend_Validate_File_Count
Provides a fluent interface
Details
visibility
public
final
false
static
false
throws
When min is greater than max
Documentation was generated by DocBlox.