Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_App_FeedEntryParent Class Reference
Inheritance diagram for Zend_Gdata_App_FeedEntryParent:
Collaboration diagram for Zend_Gdata_App_FeedEntryParent:

Public Member Functions

 __construct ($element=null)
 setHttpClient (Zend_Http_Client $httpClient)
 getHttpClient ()
 setService ($instance)
 getService ()
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 getAuthor ()
 setAuthor ($value)
 getCategory ()
 setCategory ($value)
 getContributor ()
 setContributor ($value)
 getId ()
 setId ($value)
 getLink ($rel=null)
 getEditLink ()
 getNextLink ()
 getPreviousLink ()
 getLicenseLink ()
 getSelfLink ()
 getAlternateLink ()
 setLink ($value)
 getRights ()
 setRights ($value)
 getTitle ()
 getTitleValue ()
 setTitle ($value)
 getUpdated ()
 setUpdated ($value)
 setEtag ($value)
 getEtag ()
 setMajorProtocolVersion ($value)
 getMajorProtocolVersion ()
 setMinorProtocolVersion ($value)
 getMinorProtocolVersion ()
 lookupNamespace ($prefix, $majorVersion=null, $minorVersion=null)

Protected Member Functions

 takeChildFromDOM ($child)

Protected Attributes

 $_service = null
 $_etag = NULL
 $_author = array()
 $_category = array()
 $_contributor = array()
 $_id = null
 $_link = array()
 $_rights = null
 $_title = null
 $_updated = null
 $_majorProtocolVersion = 1
 $_minorProtocolVersion = null

Detailed Description

Definition at line 83 of file FeedEntryParent.php.


Constructor & Destructor Documentation

__construct ( element = null)

Constructs a Feed or Entry

Reimplemented in Zend_Gdata_YouTube_UserProfileEntry, Zend_Gdata_Photos_PhotoEntry, Zend_Gdata_Photos_AlbumEntry, Zend_Gdata_YouTube_VideoEntry, Zend_Gdata_Photos_PhotoFeed, Zend_Gdata_YouTube_SubscriptionEntry, Zend_Gdata_Books_VolumeEntry, Zend_Gdata_Photos_UserEntry, Zend_Gdata_Photos_AlbumFeed, Zend_Gdata_Gapps_UserEntry, Zend_Gdata_Photos_UserFeed, Zend_Gdata_YouTube_PlaylistListEntry, Zend_Gdata_YouTube_InboxEntry, Zend_Gdata_Feed, Zend_Gdata_YouTube_ActivityEntry, Zend_Gdata_Photos_CommentEntry, Zend_Gdata_Gapps_EmailListEntry, Zend_Gdata_Calendar_ListEntry, Zend_Gdata_Gapps_NicknameEntry, Zend_Gdata_Spreadsheets_CellFeed, Zend_Gdata_Gapps_EmailListRecipientEntry, Zend_Gdata_Calendar_EventEntry, Zend_Gdata_Exif_Entry, Zend_Gdata_YouTube_ContactEntry, Zend_Gdata_Photos_TagEntry, Zend_Gdata_Gbase_Entry, Zend_Gdata_Media_Entry, Zend_Gdata_Spreadsheets_ListEntry, Zend_Gdata_Health_ProfileEntry, Zend_Gdata_Exif_Feed, Zend_Gdata_Media_Feed, Zend_Gdata_Calendar_EventFeed, Zend_Gdata_Docs_DocumentListFeed, Zend_Gdata_YouTube_ContactFeed, Zend_Gdata_YouTube_InboxFeed, Zend_Gdata_YouTube_PlaylistListFeed, Zend_Gdata_YouTube_PlaylistVideoEntry, Zend_Gdata_YouTube_PlaylistVideoFeed, Zend_Gdata_YouTube_SubscriptionFeed, Zend_Gdata_Calendar_ListFeed, Zend_Gdata_Spreadsheets_WorksheetEntry, Zend_Gdata_YouTube_ActivityFeed, Zend_Gdata_YouTube_CommentFeed, Zend_Gdata_YouTube_VideoFeed, Zend_Gdata_Geo_Feed, Zend_Gdata_Spreadsheets_ListFeed, Zend_Gdata_Spreadsheets_SpreadsheetFeed, Zend_Gdata_Gbase_Feed, Zend_Gdata_Geo_Entry, Zend_Gdata_Health_ProfileFeed, Zend_Gdata_Spreadsheets_CellEntry, Zend_Gdata_Health_ProfileListEntry, Zend_Gdata_YouTube_CommentEntry, Zend_Gdata_Books_CollectionEntry, Zend_Gdata_Books_CollectionFeed, Zend_Gdata_Books_VolumeFeed, Zend_Gdata_Docs_DocumentListEntry, Zend_Gdata_Entry, Zend_Gdata_Spreadsheets_SpreadsheetEntry, and Zend_Gdata_Spreadsheets_WorksheetFeed.

