API Documentation

Zend/File/Transfer/Adapter/Http.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_File_Transfer  
Version
$Id: Http.php 24594 2012-01-05 21:27:01Z matthew $  

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

Properties

Propertyprotected  $_callbackApc= ''apc_fetch''
static
Default value'apc_fetch'Details
Type
Propertyprotected  $_callbackUploadProgress= ''uploadprogress_get_info''
static
Default value'uploadprogress_get_info'Details
Type

Methods

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

Constructor for Http File Transfers

Parameters
Name Type Description
$options array

OPTIONAL Options to set

methodprotected_prepareFiles( ) : array

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

Returns
Type Description
array
methodpublicclearValidators( ) : \Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicgetProgress( string $id = null ) : array|null
static

Returns the actual progress of file up-/downloads

Parameters
Name Type Description
$id string

The upload to get the progress for

Returns
Type Description
array|null
methodpublicisApcAvailable( ) : boolean
static

Checks the APC extension for progress information

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

Checks if the file was already filtered

Parameters
Name Type Description
$files string|array

(Optional) Files to check

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

Checks if the file was already received

Parameters
Name Type Description
$files string|array

(Optional) Files to check

Returns
Type Description
bool
methodpublicisSent(  $files = null ) : bool

Checks if the file was already sent

Parameters
Name Type Description
$files
Returns
Type Description
bool
Throws
Exception Description
\Zend_File_Transfer_Exception Not implemented
methodpublicisUploadProgressAvailable( ) : boolean
static

Checks the UploadProgress extension for progress information

Returns
Type Description
boolean
methodpublicisUploaded(  $files = null ) : bool

Has a file been uploaded ?

Parameters
Name Type Description
$files
Returns
Type Description
bool
methodpublicisValid( string|array $files = null ) : boolean

Checks if the files are valid

Parameters
Name Type Description
$files string|array

(Optional) Files to check

Returns
Type Description
boolean True if all checks are valid
methodpublicreceive( string|array $files = null ) : bool

Receive the file from the client (Upload)

Parameters
Name Type Description
$files string|array

(Optional) Files to receive

Returns
Type Description
bool
methodpublicremoveValidator( string $name ) : \Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_File_Transfer_Adapter_Abstract
methodpublicsend( string|array $options = null ) : void

Send the file to the client (Download)

Parameters
Name Type Description
$options string|array

Options for the file(s) to send

Throws
Exception Description
\Zend_File_Transfer_Exception Not implemented
methodpublicsetValidators(  $validators, string|array $files = null ) : \Zend_File_Transfer_Adapter

Sets a validator for the class, erasing all previous set

Parameters
Name Type Description
$validators
$files string|array

Files to limit this validator to

Returns
Type Description
\Zend_File_Transfer_Adapter
Documentation was generated by DocBlox 0.15.1.