Zend/Gdata/Media/Extension/MediaTitle.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:title element in MediaRSS
  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_MediaTitle extends Zend_Gdata_Extension
  39 {
  40
  41     protected $_rootElement = 'title';
  42     protected $_rootNamespace = 'media';
  43
  44     /**
  45      * @var string
  46      */
  47     protected $_type = null;
  48
  49     /**
  50      * Constructs a MediaTitle element
  51      *
  52      * @param string $text
  53      * @param string $type
  54      */
  55     public function __construct($text = null, $type = null)
  56     {
  57         $this->registerAllNamespaces(Zend_Gdata_Media::$namespaces);
  58         parent::__construct();
  59         $this->_type = $type;
  60         $this->_text = $text;
  61     }
  62
  63     /**
  64      * Retrieves a DOMElement which corresponds to this element and all
  65      * child properties.  This is used to build an entry back into a DOM
  66      * and eventually XML text for sending to the server upon updates, or
  67      * for application storage/persistence.
  68      *
  69      * @param DOMDocument $doc The DOMDocument used to construct DOMElements
  70      * @return DOMElement The DOMElement representing this element and all
  71      * child properties.
  72      */
  73     public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)
  74     {
  75         $element = parent::getDOM($doc, $majorVersion, $minorVersion);
  76         if ($this->_type !== null) {
  77             $element->setAttribute('type', $this->_type);
  78         }
  79         return $element;
  80     }
  81
  82     /**
  83      * Given a DOMNode representing an attribute, tries to map the data into
  84      * instance members.  If no mapping is defined, the name and value are
  85      * stored in an array.
  86      *
  87      * @param DOMNode $attribute The DOMNode attribute needed to be handled
  88      */
  89     protected function takeAttributeFromDOM($attribute)
  90     {
  91         switch ($attribute->localName) {
  92         case 'type':
  93             $this->_type = $attribute->nodeValue;
  94             break;
  95         default:
  96             parent::takeAttributeFromDOM($attribute);
  97         }
  98     }
  99
 100     /**
 101      * @return string
 102      */
 103     public function getType()
 104     {
 105         return $this->_type;
 106     }
 107
 108     /**
 109      * @param string $value
 110      * @return Zend_Gdata_Media_Extension_MediaTitle Provides a fluent interface
 111      */
 112     public function setType($value)
 113     {
 114         $this->_type = $value;
 115         return $this;
 116     }
 117
 118 }