Service/Nirvanix.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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
Nirvanix  
Version
$Id: Nirvanix.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_Nirvanix

Package: Zend\Service\Nirvanix
This class allows Nirvanix authentication credentials to be specified in one place and provides a factory for returning convenience wrappers around the Nirvanix web service namespaces.
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_options
Options to pass to namespace proxies
Details
Type
n/a
$_options
array

Methods

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

Class constructor.

Authenticates with Nirvanix to receive a sessionToken, which is then passed to each future request.

Parameters
NameTypeDescription
$authParamsarray

Authentication POST parameters. This should have keys "username", "password", and "appKey".

$optionsarray

Options to pass to namespace proxies

methodpublicgetOptions() : array

Get the configured options.

Returns
TypeDescription
array
methodpublicgetService(string $namespace,  $options = array()) : \Zend_Service_Nirvanix_Namespace_Base

Nirvanix divides its service into namespaces, with each namespace providing different functionality.

This is a factory method that returns a preconfigured Zend_Service_Nirvanix_Namespace_Base proxy.

Parameters
NameTypeDescription
$namespacestring

Name of the namespace

$options
Returns
TypeDescription
\Zend_Service_Nirvanix_Namespace_Base
Documentation was generated by phpDocumentor 2.0.0a12.