API Documentation

Zend/Gdata/App/FeedEntryParent.php

Show: inherited
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
App  
Version
$Id: FeedEntryParent.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_App_FeedEntryParent

Package: Zend\Gdata\App

Abstract class for common functionality in entries and feeds

Parent(s)
\Zend_Gdata_App_Base
Children
\Zend_Gdata_App_FeedSourceParent
\Zend_Gdata_App_Entry
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_author= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_category= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_contributor= 'array()'
Default valuearray()Details
Type
Propertyprotectedstring|null  $_etag= 'NULL'

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

Default valueNULLDetails
Type
stringnull
Propertyprotected  $_id= 'null'
Default valuenullDetails
Type
Propertyprotected  $_link= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_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.

Default value1Details
Type
See
\setMajorProtocolVersion()  
See
\getMajorProtocolVersion()  
Propertyprotected  $_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.

Default valuenullDetails
Type
See
\setMinorProtocolVersion()  
See
\getMinorProtocolVersion()  
Propertyprotected  $_rights= 'null'
Default valuenullDetails
Type
Propertyprotected  $_service= 'null'

Service instance used to make network requests.

Default valuenullDetails
Type
See
\setService(),  
Propertyprotected  $_title= 'null'
Default valuenullDetails
Type
Propertyprotected  $_updated= 'null'
Default valuenullDetails
Type

Methods

methodpublic__construct(  $element = null ) : void

Constructs a Feed or Entry

Parameters
Name Type Description
$element
methodpublicgetAlternateLink( ) : \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'.

Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetAuthor( ) : \Zend_Gdata_App_Extension_Author

Returns
Type Description
\Zend_Gdata_App_Extension_Author
methodpublicgetCategory( ) : array

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

Returns
Type Description
array Array of Zend_Gdata_App_Extension_Category
methodpublicgetContributor( ) : array

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

Returns
Type Description
array An array of Zend_Gdata_App_Extension_Contributor
methodpublicgetDOM(  $doc = null,  $majorVersion = 1,  $minorVersion = null ) : void

Parameters
Name Type Description
$doc
$majorVersion
$minorVersion
methodpublicgetEditLink( ) : \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'.

Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetEtag( ) : string|null

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

Returns
Type Description
string|null
methodpublicgetHttpClient( ) : \Zend_Http_Client_Abstract

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

Returns
Type Description
\Zend_Http_Client_Abstract
Details
Deprecated
Deprecated as of Zend Framework 1.7. Use getService() instead.  
methodpublicgetId( ) : \Zend_Gdata_App_Extension_Id

Returns
Type Description
\Zend_Gdata_App_Extension_Id
methodpublicgetLicenseLink( ) : \Zend_Gdata_App_Extension_Link

Returns
Type Description
\Zend_Gdata_App_Extension_Link
methodpublicgetLink( 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'.

Parameters
Name Type Description
$rel string

The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned

Returns
Type Description
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
methodpublicgetMajorProtocolVersion( ) : \(int|\NULL)

Get the major protocol version that is in use.

Returns
Type Description
\(int|\NULL) The major protocol version in use.
Details
See
\_majorProtocolVersion  
methodpublicgetMinorProtocolVersion( ) : \(int|\NULL)

Get the minor protocol version that is in use.

Returns
Type Description
\(int|\NULL) The major protocol version in use, or NULL if no minor version is specified.
Details
See
\_minorProtocolVersion  
methodpublicgetNextLink( ) : \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'.

Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetPreviousLink( ) : \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'.

Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetRights( ) : \Zend_Gdata_AppExtension_Rights

Returns
Type Description
\Zend_Gdata_AppExtension_Rights
methodpublicgetSelfLink( ) : \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'.

Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetService( ) : \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().

Returns
Type Description
\Zend_Gdata_App|null The current service instance, or null if not set.
methodpublicgetTitle( ) : \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

Returns
Type Description
\Zend_Gdata_App_Extension_Title
methodpublicgetTitleValue( ) : 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

Returns
Type Description
string
methodpublicgetUpdated( ) : \Zend_Gdata_App_Extension_Updated

Returns
Type Description
\Zend_Gdata_App_Extension_Updated
methodpubliclookupNamespace( 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.

Parameters
Name Type Description
$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).

Returns
Type Description
string
methodpublicsetAuthor( 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

Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetCategory( 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.

Parameters
Name Type Description
$value array

Array of Zend_Gdata_App_Extension_Category

Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetContributor( 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

Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetEtag( string|null $value ) : \Zend_Gdata_App_Entry

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

Parameters
Name Type Description
$value string|null
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetHttpClient( \Zend_Http_Client $httpClient ) : \Zend_Gdata_App_FeedEntryParent

Set the HTTP client instance

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

Parameters
Name Type Description
$httpClient \Zend_Http_Client
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
Details
Deprecated
Deprecated as of Zend Framework 1.7. Use setService() instead.  
methodpublicsetId( \Zend_Gdata_App_Extension_Id $value ) : \Zend_Gdata_App_FeedEntryParent

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Id
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetLink( array $value ) : \Zend_Gdata_App_FeedEntryParent

Parameters
Name Type Description
$value array

The array of Zend_Gdata_App_Extension_Link elements

Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetMajorProtocolVersion( \(int|\NULL) $value ) : void

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

Parameters
Name Type Description
$value \(int|\NULL)

The major protocol version to use.

Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_majorProtocolVersion  
methodpublicsetMinorProtocolVersion( \(int|\NULL) $value ) : void

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.

Parameters
Name Type Description
$value \(int|\NULL)

The minor protocol version to use.

Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_minorProtocolVersion  
methodpublicsetRights( \Zend_Gdata_App_Extension_Rights $value ) : \Zend_Gdata_App_FeedEntryParent

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Rights
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetService( \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().

Parameters
Name Type Description
$instance \Zend_Gdata_App

The new service instance.

Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface.
methodpublicsetTitle( \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

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Title
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetUpdated( \Zend_Gdata_App_Extension_Updated $value ) : \Zend_Gdata_App_FeedEntryParent

Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Updated
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodprotectedtakeChildFromDOM(  $child ) : void

Parameters
Name Type Description
$child
Documentation was generated by DocBlox 0.15.1.