API Documentation

Zend/Validate/File/Extension.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Validate  
Version
$Id: Extension.php 24594 2012-01-05 21:27:01Z matthew $  

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  FALSE_EXTENSION = 'fileExtensionFalse'

Const
string Error constants  
Constant  NOT_FOUND = 'fileExtensionNotFound'

Properties

Propertyprotectedboolean  $_case= 'false'

Validate case sensitive

Default valuefalseDetails
Type
boolean
Propertyprotectedstring  $_extension= ''''

Internal list of extensions

Default value''Details
Type
string
Propertyprotectedarray  $_messageTemplates= 'array( self::FALSE_EXTENSION => "File '%value%' has a false extension"'

Error message templates
Default valuearray( self::FALSE_EXTENSION => "File '%value%' has a false extension"Details
Type
array
Propertyprotectedarray  $_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
Name Type Description
$options string|array|\Zend_Config
methodprotected_throw( string $file, string $errorType ) : false

Throws an error of the given type

Parameters
Name Type Description
$file string
$errorType string
Returns
Type Description
false
methodpublicaddExtension( string|array $extension ) : \Zend_Validate_File_Extension

Adds the file extensions

Parameters
Name Type Description
$extension string|array

The extensions to add for validation

Returns
Type Description
\Zend_Validate_File_Extension Provides a fluent interface
methodpublicgetCase( ) : boolean

Returns the case option

Returns
Type Description
boolean
methodpublicgetExtension( ) : array

Returns the set file extension

Returns
Type Description
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
Name Type Description
$value string

Real file to check for extension

$file array

File data from Zend_File_Transfer

Returns
Type Description
boolean
methodpublicsetCase( boolean $case ) : \Zend_Validate_File_Extension

Sets the case to use

Parameters
Name Type Description
$case boolean
Returns
Type Description
\Zend_Validate_File_Extension Provides a fluent interface
methodpublicsetExtension( string|array $extension ) : \Zend_Validate_File_Extension

Sets the file extensions

Parameters
Name Type Description
$extension string|array

The extensions to validate

Returns
Type Description
\Zend_Validate_File_Extension Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.