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

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

Extends from: Zend_Gdata_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; $_feedLink; $_username; $_playlistTitle; $_playlistId; $_mediaThumbnail; $_countHint; $_queryString
Methods: __construct; getDOM; takeChildFromDOM; setFeedLink; getFeedLink; getPlaylistId; setPlaylistId; getQueryString; setQueryString; getPlaylistTitle; setPlaylistTitle; getCountHint; getMediaThumbnail; getUsername; setUsername

Description

Represents the YouTube video subscription flavor of an Atom entry

Properties

$_countHint
jump to class

Zend_Gdata_YouTube_Extension_CountHint $_countHint = 'null'

The countHint for this entry.

Details

$_countHint: Zend_Gdata_YouTube_Extension_CountHint
visibility: protected
default: null
final: false
static: false

$_entryClassName
jump to class

$_entryClassName = 'Zend_Gdata_YouTube_SubscriptionEntry'

Details

visibility: protected
default: Zend_Gdata_YouTube_SubscriptionEntry
final: false
static: false

$_feedLink
jump to class

array $_feedLink = 'array'

Nested feed links

Details

$_feedLink: array
visibility: protected
default: array
final: false
static: false

$_mediaThumbnail
jump to class

Zend_Gdata_Media_Extension_MediaThumbnail $_mediaThumbnail = 'null'

The media:thumbnail element for this entry.

This element is only used on subscriptions to playlists.

Details

$_mediaThumbnail: Zend_Gdata_Media_Extension_MediaThumbnail
visibility: protected
default: null
final: false
static: false

$_playlistId
jump to class

Zend_Gdata_YouTube_Extension_PlaylistId $_playlistId = 'null'

The playlist id for this entry.

This element is only used on subscriptions to playlists.

Details

$_playlistId: Zend_Gdata_YouTube_Extension_PlaylistId
visibility: protected
default: null
final: false
static: false

$_playlistTitle
jump to class

Zend_Gdata_YouTube_Extension_PlaylistTitle $_playlistTitle = 'null'

The playlist title for this entry.

This element is only used on subscriptions to playlists.

Details

$_playlistTitle: Zend_Gdata_YouTube_Extension_PlaylistTitle
visibility: protected
default: null
final: false
static: false

$_queryString
jump to class

Zend_Gdata_YouTube_Extension_QueryString $_queryString = 'null'

The queryString for this entry.

Details

$_queryString: Zend_Gdata_YouTube_Extension_QueryString
visibility: protected
default: null
final: false
static: false

$_username
jump to class

Zend_Gdata_YouTube_Extension_Username $_username = 'null'

The username of this entry.

Details

$_username: Zend_Gdata_YouTube_Extension_Username
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

getCountHint
jump to class

getCountHint(
          
          )
        
        :
        Zend_Gdata_YouTube_Extension_CountHint

Get the counthint for a subscription.

Output

Zend_Gdata_YouTube_Extension_CountHint

Details

visibility: public
final: false
static: false
throws

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

getFeedLink
jump to class

getFeedLink(
          string $rel
              =
              null
          )
        
        :
        mixed

Get the feed link property for this entry.

Arguments

$rel: string
(optional) The rel value of the link to be found. If null, the array of links is returned.

Output

mixed: If $rel is specified, a Zend_Gdata_Extension_FeedLink object corresponding to the requested rel value is returned if found, or null if the requested value is not found. If $rel is null or not specified, an array of all available feed links for this entry is returned, or null if no feed links are set.

Details

visibility: public
final: false
static: false
see: setFeedLink

getMediaThumbnail
jump to class

getMediaThumbnail(
          
          )
        
        :
        Zend_Gdata_Media_Extension_MediaThumbnail

Get the thumbnail for a subscription.

Output

Zend_Gdata_Media_Extension_MediaThumbnail

Details

visibility: public
final: false
static: false
throws

getPlaylistId
jump to class

getPlaylistId(
          
          )
        
        :
        Zend_Gdata_YouTube_Extension_PlaylistId

Get the playlist title for a 'playlist' subscription.

Output

Zend_Gdata_YouTube_Extension_PlaylistId

Details

visibility: public
final: false
static: false
throws

getPlaylistTitle
jump to class

getPlaylistTitle(
          
          )
        
        :
        Zend_Gdata_YouTube_Extension_PlaylistTitle

Get the playlist title for a 'playlist' subscription.

Output

Zend_Gdata_YouTube_Extension_PlaylistTitle

Details

