Validate/File/Extension.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id$  

\Zend_Validate_File_Extension

Package: Zend_Validate
Validator for the file extension of a file
Parent(s)
\Zend_Validate_Abstract
Children
\Zend_Validate_File_ExcludeExtension
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  FALSE_EXTENSION = 'fileExtensionFalse'
Const
string Error constants  
>VConstant  NOT_FOUND = 'fileExtensionNotFound'

Properties

>VPropertyprotectedboolean $_case = false
Validate case sensitive
Default valuefalseDetails
Type
boolean
>VPropertyprotectedstring $_extension = ''
Internal list of extensions
Default value''Details
Type
string
>VPropertyprotectedarray $_messageTemplates = array(self::FALSE_EXTENSION => "File '%value%' has a false extension", self::NOT_FOUND => "File '%value%' is not readable or does not exist")

Error message templates

Default valuearray(self::FALSE_EXTENSION => "File '%value%' has a false extension", self::NOT_FOUND => "File '%value%' is not readable or does not exist")Details
Type
array
>VPropertyprotectedarray $_messageVariables = array('extension' => '_extension')

Error message template variables

Default valuearray('extension' => '_extension')Details
Type
array

Methods

methodpublic__construct(string | array | \Zend_Config $options) : void

Sets validator options

Parameters
NameTypeDescription
$optionsstring | array | \Zend_Config
methodprotected_throw(string $file, string $errorType) : false

Throws an error of the given type

Parameters
NameTypeDescription
$filestring
$errorTypestring
Returns
TypeDescription
false
methodpublicaddExtension(string | array $extension) : \Zend_Validate_File_Extension

Adds the file extensions

Parameters
NameTypeDescription
$extensionstring | array

The extensions to add for validation

Returns
TypeDescription
\Zend_Validate_File_ExtensionProvides a fluent interface
methodpublicgetCase() : boolean

Returns the case option

Returns
TypeDescription
boolean
methodpublicgetExtension() : array

Returns the set file extension

Returns
TypeDescription
array
methodpublicisValid(string $value, array $file = null) : boolean

Defined by Zend_Validate_Interface

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

Real file to check for extension

$filearray

File data from Zend_File_Transfer

Returns
TypeDescription
boolean
methodpublicsetCase(boolean $case) : \Zend_Validate_File_Extension

Sets the case to use

Parameters
NameTypeDescription
$caseboolean
Returns
TypeDescription
\Zend_Validate_File_ExtensionProvides a fluent interface
methodpublicsetExtension(string | array $extension) : \Zend_Validate_File_Extension

Sets the file extensions

Parameters
NameTypeDescription
$extensionstring | array

The extensions to validate

Returns
TypeDescription
\Zend_Validate_File_ExtensionProvides a fluent interface
Documentation was generated by phpDocumentor 2.2.0 .