Source for file QueryResponse.php

Documentation is available at QueryResponse.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_QueryResponse
  32.  * 
  33.  * Properties:
  34.  * <ul>
  35.  * 
  36.  * <li>QueryResult: Amazon_SimpleDB_Model_QueryResult</li>
  37.  * <li>ResponseMetadata: Amazon_SimpleDB_Model_ResponseMetadata</li>
  38.  *
  39.  * </ul>
  40.  */ 
  41. class Amazon_SimpleDB_Model_QueryResponse extends Amazon_SimpleDB_Model
  42. {
  43.  
  44.  
  45.     /**
  46.      * Construct new Amazon_SimpleDB_Model_QueryResponse
  47.      * 
  48.      * @param mixed $data DOMElement or Associative Array to construct from.
  49.      * 
  50.      *  Valid properties:
  51.      *  <ul>
  52.      * 
  53.      *  <li>QueryResult: Amazon_SimpleDB_Model_QueryResult</li>
  54.      *  <li>ResponseMetadata: Amazon_SimpleDB_Model_ResponseMetadata</li>
  55.      *
  56.      *  </ul>
  57.      */
  58.     public function __construct($data = null)
  59.     {
  60.         $this->_fields = array (
  61.         'QueryResult' => array('FieldValue' => null, 'FieldType' => 'Amazon_SimpleDB_Model_QueryResult'),
  62.         'ResponseMetadata' => array('FieldValue' => null, 'FieldType' => 'Amazon_SimpleDB_Model_ResponseMetadata'),
  63.         );
  64.         parent::__construct($data);
  65.     }
  66.  
  67.        
  68.     /**
  69.      * Construct Amazon_SimpleDB_Model_QueryResponse from XML string
  70.      * 
  71.      * @param string $xml XML string to construct from
  72.      * @return Amazon_SimpleDB_Model_QueryResponse 
  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:QueryResponse');
  81.         if ($response->length == 1) {
  82.             return new Amazon_SimpleDB_Model_QueryResponse(($response->item(0))); 
  83.         } else {
  84.             throw new Exception ("Unable to construct Amazon_SimpleDB_Model_QueryResponse from provided XML. 
  85.                                   Make sure that QueryResponse is a root element");
  86.         }
  87.           
  88.     }
  89.     
  90.     /**
  91.      * Gets the value of the QueryResult.
  92.      * 
  93.      * @return QueryResult QueryResult
  94.      */
  95.     public function getQueryResult() 
  96.     {
  97.         return $this->_fields['QueryResult']['FieldValue'];
  98.     }
  99.  
  100.     /**
  101.      * Sets the value of the QueryResult.
  102.      * 
  103.      * @param QueryResult QueryResult
  104.      * @return void 
  105.      */
  106.     public function setQueryResult($value) 
  107.     {
  108.         $this->_fields['QueryResult']['FieldValue'] = $value;
  109.         return;
  110.     }
  111.  
  112.     /**
  113.      * Sets the value of the QueryResult  and returns this instance
  114.      * 
  115.      * @param QueryResult $value QueryResult
  116.      * @return Amazon_SimpleDB_Model_QueryResponse instance
  117.      */
  118.     public function withQueryResult($value)
  119.     {
  120.         $this->setQueryResult($value);
  121.         return $this;
  122.     }
  123.  
  124.  
  125.     /**
  126.      * Checks if QueryResult  is set
  127.      * 
  128.      * @return bool true if QueryResult property is set
  129.      */
  130.     public function isSetQueryResult()
  131.     {
  132.         return !is_null($this->_fields['QueryResult']['FieldValue']);
  133.  
  134.     }
  135.  
  136.     /**
  137.      * Gets the value of the ResponseMetadata.
  138.      * 
  139.      * @return ResponseMetadata ResponseMetadata
  140.      */
  141.     public function getResponseMetadata() 
  142.     {
  143.         return $this->_fields['ResponseMetadata']['FieldValue'];
  144.     }
  145.  
  146.     /**
  147.      * Sets the value of the ResponseMetadata.
  148.      * 
  149.      * @param ResponseMetadata ResponseMetadata
  150.      * @return void 
  151.      */
  152.     public function setResponseMetadata($value) 
  153.     {
  154.         $this->_fields['ResponseMetadata']['FieldValue'] = $value;
  155.         return;
  156.     }
  157.  
  158.     /**
  159.      * Sets the value of the ResponseMetadata  and returns this instance
  160.      * 
  161.      * @param ResponseMetadata $value ResponseMetadata
  162.      * @return Amazon_SimpleDB_Model_QueryResponse instance
  163.      */
  164.     public function withResponseMetadata($value)
  165.     {
  166.         $this->setResponseMetadata($value);
  167.         return $this;
  168.     }
  169.  
  170.  
  171.     /**
  172.      * Checks if ResponseMetadata  is set
  173.      * 
  174.      * @return bool true if ResponseMetadata property is set
  175.      */
  176.     public function isSetResponseMetadata()
  177.     {
  178.         return !is_null($this->_fields['ResponseMetadata']['FieldValue']);
  179.  
  180.     }
  181.  
  182.  
  183.  
  184.     /**
  185.      * XML Representation for this object
  186.      * 
  187.      * @return string XML for this object
  188.      */
  189.     public function toXML() 
  190.     {
  191.         $xml = "";
  192.         $xml .= "<QueryResponse xmlns=\"http://sdb.amazonaws.com/doc/2007-11-07/\">";
  193.         $xml .= $this->_toXMLFragment();
  194.         $xml .= "</QueryResponse>";
  195.         return $xml;
  196.     }
  197.  
  198. }

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