Gdata/YouTube/ActivityEntry.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Health
version: $Id: ActivityEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_YouTube_ActivityEntry

Description

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.

Zend_Gdata_YouTube_ActivityEntry
jump to top

Extends from: Zend_Gdata_Entry
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://code.google.com/apis/youtube/
package: Zend_Gdata
subpackage: YouTube
Constants: ACTIVITY_CATEGORY_SCHEME
Properties: $_entryClassName; $_videoId; $_username; $_rating
Methods: __construct; getDOM; takeChildFromDOM; getVideoId; getUsername; getRating; getRatingValue; getActivityType; getAuthorName

Description

A concrete class for working with YouTube user activity entries.

Constants

ACTIVITY_CATEGORY_SCHEME
jump to class

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

Details

value: http://gdata.youtube.com/schemas/2007/userevents.cat

Properties

$_entryClassName
jump to class

string $_entryClassName = 'Zend_Gdata_YouTube_ActivityEntry'

The classname for individual user activity entry elements.

Details

$_entryClassName: string
visibility: protected
default: Zend_Gdata_YouTube_ActivityEntry
final: false
static: false

$_rating
jump to class

Zend_Gdata_Extension_Rating $_rating = 'null'

The rating element that was part of the activity

Details

$_rating: Zend_Gdata_Extension_Rating
visibility: protected
default: null
final: false
static: false

$_username
jump to class

Zend_Gdata_YouTube_Username $_username = 'null'

The username for the user that was part of the activity

Details

$_username: Zend_Gdata_YouTube_Username
visibility: protected
default: null
final: false
static: false

$_videoId
jump to class

Zend_Gdata_YouTube_VideoId $_videoId = 'null'

The ID of the video that was part of the activity

Details

$_videoId: Zend_Gdata_YouTube_VideoId
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          DOMElement $element
              =
              null
          )
        
        :

Constructs a new Zend_Gdata_YouTube_ActivityEntry object.

Arguments

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

Details

visibility: public
final: false
static: false

getActivityType
jump to class

getActivityType(
          
          )
        
        :
        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.

Output

string|null: The activity category if found.

Details

visibility: public
final: false
static: false

getAuthorName
jump to class

getAuthorName(
          
          )
        
        :
        string

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

Output

string: The author of the activity

Details

visibility: public
final: false
static: false

getDOM
jump to class

getDOM(
          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.

Arguments

$doc: DOMDocument
The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion

Output

DOMElement: The DOMElement representing this element and all child properties.

Details

visibility: public
final: false
static: false

getRating
jump to class

getRating(
          
          )
        
        :
        null|Zend_Gdata_YouTube_Extension_Rating

Returns the rating for this activity entry.

Output

null|Zend_Gdata_YouTube_Extension_Rating

Details

visibility: public
final: false
static: false

getRatingValue
jump to class

getRatingValue(
          
          )
        
        :
        integer|null

Return the value of the rating for this video entry.

Convenience method to save needless typing.

Output

integer|null: The value of the rating that was created, if found.

Details

visibility: public
final: false
static: false

getUsername
jump to class

getUsername(
          
          )
        
        :
        null|Zend_Gdata_YouTube_Extension_Username

Returns the username for this activity entry.

Output

null|Zend_Gdata_YouTube_Extension_Username

Details

visibility: public
final: false
static: false

getVideoId
jump to class

getVideoId(
          
          )
        
        :
        null|Zend_Gdata_YouTube_Extension_VideoId

Returns the video ID for this activity entry.

Output

null|Zend_Gdata_YouTube_Extension_VideoId

Details

visibility: public
final: false
static: false

takeChildFromDOM
jump to class

takeChildFromDOM(
          DOMNode $child
          )
        
        :

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

Arguments

$child: DOMNode
The DOMNode to process

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/YouTube/ActivityEntry.php

Description

Zend_Gdata_YouTube_ActivityEntryjump to top

Description

Constants

ACTIVITY_CATEGORY_SCHEMEjump to class

Details

Properties

$_entryClassNamejump to class

Details

$_ratingjump to class

Details

$_usernamejump to class

Details

$_videoIdjump to class

Details

Methods

__constructjump to class

Arguments

Details

getActivityTypejump to class

Output

Details

getAuthorNamejump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getRatingjump to class

Output

Details

getRatingValuejump to class

Output

Details

getUsernamejump to class

Output

Details

getVideoIdjump to class

Output

Details

takeChildFromDOMjump to class

Arguments

Details

Zend_Gdata_YouTube_ActivityEntry
jump to top

ACTIVITY_CATEGORY_SCHEME
jump to class

$_entryClassName
jump to class

$_rating
jump to class

$_username
jump to class

$_videoId
jump to class

__construct
jump to class

getActivityType
jump to class

getAuthorName
jump to class

getDOM
jump to class

getRating
jump to class

getRatingValue
jump to class

getUsername
jump to class

getVideoId
jump to class

takeChildFromDOM
jump to class