Gdata/YouTube/InboxEntry.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: InboxEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_YouTube_InboxEntry

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

Extends from: Zend_Gdata_Media_Entry
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: $_entryClassName; $_comments; $_rating; $_statistics; $_description
Methods: __construct; getDOM; takeChildFromDOM; getDescription; setDescription; getRating; setRating; getComments; setComments; getStatistics; setStatistics

Description

Represents the YouTube message flavor of an Atom entry

Properties

$_comments
jump to class

Zend_Gdata_Extension_Comments $_comments = 'null'

The gd:comments element of this entry.

Details

$_comments: Zend_Gdata_Extension_Comments
visibility: protected
default: null
final: false
static: false

$_description
jump to class

Zend_Gdata_YouTube_Extension_Description $_description = 'null'

The yt:description element of this entry.

Details

$_description: Zend_Gdata_YouTube_Extension_Description
visibility: protected
default: null
final: false
static: false

$_entryClassName
jump to class

$_entryClassName = 'Zend_Gdata_YouTube_InboxEntry'

Details

visibility: protected
default: Zend_Gdata_YouTube_InboxEntry
final: false
static: false

$_rating
jump to class

Zend_Gdata_Extension_Rating $_rating = 'null'

The gd:rating element of this entry.

Details

$_rating: Zend_Gdata_Extension_Rating
visibility: protected
default: null
final: false
static: false

$_statistics
jump to class

Zend_Gdata_YouTube_Extension_Statistics $_statistics = 'null'

The yt:statistics element of this entry.

Details

$_statistics: Zend_Gdata_YouTube_Extension_Statistics
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          DOMElement $element
              =
              null
          )
        
        :

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

Arguments

$element: DOMElement
(optional) DOMElement from which this object should be constructed.

Details

visibility: public
final: false
static: false

getComments
jump to class

getComments(
          
          )
        
        :
        Zend_Gdata_Extension_Comments|null

Get the gd:comments element of the inbox entry.

Output

Zend_Gdata_Extension_Comments|null

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

getDescription
jump to class

getDescription(
          
          )
        
        :
        Zend_Gdata_YouTube_Extension_Description|null

Get the yt:description

Output

Zend_Gdata_YouTube_Extension_Description|null

Details

visibility: public
final: false
static: false
throws

getRating
jump to class

getRating(
          
          )
        
        :
        Zend_Gdata_Extension_Rating|null

Get the gd:rating element for the inbox entry

Output

Zend_Gdata_Extension_Rating|null

Details

visibility: public
final: false
static: false

getStatistics
jump to class

getStatistics(
          
          )
        
        :
        Zend_Gdata_YouTube_Extension_Statistics|null

Get the yt:statistics element for the inbox entry

Output

Zend_Gdata_YouTube_Extension_Statistics|null

Details

visibility: public
final: false
static: false

setComments
jump to class

setComments(
          Zend_Gdata_Extension_Comments $comments
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_InboxEntry

Sets the gd:comments element for the inbox entry

Arguments

$comments: Zend_Gdata_Extension_Comments
The comments feed link

Output

Zend_Gdata_YouTube_InboxEntry: Provides a fluent interface

Details

visibility: public
final: false
static: false

setDescription
jump to class

setDescription(
          Zend_Gdata_YouTube_Extension_Description $description
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_InboxEntry

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

Arguments

$description: Zend_Gdata_YouTube_Extension_Description
The description.

Output

Zend_Gdata_YouTube_InboxEntry: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setRating
jump to class

setRating(
          Zend_Gdata_Extension_Rating $rating
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_InboxEntry

Sets the gd:rating element for the inbox entry

Arguments

$rating: Zend_Gdata_Extension_Rating
The rating for the video in the message

Output

Zend_Gdata_YouTube_InboxEntry: Provides a fluent interface

Details

visibility: public
final: false
static: false

setStatistics
jump to class

setStatistics(
          Zend_Gdata_YouTube_Extension_Statistics $statistics
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_InboxEntry

Sets the yt:statistics element for the inbox entry

Arguments

$statistics: Zend_Gdata_YouTube_Extension_Statistics
The statistics element for the video in the message

Output

Zend_Gdata_YouTube_InboxEntry: Provides a fluent interface

Details

visibility: public
final: false
static: false

takeChildFromDOM
jump to class

takeChildFromDOM(
          DOMNode $child
          )
        
        :

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

Arguments

$child: DOMNode
The DOMNode to process

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/YouTube/InboxEntry.php

Description

Zend_Gdata_YouTube_InboxEntryjump to top

Description

Properties

$_commentsjump to class

Details

$_descriptionjump to class

Details

$_entryClassNamejump to class

Details

$_ratingjump to class

Details

$_statisticsjump to class

Details

Methods

__constructjump to class

Arguments

Details

getCommentsjump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getDescriptionjump to class

Output

Details

getRatingjump to class

Output

Details

getStatisticsjump to class

Output

Details

setCommentsjump to class

Arguments

Output

Details

setDescriptionjump to class

Arguments

Output

Details

setRatingjump to class

Arguments

Output

Details

setStatisticsjump to class

Arguments

Output

Details

takeChildFromDOMjump to class

Arguments

Details

Zend_Gdata_YouTube_InboxEntry
jump to top

$_comments
jump to class

$_description
jump to class

$_entryClassName
jump to class

$_rating
jump to class

$_statistics
jump to class

__construct
jump to class

getComments
jump to class

getDOM
jump to class

getDescription
jump to class

getRating
jump to class

getStatistics
jump to class

setComments
jump to class

setDescription
jump to class

setRating
jump to class

setStatistics
jump to class

takeChildFromDOM
jump to class