API Documentation

Zend/Service/Nirvanix.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_Service  
Subpackage
Nirvanix  
Version
$Id: Nirvanix.php 24594 2012-01-05 21:27:01Z 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

Propertyprotected  $_options= ''

Options to pass to namespace proxies

Details
Type
$_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
Name Type Description
$authParams array

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

$options array

Options to pass to namespace proxies

methodpublicgetOptions( ) : array

Get the configured options.

Returns
Type Description
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
Name Type Description
$namespace string

Name of the namespace

$options
Returns
Type Description
\Zend_Service_Nirvanix_Namespace_Base
Documentation was generated by DocBlox 0.15.1.