Definition at line 132 of file FeedEntryParent.php.

Here is the call graph for this function:


Member Function Documentation

Returns the Zend_Gdata_App_Extension_Link element which represents the URL for an alternate view of the data represented by this feed or entry. This alternate view is commonly a user-facing webpage, blog post, etc. The MIME type for the data at the URL is available from the returned Zend_Gdata_App_Extension_Link element. This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.

Returns:
Zend_Gdata_App_Extension_Link The link, or null if not found

Definition at line 470 of file FeedEntryParent.php.

Here is the call graph for this function:

getAuthor ( )
Returns:
Zend_Gdata_App_Extension_Author

Definition at line 287 of file FeedEntryParent.php.

Here is the caller graph for this function:

Returns the array of categories that classify this feed/entry. Each category is represented in an atom feed by an atom:category element.

Returns:
array Array of Zend_Gdata_App_Extension_Category

Definition at line 311 of file FeedEntryParent.php.

Here is the caller graph for this function:

Returns the array of contributors to this feed/entry. Each contributor is represented in an atom feed by an atom:contributor XML element

Returns:
array An array of Zend_Gdata_App_Extension_Contributor

Definition at line 335 of file FeedEntryParent.php.

getDOM ( doc = null,
majorVersion = 1,
minorVersion = null 
)

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:
DOMDocument$docThe DOMDocument used to construct DOMElements
Returns:
DOMElement The DOMElement representing this element and all child properties.

Reimplemented from Zend_Gdata_App_Base.

Reimplemented in Zend_Gdata_YouTube_UserProfileEntry, Zend_Gdata_Photos_PhotoEntry, Zend_Gdata_Photos_AlbumEntry, Zend_Gdata_YouTube_VideoEntry, Zend_Gdata_Photos_UserFeed, Zend_Gdata_YouTube_SubscriptionEntry, Zend_Gdata_Photos_UserEntry, Zend_Gdata_Books_VolumeEntry, Zend_Gdata_Photos_PhotoFeed, Zend_Gdata_App_FeedSourceParent, Zend_Gdata_Photos_AlbumFeed, Zend_Gdata_App_Entry, Zend_Gdata_Gapps_UserEntry, Zend_Gdata_YouTube_PlaylistListEntry, Zend_Gdata_YouTube_InboxEntry, Zend_Gdata_Kind_EventEntry, Zend_Gdata_Photos_CommentEntry, Zend_Gdata_YouTube_ActivityEntry, Zend_Gdata_Gapps_EmailListEntry, Zend_Gdata_Feed, Zend_Gdata_Gapps_NicknameEntry, Zend_Gdata_App_Feed, Zend_Gdata_Calendar_ListEntry, Zend_Gdata_Gapps_EmailListRecipientEntry, Zend_Gdata_Spreadsheets_CellFeed, Zend_Gdata_Photos_TagEntry, Zend_Gdata_Exif_Entry, Zend_Gdata_YouTube_ContactEntry, Zend_Gdata_Health_ProfileEntry, Zend_Gdata_Gbase_Entry, Zend_Gdata_Media_Entry, Zend_Gdata_YouTube_PlaylistVideoEntry, Zend_Gdata_Calendar_EventEntry, Zend_Gdata_Spreadsheets_WorksheetEntry, Zend_Gdata_Spreadsheets_ListEntry, Zend_Gdata_Calendar_EventFeed, Zend_Gdata_Calendar_ListFeed, Zend_Gdata_Health_ProfileListEntry, Zend_Gdata_Geo_Entry, Zend_Gdata_Spreadsheets_CellEntry, and Zend_Gdata_Entry.

