/zf/library/Zend/Gdata/YouTube/Extension/Position.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 YouTube
19 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
20 * @license    http://framework.zend.com/license/new-bsd     New BSD License
21 * @version    $Id: Position.php 23775 2011-03-01 17:25:24Z ralph $
22 */
23
24/**
25 * @see Zend_Gdata_Extension
26 */
27require_once 'Zend/Gdata/Extension.php';
28
29/**
30 * Data model class to represent a playlist item's position in the list (yt:position)
31 *
32 * @category   Zend
33 * @package    Zend_Gdata
34 * @subpackage YouTube
35 * @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
36 * @license    http://framework.zend.com/license/new-bsd     New BSD License
37 */
38class Zend_Gdata_YouTube_Extension_Position extends Zend_Gdata_Extension
39{
40
41    protected $_rootElement = 'position';
42    protected $_rootNamespace = 'yt';
43
44    /**
45     * Constructs a new Zend_Gdata_YouTube_Extension_Position object.
46     *
47     * @param string $value (optional) The 1-based position in the playlist
48     */
49    public function __construct($value = null)
50    {
51        $this->registerAllNamespaces(Zend_Gdata_YouTube::$namespaces);
52        parent::__construct();
53        $this->_text = $value;
54    }
55
56    /**
57     * Get the value for the position in the playlist
58     *
59     * @return int The 1-based position in the playlist
60     */
61    public function getValue()
62    {
63        return $this->_text;
64    }
65
66    /**
67     * Set the value for the position in the playlist
68     *
69     * @param int $value The 1-based position in the playlist
70     * @return Zend_Gdata_Extension_Visibility The element being modified
71     */
72    public function setValue($value)
73    {
74        $this->_text = $value;
75        return $this;
76    }
77
78    /**
79     * Magic toString method allows using this directly via echo
80     * Works best in PHP >= 4.2.0
81     *
82     * @return string
83     */
84    public function __toString()
85    {
86        return $this->getValue();
87    }
88
89}
90