Zend/Gdata/Media/Extension/MediaHash.php

   1 <?php
   2
   3 /**
   4  * Zend Framework
   5  *
   6  * LICENSE
   7  *
   8  * This source file is subject to the new BSD license that is bundled
   9  * with this package in the file LICENSE.txt.
  10  * It is also available through the world-wide-web at this URL:
  11  * http://framework.zend.com/license/new-bsd
  12  * If you did not receive a copy of the license and are unable to
  13  * obtain it through the world-wide-web, please send an email
  14  * to license@zend.com so we can send you a copy immediately.
  15  *
  16  * @category   Zend
  17  * @package    Zend_Gdata
  18  * @subpackage Media
  19  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  20  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  21
  22  */
  23
  24 /**
  25  * @see Zend_Gdata_App_Extension
  26  */
  27 require_once 'Zend/Gdata/App/Extension.php';
  28
  29 /**
  30  * Represents the media:hash element
  31  *
  32  * @category   Zend
  33  * @package    Zend_Gdata
  34  * @subpackage Media
  35  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  36  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  37  */
  38 class Zend_Gdata_Media_Extension_MediaHash extends Zend_Gdata_Extension
  39 {
  40
  41     protected $_rootElement = 'hash';
  42     protected $_rootNamespace = 'media';
  43     protected $_algo = null;
  44
  45     /**
  46      * Constructs a new MediaHash element
  47      *
  48      * @param string $text
  49      * @param string $algo
  50      */
  51     public function __construct($text = null, $algo = null)
  52     {
  53         $this->registerAllNamespaces(Zend_Gdata_Media::$namespaces);
  54         parent::__construct();
  55         $this->_text = $text;
  56         $this->_algo = $algo;
  57     }
  58
  59     /**
  60      * Retrieves a DOMElement which corresponds to this element and all
  61      * child properties.  This is used to build an entry back into a DOM
  62      * and eventually XML text for sending to the server upon updates, or
  63      * for application storage/persistence.
  64      *
  65      * @param DOMDocument $doc The DOMDocument used to construct DOMElements
  66      * @return DOMElement The DOMElement representing this element and all
  67      * child properties.
  68      */
  69     public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)
  70     {
  71         $element = parent::getDOM($doc, $majorVersion, $minorVersion);
  72         if ($this->_algo !== null) {
  73             $element->setAttribute('algo', $this->_algo);
  74         }
  75         return $element;
  76     }
  77
  78     /**
  79      * Given a DOMNode representing an attribute, tries to map the data into
  80      * instance members.  If no mapping is defined, the name and value are
  81      * stored in an array.
  82      *
  83      * @param DOMNode $attribute The DOMNode attribute needed to be handled
  84      * @throws Zend_Gdata_App_InvalidArgumentException
  85      */
  86     protected function takeAttributeFromDOM($attribute)
  87     {
  88         switch ($attribute->localName) {
  89         case 'algo':
  90             $this->_algo = $attribute->nodeValue;
  91             break;
  92         default:
  93             parent::takeAttributeFromDOM($attribute);
  94         }
  95     }
  96
  97     /**
  98      * @return string The algo
  99      */
 100     public function getAlgo()
 101     {
 102         return $this->_algo;
 103     }
 104
 105     /**
 106      * @param string $value
 107      * @return Zend_Gdata_Media_Extension_MediaHash Provides a fluent interface
 108      */
 109     public function setAlgo($value)
 110     {
 111         $this->_algo = $value;
 112         return $this;
 113     }
 114
 115 }