Gdata/YouTube/ActivityEntry.php

Show: PublicProtectedPrivateinherited
Table of Contents
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 [email protected] 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

>VConstant  ACTIVITY_CATEGORY_SCHEME = 'http://gdata.youtube.com/schemas/2007/userevents.cat'

Properties

>VPropertyprotectedstring $_entryClassName = 'Zend_Gdata_YouTube_ActivityEntry'
The classname for individual user activity entry elements.
Default value'Zend_Gdata_YouTube_ActivityEntry'Details
Type
string
>VPropertyprotected\Zend_Gdata_Extension_Rating $_rating = null
The rating element that was part of the activity
Default valuenullDetails
Type
\Zend_Gdata_Extension_Rating
>VPropertyprotected\Zend_Gdata_YouTube_Username $_username = null
The username for the user that was part of the activity
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Username
>VPropertyprotected\Zend_Gdata_YouTube_VideoId $_videoId = null
The ID of the video that was part of the activity
Default valuenullDetails
Type
\Zend_Gdata_YouTube_VideoId

Methods

methodpublic__construct(\DOMElement $element = null) : void

Constructs a new Zend_Gdata_YouTube_ActivityEntry object.

Parameters
NameTypeDescription
$element\DOMElement

(optional) The DOMElement on which to base this object.

methodpublicgetActivityType() : string | null

Return the activity type that was performed.

Convenience method that inspects category where scheme is http://gdata.youtube.com/schemas/2007/userevents.cat.
Returns
TypeDescription
string | nullThe activity category if found.
methodpublicgetAuthorName() : string

Convenience method to quickly get access to the author of the activity

Returns
TypeDescription
stringThe author of the activity
methodpublicgetDOM(\DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null) : \DOMElement

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.

Parameters
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetRating() : null | \Zend_Gdata_YouTube_Extension_Rating

Returns the rating for this activity entry.

Returns
TypeDescription
null | \Zend_Gdata_YouTube_Extension_Rating
methodpublicgetRatingValue() : integer | null

Return the value of the rating for this video entry.

Convenience method to save needless typing.
Returns
TypeDescription
integer | nullThe value of the rating that was created, if found.
methodpublicgetUsername() : null | \Zend_Gdata_YouTube_Extension_Username

Returns the username for this activity entry.

Returns
TypeDescription
null | \Zend_Gdata_YouTube_Extension_Username
methodpublicgetVideoId() : null | \Zend_Gdata_YouTube_Extension_VideoId

Returns the video ID for this activity entry.

Returns
TypeDescription
null | \Zend_Gdata_YouTube_Extension_VideoId
methodprotectedtakeChildFromDOM(\DOMNode $child) : void

Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

Documentation was generated by phpDocumentor 2.2.0 .