Definition at line 204 of file FeedEntryParent.php.

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to edit this resource. This link is in the atom feed/entry as an atom:link with a rel attribute value of 'edit'.

Returns:
Zend_Gdata_App_Extension_Link The link, or null if not found

Definition at line 407 of file FeedEntryParent.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getEtag ( )

Return the Etag for the current entry, or null if not set.

Returns:
string|null

Definition at line 580 of file FeedEntryParent.php.

Gets the HTTP client object. If none is set, a new Zend_Http_Client will be used.

Deprecated:
Deprecated as of Zend Framework 1.7. Use getService() instead.
Returns:
Zend_Http_Client_Abstract

Definition at line 170 of file FeedEntryParent.php.

Here is the caller graph for this function:

getId ( )
Returns:
Zend_Gdata_App_Extension_Id

Definition at line 356 of file FeedEntryParent.php.

Here is the caller graph for this function:

Returns:
Zend_Gdata_App_Extension_Link

Definition at line 441 of file FeedEntryParent.php.

Here is the call graph for this function:

getLink ( rel = null)

Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element. If the 'rel' value is not provided, the full array of Zend_Gdata_App_Extension_Link elements is returned. In an atom feed, each link is represented by an atom:link element. The 'rel' value passed to this function is the atom:link/ attribute. Example rel values include 'self', 'edit', and 'alternate'.

Parameters:
string$relThe rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned
Returns:
mixed Either a single Zend_Gdata_App_Extension_link element, an array of the same or null is returned depending on the rel value supplied as the argument to this function

Definition at line 386 of file FeedEntryParent.php.

Here is the caller graph for this function:

Get the major protocol version that is in use.

See also:
_majorProtocolVersion
Returns:
(int|NULL) The major protocol version in use.

Definition at line 609 of file FeedEntryParent.php.

Here is the caller graph for this function:

Get the minor protocol version that is in use.

See also:
_minorProtocolVersion
Returns:
(int|NULL) The major protocol version in use, or NULL if no minor version is specified.

Definition at line 640 of file FeedEntryParent.php.

Here is the caller graph for this function:

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the next chunk of results when paging through a feed. This link is in the atom feed as an atom:link with a rel attribute value of 'next'.

Returns:
Zend_Gdata_App_Extension_Link The link, or null if not found

Definition at line 420 of file FeedEntryParent.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the previous chunk of results when paging through a feed. This link is in the atom feed as an atom:link with a rel attribute value of 'previous'.

Returns:
Zend_Gdata_App_Extension_Link The link, or null if not found

Definition at line 433 of file FeedEntryParent.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getRights ( )
Returns:
Zend_Gdata_AppExtension_Rights

Definition at line 488 of file FeedEntryParent.php.

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the entry or feed represented by this object This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.

Returns:
Zend_Gdata_App_Extension_Link The link, or null if not found

Definition at line 454 of file FeedEntryParent.php.

Here is the call graph for this function:

Get the active service instance for this object. This will be used to perform network requests, such as when calling save() and delete().

Returns:
Zend_Gdata_App|null The current service instance, or null if not set.

Definition at line 199 of file FeedEntryParent.php.

Here is the caller graph for this function:

getTitle ( )

Returns the title of this feed or entry. The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Returns:
Zend_Gdata_App_Extension_Title

Definition at line 510 of file FeedEntryParent.php.

Here is the caller graph for this function:

Returns a string representation of the title of this feed or entry. The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Returns:
string

Definition at line 522 of file FeedEntryParent.php.

Here is the call graph for this function:

Returns:
Zend_Gdata_App_Extension_Updated

