API Documentation

Gdata/App/FeedEntryParent.php

Includes Classes 
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
App
version
$Id: FeedEntryParent.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_App_FeedEntryParent

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

Extends from
Zend_Gdata_App_Base
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
App
Properties
$_service
$_etag
$_author
$_category
$_contributor
$_id
$_link
$_rights
$_title
$_updated
$_majorProtocolVersion
$_minorProtocolVersion
Methods
__construct
setHttpClient
getHttpClient
setService
getService
getDOM
takeChildFromDOM
getAuthor
setAuthor
getCategory
setCategory
getContributor
setContributor
getId
setId
getLink
getEditLink
getNextLink
getPreviousLink
getLicenseLink
getSelfLink
getAlternateLink
setLink
getRights
setRights
getTitle
getTitleValue
setTitle
getUpdated
setUpdated
setEtag
getEtag
setMajorProtocolVersion
getMajorProtocolVersion
setMinorProtocolVersion
getMinorProtocolVersion
lookupNamespace

Description

Abstract class for common functionality in entries and feeds

Properties

$_author
jump to class

 $_author = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_category
jump to class

 $_category = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_contributor
jump to class

 $_contributor = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_etag
jump to class

string|null $_etag = 'NULL'

The HTTP ETag associated with this entry. Used for optimistic concurrency in protoco v2 or greater.

Details

$_etag
string|null
visibility
protected
default
NULL
final
false
static
false

$_id
jump to class

 $_id = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_link
jump to class

 $_link = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_majorProtocolVersion
jump to class

 $_majorProtocolVersion = '1'

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.

Details

visibility
protected
default
1
final
false
static
false
see
setMajorProtocolVersion()
see
getMajorProtocolVersion()

$_minorProtocolVersion
jump to class

 $_minorProtocolVersion = 'null'

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.

Details

visibility
protected
default
null
final
false
static
false
see
setMinorProtocolVersion()
see
getMinorProtocolVersion()

$_rights
jump to class

 $_rights = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_service
jump to class

 $_service = 'null'

Service instance used to make network requests.

Details

visibility
protected
default
null
final
false
static
false
see
setService(), getService()

$_title
jump to class

 $_title = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_updated
jump to class

 $_updated = 'null'

Details

visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct(  $element = null ) :

Constructs a Feed or Entry

Arguments
$element
Details
visibility
public
final
false
static
false

getAlternateLink
jump to class

getAlternateLink( ) : Zend_Gdata_App_Extension_Link

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'.

Output
Zend_Gdata_App_Extension_Link
The link, or null if not found
Details
visibility
public
final
false
static
false

getAuthor
jump to class

getAuthor( ) : Zend_Gdata_App_Extension_Author

Output
Zend_Gdata_App_Extension_Author
Details
visibility
public
final
false
static
false

getCategory
jump to class

getCategory( ) : array

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

Output
array
Array of Zend_Gdata_App_Extension_Category
Details
visibility
public
final
false
static
false

getContributor
jump to class

getContributor( ) : array

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

Output
array
An array of Zend_Gdata_App_Extension_Contributor
Details
visibility
public
final
false
static
false

getDOM
jump to class

getDOM(  $doc = null,  $majorVersion = 1,  $minorVersion = null ) :
Arguments
$doc
$majorVersion
$minorVersion
Details
visibility
public
final
false
static
false

getEditLink
jump to class

getEditLink( ) : Zend_Gdata_App_Extension_Link

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'.

Output
Zend_Gdata_App_Extension_Link
The link, or null if not found
Details
visibility
public
final
false
static
false

getEtag
jump to class

getEtag( ) : string|null

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

Output
string|null
Details
visibility
public
final
false
static
false

getHttpClient
jump to class

getHttpClient( ) : Zend_Http_Client_Abstract

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

Output
Zend_Http_Client_Abstract
Details
visibility
public
final
false
static
false
deprecated
Deprecated as of Zend Framework 1.7. Use getService() instead.

getId
jump to class

getId( ) : Zend_Gdata_App_Extension_Id

Output
Zend_Gdata_App_Extension_Id
Details
visibility
public
final
false
static
false

getLicenseLink
jump to class

getLicenseLink( ) : Zend_Gdata_App_Extension_Link

Output
Zend_Gdata_App_Extension_Link
Details
visibility
public
final
false
static
false

getLink
jump to class

getLink( string $rel = null ) : mixed

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/@rel attribute. Example rel values include 'self', 'edit', and 'alternate'.

Arguments
$rel
string
The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned
Output
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
Details
visibility
public
final
false
static
false

getMajorProtocolVersion
jump to class

getMajorProtocolVersion( ) : (int|NULL)

Get the major protocol version that is in use.

Output
(int|NULL)
The major protocol version in use.
Details
visibility
public
final
false
static
false
see
_majorProtocolVersion

getMinorProtocolVersion
jump to class

getMinorProtocolVersion( ) : (int|NULL)

Get the minor protocol version that is in use.

Output
(int|NULL)
The major protocol version in use, or NULL if no minor version is specified.
Details
visibility
public
final
false
static
false
see
_minorProtocolVersion

