Zend/Gdata/YouTube/InboxEntry.php

Show:

inherited

Classes
- \Zend_Gdata_YouTube_InboxEntry

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: InboxEntry.php 24593 2012-01-05 20:35:02Z matthew $

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

Properties

\Zend_Gdata_Extension_Comments
                 $_comments= 'null'

The gd:comments element of this entry.

Default valuenullDetails

Type: \Zend_Gdata_Extension_Comments

\Zend_Gdata_YouTube_Extension_Description
                 $_description= 'null'

The yt:description element of this entry.

Default valuenullDetails

Type: \Zend_Gdata_YouTube_Extension_Description


                 $_entryClassName= ''Zend_Gdata_YouTube_InboxEntry''

Default value'Zend_Gdata_YouTube_InboxEntry'Details

Type

\Zend_Gdata_Extension_Rating
                 $_rating= 'null'

The gd:rating element of this entry.

Default valuenullDetails

Type: \Zend_Gdata_Extension_Rating

\Zend_Gdata_YouTube_Extension_Statistics
                 $_statistics= 'null'

The yt:statistics element of this entry.

Default valuenullDetails

Type: \Zend_Gdata_YouTube_Extension_Statistics

Methods

__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

Name	Type	Description
$element	\DOMElement	(optional) DOMElement from which this object should be constructed.

getComments(
          
          )
        
        :
          \Zend_Gdata_Extension_Comments|null

Get the gd:comments element of the inbox entry.

Returns

Type	Description
\Zend_Gdata_Extension_Comments\|null

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.

getDescription(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Description|null

Get the yt:description

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Description\|null

Throws

Exception	Description
\Zend_Gdata_App_VersionException

getRating(
          
          )
        
        :
          \Zend_Gdata_Extension_Rating|null

Get the gd:rating element for the inbox entry

Returns

Type	Description
\Zend_Gdata_Extension_Rating\|null

getStatistics(
          
          )
        
        :
          \Zend_Gdata_YouTube_Extension_Statistics|null

Get the yt:statistics element for the inbox entry

Returns

Type	Description
\Zend_Gdata_YouTube_Extension_Statistics\|null

setComments(
          \Zend_Gdata_Extension_Comments $comments
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_InboxEntry

Sets the gd:comments element for the inbox entry

Parameters

Name	Type	Description
$comments	\Zend_Gdata_Extension_Comments	The comments feed link

Returns

Type	Description
\Zend_Gdata_YouTube_InboxEntry	Provides a fluent interface

setDescription(
          \Zend_Gdata_YouTube_Extension_Description $description
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_InboxEntry

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

Parameters

Name	Type	Description
$description	\Zend_Gdata_YouTube_Extension_Description	The description.

Returns

Type	Description
\Zend_Gdata_YouTube_InboxEntry	Provides a fluent interface

Throws

Exception	Description
\Zend_Gdata_App_VersionException

setRating(
          \Zend_Gdata_Extension_Rating $rating
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_InboxEntry

Sets the gd:rating element for the inbox entry

Parameters

Name	Type	Description
$rating	\Zend_Gdata_Extension_Rating	The rating for the video in the message

Returns

Type	Description
\Zend_Gdata_YouTube_InboxEntry	Provides a fluent interface

setStatistics(
          \Zend_Gdata_YouTube_Extension_Statistics $statistics
              =
              null
          )
        
        :
          \Zend_Gdata_YouTube_InboxEntry

Sets the yt:statistics element for the inbox entry

Parameters

Name	Type	Description
$statistics	\Zend_Gdata_YouTube_Extension_Statistics	The statistics element for the video in the message

Returns

Type	Description
\Zend_Gdata_YouTube_InboxEntry	Provides a fluent interface

takeChildFromDOM(
          \DOMNode $child
          )
        
        :
          void

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

Parameters

Name	Type	Description
$child	\DOMNode	The DOMNode to process

API Documentation

Zend/Gdata/YouTube/InboxEntry.php

\Zend_Gdata_YouTube_InboxEntryjump to top

Properties

Methods

\Zend_Gdata_YouTube_InboxEntry
jump to top