Definition at line 548 of file FeedEntryParent.php.

lookupNamespace ( prefix,
majorVersion = null,
minorVersion = null 
)

Get the full version of a namespace prefix

Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.

The current entry or feed's version will be used when performing the namespace lookup unless overridden using $majorVersion and $minorVersion. If the entry/fee has a null version, then the latest protocol version will be used by default.

Parameters:
string$prefixThe namespace prefix to lookup.
integer$majorVersionThe major protocol version in effect. Defaults to null (auto-select).
integer$minorVersionThe minor protocol version in effect. Defaults to null (auto-select).
Returns:
string

Reimplemented from Zend_Gdata_App_Base.

Definition at line 665 of file FeedEntryParent.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setAuthor ( value)

Sets the list of the authors of this feed/entry. In an atom feed, each author is represented by an atom:author element

Parameters:
array$value
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Definition at line 299 of file FeedEntryParent.php.

setCategory ( value)

Sets the array of categories that classify this feed/entry. Each category is represented in an atom feed by an atom:category element.

Parameters:
array$valueArray of Zend_Gdata_App_Extension_Category
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Definition at line 323 of file FeedEntryParent.php.

Here is the caller graph for this function:

setContributor ( value)

Sets the array of contributors to this feed/entry. Each contributor is represented in an atom feed by an atom:contributor XML element

Parameters:
array$value
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Definition at line 347 of file FeedEntryParent.php.

setEtag ( value)

Set the Etag for the current entry to $value. Setting $value to null unsets the Etag.

Parameters:
string | null$value
Returns:
Zend_Gdata_App_Entry Provides a fluent interface

Definition at line 570 of file FeedEntryParent.php.

setHttpClient ( Zend_Http_Client httpClient)

Set the HTTP client instance

Sets the HTTP client object to use for retrieving the feed.

Deprecated:
Deprecated as of Zend Framework 1.7. Use setService() instead.
Parameters:
Zend_Http_Client$httpClient
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Reimplemented in Zend_Gdata_App_FeedSourceParent.

Definition at line 153 of file FeedEntryParent.php.

setId ( value)
Parameters:
Zend_Gdata_App_Extension_Id$value
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Definition at line 365 of file FeedEntryParent.php.

setLink ( value)
Parameters:
array$valueThe array of Zend_Gdata_App_Extension_Link elements
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Definition at line 479 of file FeedEntryParent.php.

Set the major protocol version that should be used. Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

See also:
_majorProtocolVersion
Parameters:
(int|NULL)$value The major protocol version to use.
Exceptions:
Zend_Gdata_App_InvalidArgumentException

Reimplemented in Zend_Gdata_App_Feed.

Definition at line 593 of file FeedEntryParent.php.

Set the minor protocol version that should be used. If set to NULL, no minor protocol version will be sent to the server. Values < 0 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

See also:
_minorProtocolVersion
Parameters:
(int|NULL)$value The minor protocol version to use.
Exceptions:
Zend_Gdata_App_InvalidArgumentException

Reimplemented in Zend_Gdata_App_Feed.

Definition at line 623 of file FeedEntryParent.php.

setRights ( value)
Parameters:
Zend_Gdata_App_Extension_Rights$value
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Definition at line 497 of file FeedEntryParent.php.

setService ( instance)

Set the active service instance for this object. This will be used to perform network requests, such as when calling save() and delete().

Parameters:
Zend_Gdata_App$instanceThe new service instance.
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface.

Reimplemented in Zend_Gdata_App_FeedSourceParent.

Definition at line 186 of file FeedEntryParent.php.

setTitle ( value)

Returns the title of this feed or entry. The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Parameters:
Zend_Gdata_App_Extension_Title$value
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Definition at line 539 of file FeedEntryParent.php.

setUpdated ( value)
Parameters:
Zend_Gdata_App_Extension_Updated$value
Returns:
Zend_Gdata_App_FeedEntryParent Provides a fluent interface

Definition at line 557 of file FeedEntryParent.php.

takeChildFromDOM ( child) [protected]

