Zend_Validate_File_Extension Class Reference

Inheritance diagram for Zend_Validate_File_Extension:

Public Member Functions
	__construct ($options)
	getCase ()
	setCase ($case)
	getExtension ()
	setExtension ($extension)
	addExtension ($extension)
	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	FALSE_EXTENSION = 'fileExtensionFalse'
const	NOT_FOUND = 'fileExtensionNotFound'

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
	$_extension = ''
	$_case = false
	$_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 Extension.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Sets validator options

Parameters

string | array | Zend_Config

$options

Definition at line 76 of file Extension.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        }

        if (1 < func_num_args()) {
            $case = func_get_arg(1);
            $this->setCase($case);
        }

        if (is_array($options) and isset($options['case'])) {
            $this->setCase($options['case']);
            unset($options['case']);
        }

        $this->setExtension($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 228 of file Extension.php.

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

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

addExtension()

addExtension

(

$extension

)

Adds the file extensions

Parameters

string | array

$extension

The extensions to add for validation

Returns

Zend_Validate_File_Extension Provides a fluent interface

Definition at line 148 of file Extension.php.

    {
        $extensions = $this->getExtension();
        if (is_string($extension)) {
            $extension = explode(',', $extension);
        }

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

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

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

        $this->_extension = implode(',', $extensions);

        return $this;
    }

getCase()

getCase

(

)

Returns the case option

Returns

boolean

Definition at line 100 of file Extension.php.

    {
        return $this->_case;
    }

getExtension()

getExtension

(

)

Returns the set file extension

Returns

array

Definition at line 122 of file Extension.php.

    {
        $extension = explode(',', $this->_extension);

        return $extension;
    }

isValid()

isValid	(		$value,
			$file = null
	)

Defined by Zend_Validate_Interface

Returns true if and only if the fileextension of $value is included in the set extension list

Parameters

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

Returns

boolean

Definition at line 186 of file Extension.php.

    {
        // Is file readable ?
        #require_once 'Zend/Loader.php';
        if (!Zend_Loader::isReadable($value)) {
            return $this->_throw($file, self::NOT_FOUND);
        }

        if ($file !== null) {
            $info['extension'] = substr($file['name'], strrpos($file['name'], '.') + 1);
        } else {
            $info = pathinfo($value);
            if (!array_key_exists('extension', $info)) {
                // From the manual at http://php.net/pathinfo:
                // "If the path does not have an extension, no extension element
                // will be returned (see second example below)."
                return false;
            }
        }

        $extensions = $this->getExtension();

        if ($this->_case && (in_array($info['extension'], $extensions))) {
            return true;
        } else if (!$this->getCase()) {
            foreach ($extensions as $extension) {
                if (strtolower($extension) == strtolower($info['extension'])) {
                    return true;
                }
            }
        }

        return $this->_throw($file, self::FALSE_EXTENSION);
    }

setCase()

setCase

(

$case

)

Sets the case to use

Parameters

boolean

$case

Returns

Zend_Validate_File_Extension Provides a fluent interface

Definition at line 111 of file Extension.php.

    {
        $this->_case = (boolean) $case;
        return $this;
    }

setExtension()

setExtension

(

$extension

)

Sets the file extensions

Parameters

string | array

$extension

The extensions to validate

Returns

Zend_Validate_File_Extension Provides a fluent interface

Definition at line 135 of file Extension.php.

    {
        $this->_extension = null;
        $this->addExtension($extension);
        return $this;
    }

Field Documentation

$_case

$_case = false

protected

Definition at line 62 of file Extension.php.

$_extension

$_extension = ''

protected

Definition at line 55 of file Extension.php.

$_messageTemplates

$_messageTemplates

protected

Initial value:

= array(
        self::FALSE_EXTENSION => "File '%value%' has a false extension",
        self::NOT_FOUND       => "File '%value%' is not readable or does not exist",
    )

Definition at line 46 of file Extension.php.

$_messageVariables

$_messageVariables

protected

Initial value:

= array(
        'extension' => '_extension'
    )

Definition at line 67 of file Extension.php.

FALSE_EXTENSION

const FALSE_EXTENSION = 'fileExtensionFalse'

@const string Error constants

Definition at line 40 of file Extension.php.

NOT_FOUND

const NOT_FOUND = 'fileExtensionNotFound'

Definition at line 41 of file Extension.php.

---

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

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