API Documentation

Service/Nirvanix/Response.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_Service  
subpackage
Nirvanix  
version
$Id: Response.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_Nirvanix_Response

This class decorates a SimpleXMLElement parsed from a Nirvanix web service response. It is primarily exists to provide a convenience feature that throws an exception when <ResponseCode> contains an error.

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

Properties

Propertyprotected\SimpleXMLElement  $_sxml= ''

SimpleXMLElement parsed from Nirvanix web service response.

Details
Type
\SimpleXMLElement

Methods

methodpublic__call(  $method, array $args ) : mixed

Delegate undefined methods to the decorated SimpleXMLElement.

Parameters
Name Type Description
$method
$args array Method arguments
Returns
Type Description
mixed
methodpublic__construct( string $xml ) : void

Class constructor. Parse the XML response from a Nirvanix method call into a decorated SimpleXMLElement element.

Parameters
Name Type Description
$xml string XML response string from Nirvanix
Throws
Exception Description
\Zend_Service_Nirvanix_Exception
methodpublic__get( string $offset ) : mixed

Delegate undefined properties to the decorated SimpleXMLElement.

Parameters
Name Type Description
$offset string Undefined property name
Returns
Type Description
mixed
methodprotected_throwException( string $message, integer $code = null ) : void

Throw an exception. This method exists to only contain the lazy-require() of the exception class.

Parameters
Name Type Description
$message string Error message
$code integer Error code
Throws
Exception Description
\Zend_Service_Nirvanix_Exception
methodpublicgetSxml( ) : \SimpleXMLElement

Return the SimpleXMLElement representing this response for direct access.

Returns
Type Description
\SimpleXMLElement
Documentation was generated by DocBlox 0.13.3.