Given a child DOMNode, tries to determine how to map the data into object instance members. If no mapping is defined, Extension_Element objects are created and stored in an array.

Parameters:
DOMNode$childThe DOMNode needed to be handled

Reimplemented from Zend_Gdata_App_Base.

Reimplemented in Zend_Gdata_YouTube_UserProfileEntry, Zend_Gdata_Photos_PhotoEntry, Zend_Gdata_Photos_AlbumEntry, Zend_Gdata_YouTube_VideoEntry, Zend_Gdata_Books_VolumeEntry, Zend_Gdata_YouTube_SubscriptionEntry, Zend_Gdata_Photos_PhotoFeed, Zend_Gdata_Photos_UserEntry, Zend_Gdata_Photos_AlbumFeed, Zend_Gdata_Kind_EventEntry, Zend_Gdata_App_FeedSourceParent, Zend_Gdata_App_Entry, Zend_Gdata_Gapps_UserEntry, Zend_Gdata_YouTube_PlaylistListEntry, Zend_Gdata_YouTube_InboxEntry, Zend_Gdata_Feed, Zend_Gdata_YouTube_ActivityEntry, Zend_Gdata_Photos_CommentEntry, Zend_Gdata_Gapps_EmailListEntry, Zend_Gdata_Gapps_NicknameEntry, Zend_Gdata_Photos_UserFeed, Zend_Gdata_Calendar_ListEntry, Zend_Gdata_App_Feed, Zend_Gdata_Gapps_EmailListRecipientEntry, Zend_Gdata_Photos_TagEntry, Zend_Gdata_Exif_Entry, Zend_Gdata_Spreadsheets_CellFeed, Zend_Gdata_YouTube_ContactEntry, Zend_Gdata_Health_ProfileEntry, Zend_Gdata_Gbase_Entry, Zend_Gdata_Media_Entry, Zend_Gdata_Spreadsheets_WorksheetEntry, Zend_Gdata_YouTube_PlaylistVideoEntry, Zend_Gdata_Calendar_EventEntry, Zend_Gdata_Spreadsheets_ListEntry, Zend_Gdata_Health_ProfileListEntry, Zend_Gdata_Calendar_EventFeed, Zend_Gdata_Calendar_ListFeed, Zend_Gdata_Geo_Entry, Zend_Gdata_Entry, Zend_Gdata_Spreadsheets_CellEntry, and Zend_Gdata_YouTube_MediaEntry.

Definition at line 234 of file FeedEntryParent.php.

Here is the call graph for this function:


Field Documentation

$_author = array() [protected]

Definition at line 100 of file FeedEntryParent.php.

$_category = array() [protected]

Definition at line 101 of file FeedEntryParent.php.

$_contributor = array() [protected]

Definition at line 102 of file FeedEntryParent.php.

$_etag = NULL [protected]

Definition at line 98 of file FeedEntryParent.php.

$_id = null [protected]

Definition at line 103 of file FeedEntryParent.php.

$_link = array() [protected]

Definition at line 104 of file FeedEntryParent.php.

$_majorProtocolVersion = 1 [protected]

Indicates the major protocol version that should be used. At present, recognized values are either 1 or 2. However, any integer value >= 1 is considered valid.

See also:
setMajorProtocolVersion()
getMajorProtocolVersion()

Definition at line 117 of file FeedEntryParent.php.

$_minorProtocolVersion = null [protected]

Indicates the minor protocol version that should be used. Can be set to either an integer >= 0, or NULL if no minor version should be sent to the server.

See also:
setMinorProtocolVersion()
getMinorProtocolVersion()

Definition at line 127 of file FeedEntryParent.php.

$_rights = null [protected]

Definition at line 105 of file FeedEntryParent.php.

$_service = null [protected]

Service instance used to make network requests.

See also:
setService(), getService()

Definition at line 90 of file FeedEntryParent.php.

$_title = null [protected]

Definition at line 106 of file FeedEntryParent.php.

$_updated = null [protected]

Definition at line 107 of file FeedEntryParent.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations