API Documentation

File/Transfer.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_File_Transfer  
version
$Id: Transfer.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_File_Transfer

Base class for all protocols supporting file transfers

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_File_Transfer  

Properties

Propertyprotectedarray  $_adapter= 'array'

Array holding all directions

Default valuearrayDetails
Type
array

Methods

methodpublic__call( string $method, array $options ) : mixed

Calls all methods from the adapter

Parameters
Name Type Description
$method string Method to call
$options array Options for this method
Returns
Type Description
mixed
methodpublic__construct( string $adapter = Http, boolean $direction = false, array $options = array ) : void

Creates a file processing handler

Parameters
Name Type Description
$adapter string Adapter to use
$direction boolean OPTIONAL False means Download, true means upload
$options array OPTIONAL Options to set for this adapter
Throws
Exception Description
\Zend_File_Transfer_Exception
methodpublicgetAdapter( boolean $direction = null ) : array|\Zend_File_Transfer_Adapter

Returns all set adapters

Parameters
Name Type Description
$direction boolean On null, all directions are returned On false, download direction is returned On true, upload direction is returned
Returns
Type Description
array\Zend_File_Transfer_Adapter
methodpublicsetAdapter( string $adapter, boolean $direction = false, array $options = array ) : void

Sets a new adapter

Parameters
Name Type Description
$adapter string Adapter to use
$direction boolean OPTIONAL False means Download, true means upload
$options array OPTIONAL Options to set for this adapter
Throws
Exception Description
\Zend_File_Transfer_Exception
Documentation was generated by DocBlox 0.13.3.