Source for file ErrorResponse.php

Documentation is available at ErrorResponse.php

  1. <?php
  2. /** 
  3.  *  PHP Version 5
  4.  *
  5.  *  @category    Amazon
  6.  *  @package     Amazon_SimpleDB
  7.  *  @copyright   Copyright 2008 Amazon Technologies, Inc.
  8.  *  @link        http://aws.amazon.com
  9.  *  @license     http://aws.amazon.com/apache2.0  Apache License, Version 2.0
  10.  *  @version     2007-11-07
  11.  */
  12. /******************************************************************************* 
  13.  *    __  _    _  ___ 
  14.  *   (  )( \/\/ )/ __)
  15.  *   /__\ \    / \__ \
  16.  *  (_)(_) \/\/  (___/
  17.  * 
  18.  *  Amazon Simple DB PHP5 Library
  19.  *  Generated: Thu Aug 28 06:20:51 PDT 2008
  20.  * 
  21.  */
  22.  
  23. /**
  24.  *  @see Amazon_SimpleDB_Model
  25.  */
  26. require_once ('Amazon/SimpleDB/Model.php');  
  27.  
  28.     
  29.  
  30. /**
  31.  * Amazon_SimpleDB_Model_ErrorResponse
  32.  * 
  33.  * Properties:
  34.  * <ul>
  35.  * 
  36.  * <li>Error: Amazon_SimpleDB_Model_Error</li>
  37.  * <li>RequestId: string</li>
  38.  *
  39.  * </ul>
  40.  */ 
  41. class Amazon_SimpleDB_Model_ErrorResponse extends Amazon_SimpleDB_Model
  42. {
  43.  
  44.  
  45.     /**
  46.      * Construct new Amazon_SimpleDB_Model_ErrorResponse
  47.      * 
  48.      * @param mixed $data DOMElement or Associative Array to construct from.
  49.      * 
  50.      *  Valid properties:
  51.      *  <ul>
  52.      * 
  53.      *  <li>Error: Amazon_SimpleDB_Model_Error</li>
  54.      *  <li>RequestId: string</li>
  55.      *
  56.      *  </ul>
  57.      */
  58.     public function __construct($data = null)
  59.     {
  60.         $this->_fields = array (
  61.         'Error' => array('FieldValue' => array(), 'FieldType' => array('Amazon_SimpleDB_Model_Error')),
  62.         'RequestId' => array('FieldValue' => null, 'FieldType' => 'string'),
  63.         );
  64.         parent::__construct($data);
  65.     }
  66.  
  67.        
  68.     /**
  69.      * Construct Amazon_SimpleDB_Model_ErrorResponse from XML string
  70.      * 
  71.      * @param string $xml XML string to construct from
  72.      * @return Amazon_SimpleDB_Model_ErrorResponse 
  73.      */
  74.     public static function fromXML($xml)
  75.     {
  76.         $dom = new DOMDocument();
  77.         $dom->loadXML($xml);
  78.         $xpath = new DOMXPath($dom);
  79.         $xpath->registerNamespace('a', 'http://sdb.amazonaws.com/doc/2007-11-07/');
  80.         $response = $xpath->query('//a:${ActionName}Response');
  81.         if ($response->length == 1) {
  82.             return new Amazon_SimpleDB_Model_ErrorResponse(($response->item(0))); 
  83.         } else {
  84.             throw new Exception ("Unable to construct Amazon_SimpleDB_Model_ErrorResponse from provided XML. 
  85.                                   Make sure that ${ActionName}Response is a root element");
  86.         }
  87.           
  88.     }
  89.     
  90.     /**
  91.      * Gets the value of the Error.
  92.      * 
  93.      * @return array of Error Error
  94.      */
  95.     public function getError() 
  96.     {
  97.         return $this->_fields['Error']['FieldValue'];
  98.     }
  99.  
  100.     /**
  101.      * Sets the value of the Error.
  102.      * 
  103.      * @param mixed Error or an array of Error Error
  104.      * @return this instance
  105.      */
  106.     public function setError($error) 
  107.     {
  108.         if (!$this->_isNumericArray($error)) {
  109.             $error =  array ($error);    
  110.         }
  111.         $this->_fields['Error']['FieldValue'] = $error;
  112.         return $this;
  113.     }
  114.  
  115.  
  116.     /**
  117.      * Sets single or multiple values of Error list via variable number of arguments.
  118.      * For example, to set the list with two elements, simply pass two values as arguments to this function
  119.      * <code>withError($error1, $error2)</code>
  120.      * 
  121.      * @param Error  $errorArgs one or more Error
  122.      * @return Amazon_SimpleDB_Model_ErrorResponse  instance
  123.      */
  124.     public function withError($errorArgs)
  125.     {
  126.         foreach (func_get_args() as $error) {
  127.             $this->_fields['Error']['FieldValue'][] = $error;
  128.         }
  129.         return $this;
  130.     }   
  131.  
  132.  
  133.  
  134.     /**
  135.      * Checks if Error list is non-empty
  136.      * 
  137.      * @return bool true if Error list is non-empty
  138.      */
  139.     public function isSetError()
  140.     {
  141.         return count ($this->_fields['Error']['FieldValue']) > 0;
  142.     }
  143.  
  144.     /**
  145.      * Gets the value of the RequestId property.
  146.      * 
  147.      * @return string RequestId
  148.      */
  149.     public function getRequestId() 
  150.     {
  151.         return $this->_fields['RequestId']['FieldValue'];
  152.     }
  153.  
  154.     /**
  155.      * Sets the value of the RequestId property.
  156.      * 
  157.      * @param string RequestId
  158.      * @return this instance
  159.      */
  160.     public function setRequestId($value) 
  161.     {
  162.         $this->_fields['RequestId']['FieldValue'] = $value;
  163.         return $this;
  164.     }
  165.  
  166.     /**
  167.      * Sets the value of the RequestId and returns this instance
  168.      * 
  169.      * @param string $value RequestId
  170.      * @return Amazon_SimpleDB_Model_ErrorResponse instance
  171.      */
  172.     public function withRequestId($value)
  173.     {
  174.         $this->setRequestId($value);
  175.         return $this;
  176.     }
  177.  
  178.  
  179.     /**
  180.      * Checks if RequestId is set
  181.      * 
  182.      * @return bool true if RequestId  is set
  183.      */
  184.     public function isSetRequestId()
  185.     {
  186.         return !is_null($this->_fields['RequestId']['FieldValue']);
  187.     }
  188.  
  189.  
  190.  
  191.     /**
  192.      * XML Representation for this object
  193.      * 
  194.      * @return string XML for this object
  195.      */
  196.     public function toXML() 
  197.     {
  198.         $xml = "";
  199.         $xml .= "<ErrorResponse xmlns=\"http://sdb.amazonaws.com/doc/2007-11-07/\">";
  200.         $xml .= $this->_toXMLFragment();
  201.         $xml .= "</ErrorResponse>";
  202.         return $xml;
  203.     }
  204.  
  205. }

Documentation generated on Thu, 28 Aug 2008 06:35:47 -0700 by phpDocumentor 1.4.2