getNextLink
jump to class

getNextLink( ) : Zend_Gdata_App_Extension_Link

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'.

Output
Zend_Gdata_App_Extension_Link
The link, or null if not found
Details
visibility
public
final
false
static
false

getPreviousLink
jump to class

getPreviousLink( ) : Zend_Gdata_App_Extension_Link

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'.

Output
Zend_Gdata_App_Extension_Link
The link, or null if not found
Details
visibility
public
final
false
static
false

getRights
jump to class

getRights( ) : Zend_Gdata_AppExtension_Rights

Output
Zend_Gdata_AppExtension_Rights
Details
visibility
public
final
false
static
false

getSelfLink
jump to class

getSelfLink( ) : Zend_Gdata_App_Extension_Link

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'.

Output
Zend_Gdata_App_Extension_Link
The link, or null if not found
Details
visibility
public
final
false
static
false

getService
jump to class

getService( ) : Zend_Gdata_App|null

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

Output
Zend_Gdata_App|null
The current service instance, or null if not set.
Details
visibility
public
final
false
static
false

getTitle
jump to class

getTitle( ) : Zend_Gdata_App_Extension_Title

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

Output
Zend_Gdata_App_Extension_Title
Details
visibility
public
final
false
static
false

getTitleValue
jump to class

getTitleValue( ) : string

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

Output
string
Details
visibility
public
final
false
static
false

getUpdated
jump to class

getUpdated( ) : Zend_Gdata_App_Extension_Updated

Output
Zend_Gdata_App_Extension_Updated
Details
visibility
public
final
false
static
false

lookupNamespace
jump to class

lookupNamespace( string $prefix, integer $majorVersion = null, integer $minorVersion = null ) : string

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.

Arguments
$prefix
string
The namespace prefix to lookup.
$majorVersion
integer
The major protocol version in effect. Defaults to null (auto-select).
$minorVersion
integer
The minor protocol version in effect. Defaults to null (auto-select).
Output
string
Details
visibility
public
final
false
static
false

setAuthor
jump to class

setAuthor( array $value ) : Zend_Gdata_App_FeedEntryParent

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

Arguments
$value
array
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false

setCategory
jump to class

setCategory( array $value ) : Zend_Gdata_App_FeedEntryParent

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

Arguments
$value
array
Array of Zend_Gdata_App_Extension_Category
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false

setContributor
jump to class

setContributor( array $value ) : Zend_Gdata_App_FeedEntryParent

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

Arguments
$value
array
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false

setEtag
jump to class

setEtag( string|null $value ) : Zend_Gdata_App_Entry

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

Arguments
$value
stringnull
Output
Zend_Gdata_App_Entry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setHttpClient
jump to class

setHttpClient( Zend_Http_Client $httpClient ) : Zend_Gdata_App_FeedEntryParent

Set the HTTP client instance

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

Arguments
$httpClient
Zend_Http_Client
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false
deprecated
Deprecated as of Zend Framework 1.7. Use setService() instead.

setId
jump to class

setId( Zend_Gdata_App_Extension_Id $value ) : Zend_Gdata_App_FeedEntryParent

Arguments
$value
Zend_Gdata_App_Extension_Id
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false

setLink
jump to class

setLink( array $value ) : Zend_Gdata_App_FeedEntryParent

Arguments
$value
array
The array of Zend_Gdata_App_Extension_Link elements
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false

setMajorProtocolVersion
jump to class

setMajorProtocolVersion( (int|NULL) $value ) :

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

Arguments
$value
(intNULL)
The major protocol version to use.
Details
visibility
public
final
false
static
false
see
_majorProtocolVersion
throws

setMinorProtocolVersion
jump to class

setMinorProtocolVersion( (int|NULL) $value ) :

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.

Arguments
$value
(intNULL)
The minor protocol version to use.
Details
visibility
public
final
false
static
false
see
_minorProtocolVersion
throws

setRights
jump to class

setRights( Zend_Gdata_App_Extension_Rights $value ) : Zend_Gdata_App_FeedEntryParent

Arguments
$value
Zend_Gdata_App_Extension_Rights
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false

setService
jump to class

setService( Zend_Gdata_App $instance ) : Zend_Gdata_App_FeedEntryParent

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

Arguments
$instance
Zend_Gdata_App
The new service instance.
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface.
Details
visibility
public
final
false
static
false

setTitle
jump to class

setTitle( Zend_Gdata_App_Extension_Title $value ) : Zend_Gdata_App_FeedEntryParent

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

Arguments
$value
Zend_Gdata_App_Extension_Title
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false

setUpdated
jump to class

setUpdated( Zend_Gdata_App_Extension_Updated $value ) : Zend_Gdata_App_FeedEntryParent

Arguments
$value
Zend_Gdata_App_Extension_Updated
Output
Zend_Gdata_App_FeedEntryParent
Provides a fluent interface
Details
visibility
public
final
false
static
false

takeChildFromDOM
jump to class

takeChildFromDOM(  $child ) :
Arguments
$child
Details
visibility
protected
final
false
static
false
Documentation was generated by DocBlox.