File/Transfer/Adapter/Http.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_File_Transfer  
Version
$Id$  

\Zend_File_Transfer_Adapter_Http

Package: Zend_File_Transfer
File transfer adapter class for the HTTP protocol
Parent(s)
\Zend_File_Transfer_Adapter_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_callbackApc = 'apc_fetch'
static
Default value'apc_fetch'Details
Type
n/a
>VPropertyprotected$_callbackUploadProgress = 'uploadprogress_get_info'
static
Default value'uploadprogress_get_info'Details
Type
n/a

Methods

methodpublic__construct(array $options = array()) : void

Constructor for Http File Transfers

Parameters
NameTypeDescription
$optionsarray

OPTIONAL Options to set

methodprotected_prepareFiles() : array

Prepare the $_FILES array to match the internal syntax of one file per entry

Returns
TypeDescription
array
methodpublicclearValidators() : \Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

methodpublicgetProgress(string $id = null) : array | null
static

Returns the actual progress of file up-/downloads

Parameters
NameTypeDescription
$idstring

The upload to get the progress for

Returns
TypeDescription
array | null
methodpublicisApcAvailable() : boolean
static

Checks the APC extension for progress information

Returns
TypeDescription
boolean
methodpublicisFiltered(string | array $files = null) : bool

Checks if the file was already filtered

Parameters
NameTypeDescription
$filesstring | array

(Optional) Files to check

Returns
TypeDescription
bool
methodpublicisReceived(string | array $files = null) : bool

Checks if the file was already received

Parameters
NameTypeDescription
$filesstring | array

(Optional) Files to check

Returns
TypeDescription
bool
methodpublicisSent( $files = null) : bool

Checks if the file was already sent

Parameters
NameTypeDescription
$files
Returns
TypeDescription
bool
Throws
ExceptionDescription
\Zend_File_Transfer_ExceptionNot implemented
methodpublicisUploadProgressAvailable() : boolean
static

Checks the UploadProgress extension for progress information

Returns
TypeDescription
boolean
methodpublicisUploaded( $files = null) : bool

Has a file been uploaded ?

Parameters
NameTypeDescription
$files
Returns
TypeDescription
bool
methodpublicisValid(string | array $files = null) : boolean

Checks if the files are valid

Parameters
NameTypeDescription
$filesstring | array

(Optional) Files to check

Returns
TypeDescription
booleanTrue if all checks are valid
methodpublicreceive(string | array $files = null) : bool

Receive the file from the client (Upload)

Parameters
NameTypeDescription
$filesstring | array

(Optional) Files to receive

Returns
TypeDescription
bool
methodpublicremoveValidator(string $name) : \Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_File_Transfer_Adapter_Abstract
methodpublicsend(string | array $options = null) : void

Send the file to the client (Download)

Parameters
NameTypeDescription
$optionsstring | array

Options for the file(s) to send

Throws
ExceptionDescription
\Zend_File_Transfer_ExceptionNot implemented
methodpublicsetValidators( $validators, string | array $files = null) : \Zend_File_Transfer_Adapter

Sets a validator for the class, erasing all previous set

Parameters
NameTypeDescription
$validators
$filesstring | array

Files to limit this validator to

Returns
TypeDescription
\Zend_File_Transfer_Adapter
Documentation was generated by phpDocumentor 2.2.0 .