/library/Zend/Gdata/Media/Extension/MediaDescription.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-2012 Zend Technologies USA Inc. (http://www.zend.com)
 20 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 21 * @version    $Id: MediaDescription.php 24594 2012-01-05 21:27:01Z matthew $
 22 */
 23
 24/**
 25 * @see Zend_Gdata_App_Extension
 26 */
 27require_once 'Zend/Gdata/App/Extension.php';
 28
 29/**
 30 * Represents the media:description element
 31 *
 32 * @category   Zend
 33 * @package    Zend_Gdata
 34 * @subpackage Media
 35 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
 36 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 37 */
 38class Zend_Gdata_Media_Extension_MediaDescription extends Zend_Gdata_Extension
 39{
 40
 41    protected $_rootElement = 'description';
 42    protected $_rootNamespace = 'media';
 43
 44    /**
 45     * @var string
 46     */
 47    protected $_type = null;
 48
 49    /**
 50     * @param string $text
 51     * @param string $type
 52     */
 53    public function __construct($text = null, $type = null)
 54    {
 55        $this->registerAllNamespaces(Zend_Gdata_Media::$namespaces);
 56        parent::__construct();
 57        $this->_type = $type;
 58        $this->_text = $text;
 59    }
 60
 61    /**
 62     * Retrieves a DOMElement which corresponds to this element and all
 63     * child properties.  This is used to build an entry back into a DOM
 64     * and eventually XML text for sending to the server upon updates, or
 65     * for application storage/persistence.
 66     *
 67     * @param DOMDocument $doc The DOMDocument used to construct DOMElements
 68     * @return DOMElement The DOMElement representing this element and all
 69     * child properties.
 70     */
 71    public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)
 72    {
 73        $element = parent::getDOM($doc, $majorVersion, $minorVersion);
 74        if ($this->_type !== null) {
 75            $element->setAttribute('type', $this->_type);
 76        }
 77        return $element;
 78    }
 79
 80    /**
 81     * Given a DOMNode representing an attribute, tries to map the data into
 82     * instance members.  If no mapping is defined, the name and value are
 83     * stored in an array.
 84     *
 85     * @param DOMNode $attribute The DOMNode attribute needed to be handled
 86     */
 87    protected function takeAttributeFromDOM($attribute)
 88    {
 89        switch ($attribute->localName) {
 90        case 'type':
 91            $this->_type = $attribute->nodeValue;
 92            break;
 93        default:
 94            parent::takeAttributeFromDOM($attribute);
 95        }
 96    }
 97
 98    /**
 99     * @return string
100     */
101    public function getType()
102    {
103        return $this->_type;
104    }
105
106    /**
107     * @param string $value
108     * @return Zend_Gdata_Media_Extension_MediaDescription Provides a fluent interface
109     */
110    public function setType($value)
111    {
112        $this->_type = $value;
113        return $this;
114    }
115
116}