visibility: public
final: false
static: false
throws

getQueryString
jump to class

getQueryString(
          
          )
        
        :
        Zend_Gdata_YouTube_Extension_QueryString

Get the queryString of the subscription

Output

Zend_Gdata_YouTube_Extension_QueryString

Details

visibility: public
final: false
static: false

getUsername
jump to class

getUsername(
          
          )
        
        :
        Zend_Gdata_YouTube_Extension_Username

Get the username for a channel subscription.

Output

Zend_Gdata_YouTube_Extension_Username

Details

visibility: public
final: false
static: false

setFeedLink
jump to class

setFeedLink(
          array $feedLink
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_SubscriptionEntry

Sets the array of embedded feeds related to the video

Arguments

$feedLink: array
The array of embedded feeds relating to the video

Output

Zend_Gdata_YouTube_SubscriptionEntry: Provides a fluent interface

Details

visibility: public
final: false
static: false

setPlaylistId
jump to class

setPlaylistId(
          Zend_Gdata_YouTube_Extension_PlaylistId $id
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_SubscriptionEntry

Sets the yt:playlistId element for a new playlist subscription.

Arguments

$id: Zend_Gdata_YouTube_Extension_PlaylistId
The id of the playlist to which to subscribe to.

Output

Zend_Gdata_YouTube_SubscriptionEntry: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setPlaylistTitle
jump to class

setPlaylistTitle(
          Zend_Gdata_YouTube_Extension_PlaylistTitle $title
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_SubscriptionEntry

Sets the yt:playlistTitle element for a new playlist subscription.

Arguments

$title: Zend_Gdata_YouTube_Extension_PlaylistTitle
The title of the playlist to which to subscribe to.

Output

Zend_Gdata_YouTube_SubscriptionEntry: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setQueryString
jump to class

setQueryString(
          Zend_Gdata_YouTube_Extension_QueryString $queryString
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_SubscriptionEntry

Sets the yt:queryString element for a new keyword subscription.

Arguments

$queryString: Zend_Gdata_YouTube_Extension_QueryString
The query string to subscribe to

Output

Zend_Gdata_YouTube_SubscriptionEntry: Provides a fluent interface

Details

visibility: public
final: false
static: false

setUsername
jump to class

setUsername(
          Zend_Gdata_YouTube_Extension_Username $username
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_SubscriptionEntry

Sets the username for a new channel subscription.

Arguments

$username: Zend_Gdata_YouTube_Extension_Username
The username of the channel to which to subscribe to.

Output

Zend_Gdata_YouTube_SubscriptionEntry: 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/SubscriptionEntry.php

Description

Zend_Gdata_YouTube_SubscriptionEntryjump to top

Description

Properties

$_countHintjump to class

Details

$_entryClassNamejump to class

Details

$_feedLinkjump to class

Details

$_mediaThumbnailjump to class

Details

$_playlistIdjump to class

Details

$_playlistTitlejump to class

Details

$_queryStringjump to class

Details

$_usernamejump to class

Details

Methods

__constructjump to class

Arguments

Details

getCountHintjump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getFeedLinkjump to class

Arguments

Output

Details

getMediaThumbnailjump to class

Output

Details

getPlaylistIdjump to class

Output

Details

getPlaylistTitlejump to class

Output

Details

getQueryStringjump to class

Output

Details

getUsernamejump to class

Output

Details

setFeedLinkjump to class

Arguments

Output

Details

setPlaylistIdjump to class

Arguments

Output

Details

setPlaylistTitlejump to class

Arguments

Output

Details

setQueryStringjump to class

Arguments

Output

Details

setUsernamejump to class

Arguments

Output

Details

takeChildFromDOMjump to class

Arguments

Details

Zend_Gdata_YouTube_SubscriptionEntry
jump to top

$_countHint
jump to class

$_entryClassName
jump to class

$_feedLink
jump to class

$_mediaThumbnail
jump to class

$_playlistId
jump to class

$_playlistTitle
jump to class

$_queryString
jump to class

$_username
jump to class

__construct
jump to class

getCountHint
jump to class

getDOM
jump to class

getFeedLink
jump to class

getMediaThumbnail
jump to class

getPlaylistId
jump to class

getPlaylistTitle
jump to class

getQueryString
jump to class

getUsername
jump to class

setFeedLink
jump to class

setPlaylistId
jump to class

setPlaylistTitle
jump to class

setQueryString
jump to class

setUsername
jump to class

takeChildFromDOM
jump to class