API Documentation

File/Transfer/Adapter/Http.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_File_Transfer
version
$Id: Http.php 22564 2010-07-15 20:43:55Z thomas $
Classes
Zend_File_Transfer_Adapter_Http

Description

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.

Zend_File_Transfer_Adapter_Http
jump to top

Extends from
Zend_File_Transfer_Adapter_Abstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_File_Transfer
Properties
$_callbackApc
$_callbackUploadProgress
Methods
__construct
setValidators
removeValidator
clearValidators
send
isValid
receive
isSent
isReceived
isFiltered
isUploaded
getProgress
isApcAvailable
isUploadProgressAvailable
_prepareFiles

Description

File transfer adapter class for the HTTP protocol

Properties

$_callbackApc
jump to class

 $_callbackApc = 'apc_fetch'

Details

visibility
protected
default
apc_fetch
final
false
static
true

$_callbackUploadProgress
jump to class

 $_callbackUploadProgress = 'uploadprogress_get_info'

Details

visibility
protected
default
uploadprogress_get_info
final
false
static
true

Methods

__construct
jump to class

__construct( array $options = array ) :

Constructor for Http File Transfers

Arguments
$options
array
OPTIONAL Options to set
Details
visibility
public
final
false
static
false

_prepareFiles
jump to class

_prepareFiles( ) : array

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

Output
array
Details
visibility
protected
final
false
static
false

clearValidators
jump to class

clearValidators( ) : Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

Output
Zend_File_Transfer_Adapter_Abstract
Details
visibility
public
final
false
static
false

getProgress
jump to class

getProgress( string $id = null ) : array|null

Returns the actual progress of file up-/downloads

Arguments
$id
string
The upload to get the progress for
Output
array|null
Details
visibility
public
final
false
static
true

isApcAvailable
jump to class

isApcAvailable( ) : boolean

Checks the APC extension for progress information

Output
boolean
Details
visibility
public
final
false
static
true

isFiltered
jump to class

isFiltered( string|array $files = null ) : bool

Checks if the file was already filtered

Arguments
$files
stringarray
(Optional) Files to check
Output
bool
Details
visibility
public
final
false
static
false

isReceived
jump to class

isReceived( string|array $files = null ) : bool

Checks if the file was already received

Arguments
$files
stringarray
(Optional) Files to check
Output
bool
Details
visibility
public
final
false
static
false

isSent
jump to class

isSent(  $files = null ) : bool

Checks if the file was already sent

Arguments
$files
Output
bool
Details
visibility
public
final
false
static
false
throws
Not implemented

isUploadProgressAvailable
jump to class

isUploadProgressAvailable( ) : boolean

Checks the UploadProgress extension for progress information

Output
boolean
Details
visibility
public
final
false
static
true

isUploaded
jump to class

isUploaded(  $files = null ) : bool

Has a file been uploaded ?

Arguments
$files
Output
bool
Details
visibility
public
final
false
static
false

isValid
jump to class

isValid( string|array $files = null ) : boolean

Checks if the files are valid

Arguments
$files
stringarray
(Optional) Files to check
Output
boolean
True if all checks are valid
Details
visibility
public
final
false
static
false

receive
jump to class

receive( string|array $files = null ) : bool

Receive the file from the client (Upload)

Arguments
$files
stringarray
(Optional) Files to receive
Output
bool
Details
visibility
public
final
false
static
false

removeValidator
jump to class

removeValidator( string $name ) : Zend_File_Transfer_Adapter_Abstract

Remove an individual validator

Arguments
$name
string
Output
Zend_File_Transfer_Adapter_Abstract
Details
visibility
public
final
false
static
false

send
jump to class

send( string|array $options = null ) : void

Send the file to the client (Download)

Arguments
$options
stringarray
Options for the file(s) to send
Details
visibility
public
final
false
static
false
throws
Not implemented

setValidators
jump to class

setValidators(  $validators, string|array $files = null ) : Zend_File_Transfer_Adapter

Sets a validator for the class, erasing all previous set

Arguments
$validators
$files
stringarray
Files to limit this validator to
Output
Zend_File_Transfer_Adapter
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.