Service/Nirvanix/Response.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: Response.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Service_Nirvanix_Response

Package: Zend\Service\Nirvanix
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 contains an error.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\SimpleXMLElement $_sxml
SimpleXMLElement parsed from Nirvanix web service response.

Methods

methodpublic__call( $method, array $args) : mixed

Delegate undefined methods to the decorated SimpleXMLElement.

Parameters
NameTypeDescription
$method
$argsarray

Method arguments

Returns
TypeDescription
mixed
methodpublic__construct(string $xml) : void

Class constructor.

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

Parameters
NameTypeDescription
$xmlstring

XML response string from Nirvanix

Throws
ExceptionDescription
\Zend_Service_Nirvanix_Exception
methodpublic__get(string $offset) : mixed

Delegate undefined properties to the decorated SimpleXMLElement.

Parameters
NameTypeDescription
$offsetstring

Undefined property name

Returns
TypeDescription
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
NameTypeDescription
$messagestring

Error message

$codeinteger

Error code

Throws
ExceptionDescription
\Zend_Service_Nirvanix_Exception
methodpublicgetSxml() : \SimpleXMLElement

Return the SimpleXMLElement representing this response for direct access.

Returns
TypeDescription
\SimpleXMLElement
Documentation was generated by phpDocumentor 2.0.0a12.