Gdata/YouTube/Extension/Statistics.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: YouTube
version: $Id: Statistics.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_YouTube_Extension_Statistics

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_Extension_Statistics
jump to top

Extends from: Zend_Gdata_Extension
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: YouTube
Properties: $_rootNamespace; $_rootElement; $_videoWatchCount; $_viewCount; $_subscriberCount; $_lastWebAccess; $_favoriteCount
Methods: __construct; getDOM; takeAttributeFromDOM; getViewCount; setViewCount; getVideoWatchCount; setVideoWatchCount; getSubscriberCount; setSubscriberCount; getLastWebAccess; setLastWebAccess; getFavoriteCount; setFavoriteCount; __toString

Description

Represents the yt:statistics element used by the YouTube data API

Properties

$_favoriteCount
jump to class

integer $_favoriteCount = 'null'

The favoriteCount attribute specifies the number of YouTube users who have added a video to their list of favorite videos. The favoriteCount attribute is only specified when the <yt:statistics> tag appears within a video entry.

Details

$_favoriteCount: integer
visibility: protected
default: null
final: false
static: false

$_lastWebAccess
jump to class

string $_lastWebAccess = 'null'

The lastWebAccess attribute indicates the most recent time that a particular user used YouTube.

Details

$_lastWebAccess: string
visibility: protected
default: null
final: false
static: false

$_rootElement
jump to class

$_rootElement = 'statistics'

Details

visibility: protected
default: statistics
final: false
static: false

$_rootNamespace
jump to class

$_rootNamespace = 'yt'

Details

visibility: protected
default: yt
final: false
static: false

$_subscriberCount
jump to class

integer $_subscriberCount = 'null'

The subscriberCount attribute specifies the number of YouTube users who have subscribed to a particular user's YouTube channel.

The subscriberCount attribute is only specified when the tag appears within a user profile entry.

Details

$_subscriberCount: integer
visibility: protected
default: null
final: false
static: false

$_videoWatchCount
jump to class

integer $_videoWatchCount = 'null'

The videoWatchCount attribute specifies the number of videos that a user has watched on YouTube. The videoWatchCount attribute is only specified when the <yt:statistics> tag appears within a user profile entry.

Details

$_videoWatchCount: integer
visibility: protected
default: null
final: false
static: false

$_viewCount
jump to class

integer $_viewCount = 'null'

When the viewCount attribute refers to a video entry, the attribute specifies the number of times that the video has been viewed.

When the viewCount attribute refers to a user profile, the attribute specifies the number of times that the user's profile has been viewed.

Details

$_viewCount: integer
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
           $viewCount
              =
              null,  $videoWatchCount
              =
              null,  $subscriberCount
              =
              null,  $lastWebAccess
              =
              null,  $favoriteCount
              =
              null
          )
        
        :

Constructs a new Zend_Gdata_YouTube_Extension_Statistics object.

Arguments

$viewCount
$videoWatchCount
$subscriberCount
$lastWebAccess
$favoriteCount

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

Output

string

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 sending to the server upon updates, or 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

getFavoriteCount
jump to class

getFavoriteCount(
          
          )
        
        :
        int

Get the value for this element's favoriteCount attribute.

Output

int: The value associated with this attribute.

Details

visibility: public
final: false
static: false

getLastWebAccess
jump to class

getLastWebAccess(
          
          )
        
        :
        int

Get the value for this element's lastWebAccess attribute.

Output

int: The value associated with this attribute.

Details

visibility: public
final: false
static: false

getSubscriberCount
jump to class

getSubscriberCount(
          
          )
        
        :
        int

Get the value for this element's subscriberCount attribute.

Output

int: The value associated with this attribute.

Details

visibility: public
final: false
static: false

getVideoWatchCount
jump to class

getVideoWatchCount(
          
          )
        
        :
        int

Get the value for this element's videoWatchCount attribute.

Output

int: The value associated with this attribute.

Details

visibility: public
final: false
static: false

getViewCount
jump to class

getViewCount(
          
          )
        
        :
        int

Get the value for this element's viewCount attribute.

Output

int: The value associated with this attribute.

Details

visibility: public
final: false
static: false

setFavoriteCount
jump to class

setFavoriteCount(
          int $value
          )
        
        :
        Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's favoriteCount attribute.

Arguments

$value: int
The desired value for this attribute.

Output

Zend_Gdata_YouTube_Extension_Statistics: The element being modified.

Details

visibility: public
final: false
static: false

setLastWebAccess
jump to class

setLastWebAccess(
          int $value
          )
        
        :
        Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's lastWebAccess attribute.

Arguments

$value: int
The desired value for this attribute.

Output

Zend_Gdata_YouTube_Extension_Statistics: The element being modified.

Details

visibility: public
final: false
static: false

setSubscriberCount
jump to class

setSubscriberCount(
          int $value
          )
        
        :
        Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's subscriberCount attribute.

Arguments

$value: int
The desired value for this attribute.

Output

Zend_Gdata_YouTube_Extension_Statistics: The element being modified.

Details

visibility: public
final: false
static: false

setVideoWatchCount
jump to class

setVideoWatchCount(
          int $value
          )
        
        :
        Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's videoWatchCount attribute.

Arguments

$value: int
The desired value for this attribute.

Output

Zend_Gdata_YouTube_Extension_Statistics: The element being modified.

Details

visibility: public
final: false
static: false

setViewCount
jump to class

setViewCount(
          int $value
          )
        
        :
        Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's viewCount attribute.

Arguments

$value: int
The desired value for this attribute.

Output

Zend_Gdata_YouTube_Extension_Statistics: The element being modified.

Details

visibility: public
final: false
static: false

takeAttributeFromDOM
jump to class

takeAttributeFromDOM(
          DOMNode $attribute
          )
        
        :

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and valueare stored in an array.

TODO: Convert attributes to proper types

Arguments

$attribute: DOMNode
The DOMNode attribute needed to be handled

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/YouTube/Extension/Statistics.php

Description

Zend_Gdata_YouTube_Extension_Statisticsjump to top

Description

Properties

$_favoriteCountjump to class

Details

$_lastWebAccessjump to class

Details

$_rootElementjump to class

Details

$_rootNamespacejump to class

Details

$_subscriberCountjump to class

Details

$_videoWatchCountjump to class

Details

$_viewCountjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getFavoriteCountjump to class

Output

Details

getLastWebAccessjump to class

Output

Details

getSubscriberCountjump to class

Output

Details

getVideoWatchCountjump to class

Output

Details

getViewCountjump to class

Output

Details

setFavoriteCountjump to class

Arguments

Output

Details

setLastWebAccessjump to class

Arguments

Output

Details

setSubscriberCountjump to class

Arguments

Output

Details

setVideoWatchCountjump to class

Arguments

Output

Details

setViewCountjump to class

Arguments

Output

Details

takeAttributeFromDOMjump to class

Arguments

Details

Zend_Gdata_YouTube_Extension_Statistics
jump to top

$_favoriteCount
jump to class

$_lastWebAccess
jump to class

$_rootElement
jump to class

$_rootNamespace
jump to class

$_subscriberCount
jump to class

$_videoWatchCount
jump to class

$_viewCount
jump to class

__construct
jump to class

__toString
jump to class

getDOM
jump to class

getFavoriteCount
jump to class

getLastWebAccess
jump to class

getSubscriberCount
jump to class

getVideoWatchCount
jump to class

getViewCount
jump to class

setFavoriteCount
jump to class

setLastWebAccess
jump to class

setSubscriberCount
jump to class

setVideoWatchCount
jump to class

setViewCount
jump to class

takeAttributeFromDOM
jump to class