Zend_Validate_File_Count Class Reference

Inheritance diagram for Zend_Validate_File_Count:

Public Member Functions
	__construct ($options)
	getMin ()
	setMin ($min)
	getMax ()
	setMax ($max)
	addFile ($file)
	isValid ($value, $file=null)
Public Member Functions inherited from Zend_Validate_Abstract
	getMessages ()
	getMessageVariables ()
	getMessageTemplates ()
	setMessage ($messageString, $messageKey=null)
	setMessages (array $messages)
	__get ($property)
	getErrors ()
	setObscureValue ($flag)
	getObscureValue ()
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	setDisableTranslator ($flag)
	translatorIsDisabled ()
Public Member Functions inherited from Zend_Validate_Interface
	isValid ($value)

Data Fields
const	TOO_MANY = 'fileCountTooMany'
const	TOO_FEW = 'fileCountTooFew'

Protected Member Functions
	_throw ($file, $errorType)
Protected Member Functions inherited from Zend_Validate_Abstract
	_createMessage ($messageKey, $value)
	_implodeRecursive (array $pieces)
	_error ($messageKey, $value=null)
	_setValue ($value)

Protected Attributes
	$_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)
static	getDefaultTranslator ()
static	hasDefaultTranslator ()
static	getMessageLength ()
static	setMessageLength ($length=-1)
Static Protected Attributes inherited from Zend_Validate_Abstract
static	$_defaultTranslator
static	$_messageLength = -1

Detailed Description

Definition at line 35 of file Count.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

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

integer | array | Zend_Config

$options

Options for the adapter

Exceptions

Zend_Validate_Exception

Definition at line 106 of file Count.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (is_string($options) || is_numeric($options)) {
            $options = array('max' => $options);
        } elseif (!is_array($options)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception ('Invalid options to validator provided');
        }

        if (1 < func_num_args()) {
            $options['min'] = func_get_arg(0);
            $options['max'] = func_get_arg(1);
        }

        if (isset($options['min'])) {
            $this->setMin($options);
        }

        if (isset($options['max'])) {
            $this->setMax($options);
        }
    }

Member Function Documentation

_throw()

_throw (   $file,   $errorType  )

protected

Throws an error of the given type

Parameters

string	$file
string	$errorType

Returns

false

Definition at line 276 of file Count.php.

    {
        if ($file !== null) {
            $this->_value = $file['name'];
        }

        $this->_error($errorType);
        return false;
    }

addFile()

addFile

(

$file

)

Adds a file for validation

Parameters

string | array

$file

Returns

$this

Definition at line 215 of file Count.php.

    {
        if (is_string($file)) {
            $file = array($file);
        }

        if (is_array($file)) {
            foreach ($file as $name) {
                if (!isset($this->_files[$name]) && !empty($name)) {
                    $this->_files[$name] = $name;
                }
            }
        }

        return $this;
    }

getMax()

getMax

(

)

Returns the maximum file count

Returns

integer

Definition at line 175 of file Count.php.

    {
        return $this->_max;
    }

getMin()

getMin

(

)

Returns the minimum file count

Returns

integer

Definition at line 136 of file Count.php.

    {
        return $this->_min;
    }

isValid()

isValid	(		$value,
			$file = null
	)

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

string | array	$value	Filenames to check for count
array	$file	File data from Zend_File_Transfer

Returns

boolean

Definition at line 243 of file Count.php.

    {
        if (($file !== null) && !array_key_exists('destination', $file)) {
            $file['destination'] = dirname($value);
        }

        if (($file !== null) && array_key_exists('tmp_name', $file)) {
            $value = $file['destination'] . DIRECTORY_SEPARATOR . $file['name'];
        }

        if (($file === null) || !empty($file['tmp_name'])) {
            $this->addFile($value);
        }

        $this->_count = count($this->_files);
        if (($this->_max !== null) && ($this->_count > $this->_max)) {
            return $this->_throw($file, self::TOO_MANY);
        }

        if (($this->_min !== null) && ($this->_count < $this->_min)) {
            return $this->_throw($file, self::TOO_FEW);
        }

        return true;
    }

setMax()

setMax

(

$max

)

Sets the maximum file count

Parameters

integer | array

$max

The maximum file count

Returns

Zend_Validate_StringLength Provides a fluent interface

Exceptions

Zend_Validate_Exception

When max is smaller than min

Definition at line 187 of file Count.php.

    {
        if (is_array($max) and isset($max['max'])) {
            $max = $max['max'];
        }

        if (!is_string($max) and !is_numeric($max)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception ('Invalid options to validator provided');
        }

        $max = (integer) $max;
        if (($this->_min !== null) && ($max < $this->_min)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("The maximum must be greater than or equal to the minimum file count, but "
                                            . "$max < {$this->_min}");
        }

        $this->_max = $max;
        return $this;
    }

setMin()

setMin

(

$min

)

Sets the minimum file count

Parameters

integer | array

$min

The minimum file count

Returns

Zend_Validate_File_Count Provides a fluent interface

Exceptions

Zend_Validate_Exception

When min is greater than max

Definition at line 148 of file Count.php.

    {
        if (is_array($min) and isset($min['min'])) {
            $min = $min['min'];
        }

        if (!is_string($min) and !is_numeric($min)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception ('Invalid options to validator provided');
        }

        $min = (integer) $min;
        if (($this->_max !== null) && ($min > $this->_max)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception("The minimum must be less than or equal to the maximum file count, but $min >"
                                            . " {$this->_max}");
        }

        $this->_min = $min;
        return $this;
    }

Field Documentation

$_count

$_count

protected

Definition at line 84 of file Count.php.

$_files

$_files

protected

Definition at line 90 of file Count.php.

$_max

$_max

protected

Definition at line 77 of file Count.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= 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",
    )

Definition at line 47 of file Count.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'min'   => '_min',
        'max'   => '_max',
        'count' => '_count'
    )

Definition at line 55 of file Count.php.

$_min

$_min

protected

Definition at line 68 of file Count.php.

TOO_FEW

const TOO_FEW = 'fileCountTooFew'

Definition at line 41 of file Count.php.

TOO_MANY

const TOO_MANY = 'fileCountTooMany'

#+ @const string Error constants

Definition at line 40 of file Count.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Validate/File/Count.php