Source for file GetAttributes.php

Documentation is available at GetAttributes.php

  1. <?php
  2. /** 
  3.  *  PHP Version 5
  4.  *
  5.  *  @category    Amazon
  6.  *  @package     Amazon_SimpleDB
  7.  *  @copyright   Copyright 2007 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: Wed Jul 23 00:24:22 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_GetAttributes
  32.  * 
  33.  * Properties:
  34.  * <ul>
  35.  * 
  36.  * <li>DomainName: string</li>
  37.  * <li>ItemName: string</li>
  38.  * <li>AttributeName: string</li>
  39.  *
  40.  * </ul>
  41.  */ 
  42. class Amazon_SimpleDB_Model_GetAttributes extends Amazon_SimpleDB_Model
  43. {
  44.  
  45.  
  46.     /**
  47.      * Construct new Amazon_SimpleDB_Model_GetAttributes
  48.      * 
  49.      * @param mixed $data DOMElement or Associative Array to construct from.
  50.      * 
  51.      *  Valid properties:
  52.      *  <ul>
  53.      * 
  54.      *  <li>DomainName: string</li>
  55.      *  <li>ItemName: string</li>
  56.      *  <li>AttributeName: string</li>
  57.      *
  58.      *  </ul>
  59.      */
  60.     public function __construct($data = null)
  61.     {
  62.         $this->_fields = array (
  63.         'DomainName' => array('FieldValue' => null, 'FieldType' => 'string'),
  64.         'ItemName' => array('FieldValue' => null, 'FieldType' => 'string'),
  65.         'AttributeName' => array('FieldValue' => array(), 'FieldType' => array('string')),
  66.         );
  67.         parent::__construct($data);
  68.     }
  69.  
  70.         /**
  71.      * Gets the value of the DomainName property.
  72.      * 
  73.      * @return string DomainName
  74.      */
  75.     public function getDomainName() 
  76.     {
  77.         return $this->_fields['DomainName']['FieldValue'];
  78.     }
  79.  
  80.     /**
  81.      * Sets the value of the DomainName property.
  82.      * 
  83.      * @param string DomainName
  84.      * @return this instance
  85.      */
  86.     public function setDomainName($value) 
  87.     {
  88.         $this->_fields['DomainName']['FieldValue'] = $value;
  89.         return $this;
  90.     }
  91.  
  92.     /**
  93.      * Sets the value of the DomainName and returns this instance
  94.      * 
  95.      * @param string $value DomainName
  96.      * @return Amazon_SimpleDB_Model_GetAttributes instance
  97.      */
  98.     public function withDomainName($value)
  99.     {
  100.         $this->setDomainName($value);
  101.         return $this;
  102.     }
  103.  
  104.  
  105.     /**
  106.      * Checks if DomainName is set
  107.      * 
  108.      * @return bool true if DomainName  is set
  109.      */
  110.     public function isSetDomainName()
  111.     {
  112.         return !is_null($this->_fields['DomainName']['FieldValue']);
  113.     }
  114.  
  115.     /**
  116.      * Gets the value of the ItemName property.
  117.      * 
  118.      * @return string ItemName
  119.      */
  120.     public function getItemName() 
  121.     {
  122.         return $this->_fields['ItemName']['FieldValue'];
  123.     }
  124.  
  125.     /**
  126.      * Sets the value of the ItemName property.
  127.      * 
  128.      * @param string ItemName
  129.      * @return this instance
  130.      */
  131.     public function setItemName($value) 
  132.     {
  133.         $this->_fields['ItemName']['FieldValue'] = $value;
  134.         return $this;
  135.     }
  136.  
  137.     /**
  138.      * Sets the value of the ItemName and returns this instance
  139.      * 
  140.      * @param string $value ItemName
  141.      * @return Amazon_SimpleDB_Model_GetAttributes instance
  142.      */
  143.     public function withItemName($value)
  144.     {
  145.         $this->setItemName($value);
  146.         return $this;
  147.     }
  148.  
  149.  
  150.     /**
  151.      * Checks if ItemName is set
  152.      * 
  153.      * @return bool true if ItemName  is set
  154.      */
  155.     public function isSetItemName()
  156.     {
  157.         return !is_null($this->_fields['ItemName']['FieldValue']);
  158.     }
  159.  
  160.     /**
  161.      * Gets the value of the AttributeName .
  162.      * 
  163.      * @return array of string AttributeName
  164.      */
  165.     public function getAttributeName() 
  166.     {
  167.         return $this->_fields['AttributeName']['FieldValue'];
  168.     }
  169.  
  170.     /**
  171.      * Sets the value of the AttributeName.
  172.      * 
  173.      * @param string or an array of string AttributeName
  174.      * @return this instance
  175.      */
  176.     public function setAttributeName($attributeName) 
  177.     {
  178.         if (!$this->_isNumericArray($attributeName)) {
  179.             $attributeName =  array ($attributeName);    
  180.         }
  181.         $this->_fields['AttributeName']['FieldValue'] = $attributeName;
  182.         return $this;
  183.     }
  184.   
  185.  
  186.     /**
  187.      * Sets single or multiple values of AttributeName list via variable number of arguments.
  188.      * For example, to set the list with two elements, simply pass two values as arguments to this function
  189.      * <code>withAttributeName($attributeName1, $attributeName2)</code>
  190.      * 
  191.      * @param string  $stringArgs one or more AttributeName
  192.      * @return Amazon_SimpleDB_Model_GetAttributes  instance
  193.      */
  194.     public function withAttributeName($stringArgs)
  195.     {
  196.         foreach (func_get_args() as $attributeName) {
  197.             $this->_fields['AttributeName']['FieldValue'][] = $attributeName;
  198.         }
  199.         return $this;
  200.     }  
  201.       
  202.  
  203.     /**
  204.      * Checks if AttributeName list is non-empty
  205.      * 
  206.      * @return bool true if AttributeName list is non-empty
  207.      */
  208.     public function isSetAttributeName()
  209.     {
  210.         return count ($this->_fields['AttributeName']['FieldValue']) > 0;
  211.     }
  212.  
  213.  
  214.  
  215.  
  216. }

Documentation generated on Wed, 23 Jul 2008 00:47:38 -0700 by phpDocumentor 1.4.2