Gdata/YouTube/InboxEntry.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 license@zend.com 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_InboxEntry
jump to top

Package: Zend_Gdata\YouTube
Represents the YouTube message flavor of an Atom entry
Parent(s)
\Zend_Gdata_Media_Entry < \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  

Properties

>VPropertyprotected\Zend_Gdata_Extension_Comments $_comments = null
The gd:comments element of this entry.
Default valuenullDetails
Type
\Zend_Gdata_Extension_Comments
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Description $_description = null
The yt:description element of this entry.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Description
>VPropertyprotected$_entryClassName = 'Zend_Gdata_YouTube_InboxEntry'
Default value'Zend_Gdata_YouTube_InboxEntry'Details
Type
n/a
>VPropertyprotected\Zend_Gdata_Extension_Rating $_rating = null
The gd:rating element of this entry.
Default valuenullDetails
Type
\Zend_Gdata_Extension_Rating
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Statistics $_statistics = null
The yt:statistics element of this entry.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Statistics

Methods

methodpublic__construct(\DOMElement $element = null) : void

Creates a subscription entry, representing an individual subscription in a list of subscriptions, usually associated with an individual user.

Parameters
NameTypeDescription
$element\DOMElement

(optional) DOMElement from which this

     object should be constructed.
methodpublicgetComments() : \Zend_Gdata_Extension_Comments | null

Get the gd:comments element of the inbox entry.

Returns
TypeDescription
\Zend_Gdata_Extension_Comments | null
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.
methodpublicgetDescription() : \Zend_Gdata_YouTube_Extension_Description | null

Get the yt:description

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_Description | null
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetRating() : \Zend_Gdata_Extension_Rating | null

Get the gd:rating element for the inbox entry

Returns
TypeDescription
\Zend_Gdata_Extension_Rating | null
methodpublicgetStatistics() : \Zend_Gdata_YouTube_Extension_Statistics | null

Get the yt:statistics element for the inbox entry

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_Statistics | null
methodpublicsetComments(\Zend_Gdata_Extension_Comments $comments = null) : \Zend_Gdata_YouTube_InboxEntry

Sets the gd:comments element for the inbox entry

Parameters
NameTypeDescription
$comments\Zend_Gdata_Extension_Comments

The comments feed link

Returns
TypeDescription
\Zend_Gdata_YouTube_InboxEntryProvides a fluent interface
methodpublicsetDescription(\Zend_Gdata_YouTube_Extension_Description $description = null) : \Zend_Gdata_YouTube_InboxEntry

Sets the yt:description element for a new inbox entry.

Parameters
NameTypeDescription
$description\Zend_Gdata_YouTube_Extension_Description

The description.

Returns
TypeDescription
\Zend_Gdata_YouTube_InboxEntryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicsetRating(\Zend_Gdata_Extension_Rating $rating = null) : \Zend_Gdata_YouTube_InboxEntry

Sets the gd:rating element for the inbox entry

Parameters
NameTypeDescription
$rating\Zend_Gdata_Extension_Rating

The rating for the video in the message

Returns
TypeDescription
\Zend_Gdata_YouTube_InboxEntryProvides a fluent interface
methodpublicsetStatistics(\Zend_Gdata_YouTube_Extension_Statistics $statistics = null) : \Zend_Gdata_YouTube_InboxEntry

Sets the yt:statistics element for the inbox entry

Parameters
NameTypeDescription
$statistics\Zend_Gdata_YouTube_Extension_Statistics

The statistics element for the video in the message

Returns
TypeDescription
\Zend_Gdata_YouTube_InboxEntryProvides a fluent interface
methodprotectedtakeChildFromDOM(\DOMNode $child) : void

Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

Documentation was generated by phpDocumentor 2.2.0 .