blob: 3c60e1bd2d3741229d9cb5d07d8260f24a33e759 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Gdata
* @subpackage Health
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: ActivityEntry.php 24593 2012-01-05 20:35:02Z matthew $
*/
/**
* @see Zend_Gdata_Entry
*/
require_once 'Zend/Gdata/Entry.php';
/**
* @see Zend_Gdata_YouTube_Extension_VideoId
*/
require_once 'Zend/Gdata/YouTube/Extension/VideoId.php';
/**
* @see Zend_Gdata_YouTube_Extension_Username
*/
require_once 'Zend/Gdata/YouTube/Extension/Username.php';
/**
* @see Zend_Gdata_YouTube_Extension_Rating
*/
require_once 'Zend/Gdata/Extension/Rating.php';
/**
* A concrete class for working with YouTube user activity entries.
*
* @link http://code.google.com/apis/youtube/
*
* @category Zend
* @package Zend_Gdata
* @subpackage YouTube
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Gdata_YouTube_ActivityEntry extends Zend_Gdata_Entry
{
const ACTIVITY_CATEGORY_SCHEME =
'http://gdata.youtube.com/schemas/2007/userevents.cat';
/**
* The classname for individual user activity entry elements.
*
* @var string
*/
protected $_entryClassName = 'Zend_Gdata_YouTube_ActivityEntry';
/**
* The ID of the video that was part of the activity
*
* @var Zend_Gdata_YouTube_VideoId
*/
protected $_videoId = null;
/**
* The username for the user that was part of the activity
*
* @var Zend_Gdata_YouTube_Username
*/
protected $_username = null;
/**
* The rating element that was part of the activity
*
* @var Zend_Gdata_Extension_Rating
*/
protected $_rating = null;
/**
* Constructs a new Zend_Gdata_YouTube_ActivityEntry object.
* @param DOMElement $element (optional) The DOMElement on which to
* base this object.
*/
public function __construct($element = null)
{
$this->registerAllNamespaces(Zend_Gdata_YouTube::$namespaces);
parent::__construct($element);
}
/**
* Retrieves a DOMElement which corresponds to this element and all
* child properties. This is used to build an entry back into a DOM
* and eventually XML text for application storage/persistence.
*
* @param DOMDocument $doc The DOMDocument used to construct DOMElements
* @return DOMElement The DOMElement representing this element and all
* child properties.
*/
public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)
{
$element = parent::getDOM($doc, $majorVersion, $minorVersion);
if ($this->_videoId !== null) {
$element->appendChild($this->_videoId->getDOM(
$element->ownerDocument));
}
if ($this->_username !== null) {
$element->appendChild($this->_username->getDOM(
$element->ownerDocument));
}
if ($this->_rating !== null) {
$element->appendChild($this->_rating->getDOM(
$element->ownerDocument));
}
return $element;
}
/**
* Creates individual Entry objects of the appropriate type and
* stores them as members of this entry based upon DOM data.
*
* @param DOMNode $child The DOMNode to process
*/
protected function takeChildFromDOM($child)
{
$absoluteNodeName = $child->namespaceURI . ':' . $child->localName;
switch ($absoluteNodeName) {
case $this->lookupNamespace('yt') . ':' . 'videoid':
$videoId = new Zend_Gdata_YouTube_Extension_VideoId();
$videoId->transferFromDOM($child);
$this->_videoId = $videoId;
break;
case $this->lookupNamespace('yt') . ':' . 'username':
$username = new Zend_Gdata_YouTube_Extension_Username();
$username->transferFromDOM($child);
$this->_username = $username;
break;
case $this->lookupNamespace('gd') . ':' . 'rating':
$rating = new Zend_Gdata_Extension_Rating();
$rating->transferFromDOM($child);
$this->_rating = $rating;
break;
default:
parent::takeChildFromDOM($child);
break;
}
}
/**
* Returns the video ID for this activity entry.
*
* @return null|Zend_Gdata_YouTube_Extension_VideoId
*/
public function getVideoId()
{
return $this->_videoId;
}
/**
* Returns the username for this activity entry.
*
* @return null|Zend_Gdata_YouTube_Extension_Username
*/
public function getUsername()
{
return $this->_username;
}
/**
* Returns the rating for this activity entry.
*
* @return null|Zend_Gdata_YouTube_Extension_Rating
*/
public function getRating()
{
return $this->_rating;
}
/**
* Return the value of the rating for this video entry.
*
* Convenience method to save needless typing.
*
* @return integer|null The value of the rating that was created, if found.
*/
public function getRatingValue()
{
$rating = $this->_rating;
if ($rating) {
return $rating->getValue();
}
return null;
}
/**
* Return the activity type that was performed.
*
* Convenience method that inspects category where scheme is
* http://gdata.youtube.com/schemas/2007/userevents.cat.
*
* @return string|null The activity category if found.
*/
public function getActivityType()
{
$categories = $this->getCategory();
foreach($categories as $category) {
if ($category->getScheme() == self::ACTIVITY_CATEGORY_SCHEME) {
return $category->getTerm();
}
}
return null;
}
/**
* Convenience method to quickly get access to the author of the activity
*
* @return string The author of the activity
*/
public function getAuthorName()
{
$authors = $this->getAuthor();
return $authors[0]->getName()->getText();
}
}
|
