Service/Nirvanix/Namespace/Imfs.php
inherited
Classes
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 [email protected] 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_Service
- Subpackage
- Nirvanix
- Version
- $Id: Imfs.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Service_Nirvanix_Namespace_Imfs
Namespace proxy with additional convenience methods for the IMFS namespace.
This is a proxy class representing one namespace. It allows calls to the namespace to be made by PHP object calls rather than by having to construct HTTP client requests.
- Parent(s)
- \Zend_Service_Nirvanix_Namespace_Base
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
$_defaults = array()Defaults for POST parameters.
Inherited from: \Zend_Service_Nirvanix_Namespace_Base::$$_defaultsWhen a request to the service is to be made, the POST parameters are merged into these. This is a convenience feature so parameters that are repeatedly required like sessionToken do not need to be supplied again and again by the user.
array()Details- Type
- n/a
- Inherited_from
- \Zend_Service_Nirvanix_Namespace_Base::$$_defaults
- $_defaults
array
string $_host = 'http://services.nirvanix.com'Host to use for calls to this Nirvanix namespace.
Inherited from: \Zend_Service_Nirvanix_Namespace_Base::$$_hostIt is possible that the user will wish to use different hosts for different namespaces.
'http://services.nirvanix.com'Details- Type
- string
- Inherited_from
- \Zend_Service_Nirvanix_Namespace_Base::$$_host
\Zend_Http_Client $_httpClient = HTTP client instance that will be used to make calls to the Nirvanix web services.
Inherited from: \Zend_Service_Nirvanix_Namespace_Base::$$_httpClient- Type
- \Zend_Http_Client
- Inherited_from
- \Zend_Service_Nirvanix_Namespace_Base::$$_httpClient
string $_namespace = ''Name of this namespace as used in the URL.
Inherited from: \Zend_Service_Nirvanix_Namespace_Base::$$_namespace''Details- Type
- string
- Inherited_from
- \Zend_Service_Nirvanix_Namespace_Base::$$_namespace
Methods
__call(string $methodName, array $args) : \Zend_Service_Nirvanix_ResponseWhen a method call is made against this proxy, convert it to an HTTP request to make against the Nirvanix REST service.
Inherited from: \Zend_Service_Nirvanix_Namespace_Base::__call()$imfs->DeleteFiles(array('filePath' => 'foo'));
Assuming this object was proxying the IMFS namespace, the method call above would call the DeleteFiles command. The POST parameters would be filePath, merged with the $this->_defaults (containing the sessionToken).
| Name | Type | Description |
|---|---|---|
| $methodName | string | Name of the command to call on this namespace. |
| $args | array | Only the first is used and it must be an array. It contains the POST params. |
| Type | Description |
|---|---|
| \Zend_Service_Nirvanix_Response |
__construct(array $options = array()) : void
| Name | Type | Description |
|---|---|---|
| $options | array | Options and dependency injection |
_makeUri(string $methodName) : stringMake a complete URI from an RPC method name.
Inherited from: \Zend_Service_Nirvanix_Namespace_Base::_makeUri()All Nirvanix REST service URIs use the same format.
| Name | Type | Description |
|---|---|---|
| $methodName | string | RPC method name |
| Type | Description |
|---|---|
| string |
_wrapResponse(\Zend_Http_Response $httpResponse) : \Zend_Service_Nirvanix_ResponseAll Nirvanix REST service calls return an XML payload.
Inherited from: \Zend_Service_Nirvanix_Namespace_Base::_wrapResponse()This method makes a Zend_Service_Nirvanix_Response from that XML payload.
| Name | Type | Description |
|---|---|---|
| $httpResponse | \Zend_Http_Response | Raw response from Nirvanix |
| Type | Description |
|---|---|
| \Zend_Service_Nirvanix_Response | Wrapped response |
getContents(string $filePath, integer $expiration = 3600) : stringConvenience function to get the contents of a file on the Nirvanix IMFS.
Analog to PHP's file_get_contents().
| Name | Type | Description |
|---|---|---|
| $filePath | string | Remote path and filename |
| $expiration | integer | Number of seconds that Nirvanix make the file available for download. |
| Type | Description |
|---|---|
| string | Contents of file |
getHttpClient() : \Zend_Http_ClientReturn the HTTP client used for this namespace.
Inherited from: \Zend_Service_Nirvanix_Namespace_Base::getHttpClient()This is useful for inspecting the last request or directly interacting with the HTTP client.
| Type | Description |
|---|---|
| \Zend_Http_Client |
putContents(string $filePath, integer $data, string $mimeType = null) : \Zend_Service_Nirvanix_ResponseConvenience function to put the contents of a string into the Nirvanix IMFS.
Analog to PHP's file_put_contents().
| Name | Type | Description |
|---|---|---|
| $filePath | string | Remote path and filename |
| $data | integer | Data to store in the file |
| $mimeType | string | Mime type of data |
| Type | Description |
|---|---|
| \Zend_Service_Nirvanix_Response |
unlink(string $filePath) : \Zend_Service_Nirvanix_ResponseConvenience function to remove a file from the Nirvanix IMFS.
Analog to PHP's unlink().
| Name | Type | Description |
|---|---|---|
| $filePath | string | Remove path and filename |
| Type | Description |
|---|---|
| \Zend_Service_Nirvanix_Response |