Gdata/YouTube/ActivityEntry.php
Show:
inherited
inherited
Classes
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
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Health
- Version
- $Id$
\Zend_Gdata_YouTube_ActivityEntry
Package: Zend_Gdata\YouTube
A concrete class for working with YouTube user activity entries.
- Parent(s)
- \Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Link
- http://code.google.com/apis/youtube/
Constants
Properties
string $_entryClassName = 'Zend_Gdata_YouTube_ActivityEntry'The classname for individual user activity entry elements.
Default value
'Zend_Gdata_YouTube_ActivityEntry'Details- Type
- string
\Zend_Gdata_Extension_Rating $_rating = nullThe rating element that was part of the activity
Default value
nullDetails\Zend_Gdata_YouTube_Username $_username = nullThe username for the user that was part of the activity
Default value
nullDetails\Zend_Gdata_YouTube_VideoId $_videoId = nullThe ID of the video that was part of the activity
Default value
nullDetailsMethods
__construct(\DOMElement $element = null) : voidConstructs a new Zend_Gdata_YouTube_ActivityEntry object.
Parameters
| Name | Type | Description |
|---|---|---|
| $element | \DOMElement | (optional) The DOMElement on which to base this object. |
getActivityType() : string | nullReturn the activity type that was performed.
Convenience method that inspects category where scheme is
http://gdata.youtube.com/schemas/2007/userevents.cat.
Returns| Type | Description |
|---|---|
| string | null | The activity category if found. |
getAuthorName() : stringConvenience method to quickly get access to the author of the activity
Returns
| Type | Description |
|---|---|
| string | The author of the activity |
getDOM(\DOMDocument $doc = null, $majorVersion = 1, $minorVersion = null) : \DOMElementRetrieves 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.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $doc | \DOMDocument | The DOMDocument used to construct DOMElements |
| $majorVersion | ||
| $minorVersion |
| Type | Description |
|---|---|
| \DOMElement | The DOMElement representing this element and all child properties. |
getRating() : null | \Zend_Gdata_YouTube_Extension_RatingReturns the rating for this activity entry.
Returns
| Type | Description |
|---|---|
| null | \Zend_Gdata_YouTube_Extension_Rating |
getRatingValue() : integer | nullReturn the value of the rating for this video entry.
Convenience method to save needless typing.
Returns| Type | Description |
|---|---|
| integer | null | The value of the rating that was created, if found. |
getUsername() : null | \Zend_Gdata_YouTube_Extension_UsernameReturns the username for this activity entry.
Returns
| Type | Description |
|---|---|
| null | \Zend_Gdata_YouTube_Extension_Username |
getVideoId() : null | \Zend_Gdata_YouTube_Extension_VideoIdReturns the video ID for this activity entry.
Returns
| Type | Description |
|---|---|
| null | \Zend_Gdata_YouTube_Extension_VideoId |