Zend_Validate_File_Exists Class Reference

Inheritance diagram for Zend_Validate_File_Exists:

Public Member Functions
	__construct ($directory=array())
	getDirectory ($asArray=false)
	setDirectory ($directory)
	addDirectory ($directory)
	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	DOES_NOT_EXIST = 'fileExistsDoesNotExist'

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
	$_directory = ''
	$_messageVariables
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 Exists.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$directory = array()

)

Sets validator options

Parameters

string | array | Zend_Config

$directory

Exceptions

Zend_Validate_Exception

Definition at line 68 of file Exists.php.

    {
        if ($directory instanceof Zend_Config) {
            $directory = $directory->toArray();
        } else if (is_string($directory)) {
            $directory = explode(',', $directory);
        } else if (!is_array($directory)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception ('Invalid options to validator provided');
        }

        $this->setDirectory($directory);
    }

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 195 of file Exists.php.

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

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

addDirectory()

addDirectory

(

$directory

)

Adds the file directory which will be checked

Parameters

string | array

$directory

The directory to add for validation

Exceptions

Zend_Validate_Exception

Returns

Zend_Validate_File_Extension Provides a fluent interface

Definition at line 119 of file Exists.php.

    {
        $directories = $this->getDirectory(true);

        if (is_string($directory)) {
            $directory = explode(',', $directory);
        } else if (!is_array($directory)) {
            #require_once 'Zend/Validate/Exception.php';
            throw new Zend_Validate_Exception ('Invalid options to validator provided');
        }

        foreach ($directory as $content) {
            if (empty($content) || !is_string($content)) {
                continue;
            }

            $directories[] = trim($content);
        }
        $directories = array_unique($directories);

        // Sanity check to ensure no empty values
        foreach ($directories as $key => $dir) {
            if (empty($dir)) {
                unset($directories[$key]);
            }
        }

        $this->_directory = implode(',', $directories);

        return $this;
    }

getDirectory()

getDirectory

(

$asArray = false

)

Returns the set file directories which are checked

Parameters

boolean

$asArray

Returns the values as array, when false an concated string is returned

Returns

string

Definition at line 88 of file Exists.php.

    {
        $asArray   = (bool) $asArray;
        $directory = (string) $this->_directory;
        if ($asArray) {
            $directory = explode(',', $directory);
        }

        return $directory;
    }

isValid()

isValid	(		$value,
			$file = null
	)

Defined by Zend_Validate_Interface

Returns true if and only if the file already exists in the set directories

Parameters

string	$value	Real file to check for existance
array	$file	File data from Zend_File_Transfer

Returns

boolean

Definition at line 160 of file Exists.php.

    {
        $directories = $this->getDirectory(true);
        if (($file !== null) and (!empty($file['destination']))) {
            $directories[] = $file['destination'];
        } else if (!isset($file['name'])) {
            $file['name'] = $value;
        }

        $check = false;
        foreach ($directories as $directory) {
            if (empty($directory)) {
                continue;
            }

            $check = true;
            if (!file_exists($directory . DIRECTORY_SEPARATOR . $file['name'])) {
                return $this->_throw($file, self::DOES_NOT_EXIST);
            }
        }

        if (!$check) {
            return $this->_throw($file, self::DOES_NOT_EXIST);
        }

        return true;
    }

setDirectory()

setDirectory

(

$directory

)

Sets the file directory which will be checked

Parameters

string | array

$directory

The directories to validate

Returns

Zend_Validate_File_Extension Provides a fluent interface

Definition at line 105 of file Exists.php.

    {
        $this->_directory = null;
        $this->addDirectory($directory);
        return $this;
    }

Field Documentation

$_directory

$_directory = ''

protected

Definition at line 53 of file Exists.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::DOES_NOT_EXIST => "File '%value%' does not exist",
    )

Definition at line 45 of file Exists.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'directory' => '_directory'
    )

Definition at line 58 of file Exists.php.

DOES_NOT_EXIST

const DOES_NOT_EXIST = 'fileExistsDoesNotExist'

@const string Error constants

Definition at line 40 of file Exists.php.

---

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

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