Gdata/YouTube/Extension/Statistics.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
YouTube  
Version
$Id$  

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedinteger $_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 tag appears within a video entry.
Default valuenullDetails
Type
integer
>VPropertyprotectedstring $_lastWebAccess = null
The lastWebAccess attribute indicates the most recent time that a particular user used YouTube.
Default valuenullDetails
Type
string
>VPropertyprotected$_rootElement = 'statistics'
Default value'statistics'Details
Type
n/a
>VPropertyprotected$_rootNamespace = 'yt'
Default value'yt'Details
Type
n/a
>VPropertyprotectedinteger $_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
>VPropertyprotectedinteger $_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 tag appears within a user profile entry.
Default valuenullDetails
Type
integer
>VPropertyprotectedinteger $_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

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

Constructs a new Zend_Gdata_YouTube_Extension_Statistics object.

Parameters
NameTypeDescription
$viewCount
$videoWatchCount
$subscriberCount
$lastWebAccess
$favoriteCount
methodpublic__toString() : string

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

Returns
TypeDescription
string
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 sending to the server upon updates, or 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.
methodpublicgetFavoriteCount() : int

Get the value for this element's favoriteCount attribute.

Returns
TypeDescription
intThe value associated with this attribute.
methodpublicgetLastWebAccess() : int

Get the value for this element's lastWebAccess attribute.

Returns
TypeDescription
intThe value associated with this attribute.
methodpublicgetSubscriberCount() : int

Get the value for this element's subscriberCount attribute.

Returns
TypeDescription
intThe value associated with this attribute.
methodpublicgetVideoWatchCount() : int

Get the value for this element's videoWatchCount attribute.

Returns
TypeDescription
intThe value associated with this attribute.
methodpublicgetViewCount() : int

Get the value for this element's viewCount attribute.

Returns
TypeDescription
intThe value associated with this attribute.
methodpublicsetFavoriteCount(int $value) : \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's favoriteCount attribute.

Parameters
NameTypeDescription
$valueint

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_StatisticsThe element being modified.
methodpublicsetLastWebAccess(int $value) : \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's lastWebAccess attribute.

Parameters
NameTypeDescription
$valueint

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_StatisticsThe element being modified.
methodpublicsetSubscriberCount(int $value) : \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's subscriberCount attribute.

Parameters
NameTypeDescription
$valueint

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_StatisticsThe element being modified.
methodpublicsetVideoWatchCount(int $value) : \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's videoWatchCount attribute.

Parameters
NameTypeDescription
$valueint

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_StatisticsThe element being modified.
methodpublicsetViewCount(int $value) : \Zend_Gdata_YouTube_Extension_Statistics

Set the value for this element's viewCount attribute.

Parameters
NameTypeDescription
$valueint

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_StatisticsThe element being modified.
methodprotectedtakeAttributeFromDOM(\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
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

Documentation was generated by phpDocumentor 2.2.0 .