API Documentation

Zend/Validate/File/Exists.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: Exists.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Validate_File_Exists

Package: Zend\Validate

Validator which checks if the file already exists in the directory

Parent(s)
\Zend_Validate_Abstract
Children
\Zend_Validate_File_NotExists
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  DOES_NOT_EXIST = 'fileExistsDoesNotExist'

Const
string Error constants  

Properties

Propertyprotectedstring  $_directory= ''''

Internal list of directories

Default value''Details
Type
string
Propertyprotectedarray  $_messageTemplates= 'array( self::DOES_NOT_EXIST => "File '%value%' does not exist"'

Error message templates
Default valuearray( self::DOES_NOT_EXIST => "File '%value%' does not exist"Details
Type
array
Propertyprotectedarray  $_messageVariables= 'array( 'directory' => '_directory' )'

Error message template variables
Default valuearray( 'directory' => '_directory' )Details
Type
array

Methods

methodpublic__construct( string|array|\Zend_Config $directory = array() ) : void

Sets validator options

Parameters
Name Type Description
$directory 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
methodpublicaddDirectory( string|array $directory ) : \Zend_Validate_File_Extension

Adds the file directory which will be checked

Parameters
Name Type Description
$directory string|array

The directory to add for validation

Returns
Type Description
\Zend_Validate_File_Extension Provides a fluent interface
methodpublicgetDirectory( boolean $asArray = false ) : string

Returns the set file directories which are checked

Parameters
Name Type Description
$asArray boolean

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

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

Defined by Zend_Validate_Interface

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

Parameters
Name Type Description
$value string

Real file to check for existance

$file array

File data from Zend_File_Transfer

Returns
Type Description
boolean
methodpublicsetDirectory( string|array $directory ) : \Zend_Validate_File_Extension

Sets the file directory which will be checked

Parameters
Name Type Description
$directory string|array

The directories to validate

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