Zend/Gdata/YouTube/Extension/Statistics.php

Show:

inherited

Classes
- \Zend_Gdata_YouTube_Extension_Statistics

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 license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: YouTube
Version: $Id: Statistics.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_YouTube_Extension_Statistics
jump to top

Package: Zend\Gdata\YouTube

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

Parent(s): \Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

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.

Default valuenullDetails

Type: integer

string
                 $_lastWebAccess= 'null'

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

Default valuenullDetails

Type: string


                 $_rootElement= ''statistics''

Default value'statistics'Details

Type


                 $_rootNamespace= ''yt''

Default value'yt'Details

Type

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.

Default valuenullDetails

Type: integer

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.

Default valuenullDetails

Type: integer

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.

Default valuenullDetails

Type: integer

Methods

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

Constructs a new Zend_Gdata_YouTube_Extension_Statistics object.

Parameters

Name	Type	Description
$viewCount
$videoWatchCount
$subscriberCount
$lastWebAccess
$favoriteCount

__toString(
          
          )
        
        :
          string

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

Returns

Type	Description
string

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.

Parameters

Name	Type	Description
$doc	\DOMDocument	The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion

Returns

Type	Description
\DOMElement	The DOMElement representing this element and all child properties.

getFavoriteCount(
          
          )
        
        :
          int

Get the value for this element's favoriteCount attribute.

Returns

Type	Description
int	The value associated with this attribute.

getLastWebAccess(
          
          )
        
        :
          int

Get the value for this element's lastWebAccess attribute.

Returns

Type	Description
int	The value associated with this attribute.

getSubscriberCount(
          
          )
        
        :
          int

Get the value for this element's subscriberCount attribute.

Returns

Type	Description
int	The value associated with this attribute.

getVideoWatchCount(
          
          )
        
        :
          int

Get the value for this element's videoWatchCount attribute.

Returns

Type	Description
int	The value associated with this attribute.

getViewCount(
          
          )
        
        :
          int

Get the value for this element's viewCount attribute.

Returns

Type	Description
int	The value associated with this attribute.

setFavoriteCount(
          int $value
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's favoriteCount attribute.

Parameters

Name	Type	Description
$value	int	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Statistics	The element being modified.

setLastWebAccess(
          int $value
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's lastWebAccess attribute.

Parameters

Name	Type	Description
$value	int	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Statistics	The element being modified.

setSubscriberCount(
          int $value
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's subscriberCount attribute.

Parameters

Name	Type	Description
$value	int	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Statistics	The element being modified.

setVideoWatchCount(
          int $value
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's videoWatchCount attribute.

Parameters

Name	Type	Description
$value	int	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Statistics	The element being modified.

setViewCount(
          int $value
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's viewCount attribute.

Parameters

Name	Type	Description
$value	int	The desired value for this attribute.

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Statistics	The element being modified.

takeAttributeFromDOM(
          \DOMNode $attribute
          )
        
        :
          void

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

Parameters

Name	Type	Description
$attribute	\DOMNode	The DOMNode attribute needed to be handled

API Documentation

Zend/Gdata/YouTube/Extension/Statistics.php

\Zend_Gdata_YouTube_Extension_Statisticsjump to top

Properties

Methods

\Zend_Gdata_YouTube_Extension_Statistics
jump to top