API Documentation

Service/Nirvanix.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_Service
subpackage
Nirvanix
version
$Id: Nirvanix.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Service_Nirvanix

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_Service_Nirvanix

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_Service
subpackage
Nirvanix
Properties
$_options
Methods
__construct
getService
getOptions

Description

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.

Properties

$_options

 $_options = ''

Options to pass to namespace proxies

Details

visibility
protected
default
final
false
static
false
$_options
array

Methods

__construct

__construct( array $authParams, array $options = array ) :

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

Arguments
$authParams
array
Authentication POST parameters. This should have keys "username", "password", and "appKey".
$options
array
Options to pass to namespace proxies
Details
visibility
public
final
false
static
false

getOptions

getOptions( ) : array

Get the configured options.

Output
array
Details
visibility
public
final
false
static
false

getService

getService( 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.

Arguments
$namespace
string
Name of the namespace
$options
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.