Gdata/Photos/PhotoEntry.php

Show: PublicProtectedPrivateinherited
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
Photos  
Version
$Id: PhotoEntry.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Photos_PhotoEntry

Package: Zend\Gdata\Photos
Data model class for a Comment Entry.

To transfer user entries to and from the servers, including creating new entries, refer to the service class, Zend_Gdata_Photos.

This class represents in the Google Data protocol.

Parent(s)
\Zend_Gdata_Media_Entry < \Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_entryClassName = 'Zend_Gdata_Photos_PhotoEntry'
Class name for each entry in this feed*
Default value'Zend_Gdata_Photos_PhotoEntry'Details
Type
string
>VPropertyprotectedstring|null $_etag = NULL

Used for optimistic concurrency in protoco v2 or greater.

Default valueNULLDetails
Type
string | null
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_etag  
Inherited_from
\Zend_Gdata_App_Entry::$$_etag  
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_etag  
Inherited_from
\Zend_Gdata_Entry::$$_etag  
Inherited_from
\Zend_Gdata_Media_Entry::$$_etag  
>VPropertyprotected\Zend_Gdata_Exif_Extension_Tags $_exifTags = null
exif:tags element
Default valuenullDetails
Type
\Zend_Gdata_Exif_Extension_Tags
>VPropertyprotected\Zend_Gdata_Geo_Extension_GeoRssWhere $_geoRssWhere = null
georss:where element
Default valuenullDetails
Type
\Zend_Gdata_Geo_Extension_GeoRssWhere
>VPropertyprotected\Zend_Gdata_Photos_Extension_AlbumId $_gphotoAlbumId = null
gphoto:albumid element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_AlbumId
>VPropertyprotected\Zend_Gdata_Photos_Extension_Checksum $_gphotoChecksum = null
gphoto:checksum element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Checksum
>VPropertyprotected\Zend_Gdata_Photos_Extension_Client $_gphotoClient = null
gphoto:client element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Client
>VPropertyprotected\Zend_Gdata_Photos_Extension_CommentCount $_gphotoCommentCount = null
gphoto:commentCount element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_CommentCount
>VPropertyprotected\Zend_Gdata_Photos_Extension_CommentingEnabled $_gphotoCommentingEnabled = null
gphoto:commentingEnabled element
>VPropertyprotected\Zend_Gdata_Photos_Extension_Height $_gphotoHeight = null
gphoto:height element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Height
>VPropertyprotected\Zend_Gdata_Photos_Extension_Id $_gphotoId = null
gphoto:id element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Id
>VPropertyprotected\Zend_Gdata_Photos_Extension_Size $_gphotoSize = null
gphoto:size element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Size
>VPropertyprotected\Zend_Gdata_Photos_Extension_Timestamp $_gphotoTimestamp = null
gphoto:timestamp element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Timestamp
>VPropertyprotected\Zend_Gdata_Photos_Extension_Version $_gphotoVersion = null
gphoto:version element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Version
>VPropertyprotected\Zend_Gdata_Photos_Extension_Width $_gphotoWidth = null
gphoto:width element
Default valuenullDetails
Type
\Zend_Gdata_Photos_Extension_Width
>VPropertyprotected$_majorProtocolVersion = 1

At present, recognized values are either 1 or 2. However, any integer value >= 1 is considered valid.

Default value1Details
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_majorProtocolVersion  
Inherited_from
\Zend_Gdata_App_Entry::$$_majorProtocolVersion  
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_majorProtocolVersion  
Inherited_from
\Zend_Gdata_Entry::$$_majorProtocolVersion  
Inherited_from
\Zend_Gdata_Media_Entry::$$_majorProtocolVersion  
See
\setMajorProtocolVersion()  
See
\getMajorProtocolVersion()  
>VPropertyprotected\Zend_Gdata_Media_Extension_MediaGroup $_mediaGroup = null
inherited
media:group element
Inherited from: \Zend_Gdata_Media_Entry::$$_mediaGroup
>VPropertyprotected\Zend_Gdata_App_MediaSource $_mediaSource = null
>VPropertyprotected$_minorProtocolVersion = null

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

Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_minorProtocolVersion  
Inherited_from
\Zend_Gdata_App_Entry::$$_minorProtocolVersion  
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_minorProtocolVersion  
Inherited_from
\Zend_Gdata_Entry::$$_minorProtocolVersion  
Inherited_from
\Zend_Gdata_Media_Entry::$$_minorProtocolVersion  
See
\setMinorProtocolVersion()  
See
\getMinorProtocolVersion()  
>VPropertyprotectedarray $_namespaceLookupCache = array()
staticinherited

Memoized results from calls to lookupNamespace() to avoid expensive calls to getGreatestBoundedValue(). The key is in the form 'prefix-majorVersion-minorVersion', and the value is the output from getGreatestBoundedValue().

Inherited from: \Zend_Gdata_App_Base::$$_namespaceLookupCache\Zend_Gdata_App_FeedEntryParent::$$_namespaceLookupCache\Zend_Gdata_App_Entry::$$_namespaceLookupCache\Zend_Gdata_App_MediaEntry::$$_namespaceLookupCache\Zend_Gdata_Entry::$$_namespaceLookupCache\Zend_Gdata_Media_Entry::$$_namespaceLookupCache
>VPropertyprotectedarray $_namespaces = array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))

The first dimension represents the namespace prefix, the second dimension represents the minimum major protocol version, and the third dimension is the minimum minor protocol version. Null keys are NOT allowed.

When looking up a namespace for a given prefix, the greatest version number (both major and minor) which is less than the effective version should be used.

Default valuearray('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_namespaces  
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_namespaces  
Inherited_from
\Zend_Gdata_App_Entry::$$_namespaces  
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_namespaces  
Inherited_from
\Zend_Gdata_Entry::$$_namespaces  
Inherited_from
\Zend_Gdata_Media_Entry::$$_namespaces  
See
\lookupNamespace()  
See
\registerNamespace()  
See
\registerAllNamespaces()  

Methods

methodpublic__construct(\DOMElement $element = null) : void

Create a new instance.

Parameters
NameTypeDescription
$element\DOMElement

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

methodpublic__get(string $name) : void
inherited

Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.

Inherited from: \Zend_Gdata_App_Base::__get()\Zend_Gdata_App_FeedEntryParent::__get()\Zend_Gdata_App_Entry::__get()\Zend_Gdata_App_MediaEntry::__get()\Zend_Gdata_Entry::__get()\Zend_Gdata_Media_Entry::__get()

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring

The variable name sought

methodpublic__set(string $name,  $val) : void

Alternatively, if no setFoo() is defined, but a $_foo protected variable is defined, this is returned.

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring
$val
methodpublic__toString() : string
Returns
TypeDescription
stringThe text representation of this object
methodpublicdelete() : void
inherited

Deletes this entry to the server using the referenced Zend_Http_Client to do a HTTP DELETE to the edit link stored in this entry's link collection.

Inherited from: \Zend_Gdata_App_Entry::delete()\Zend_Gdata_App_MediaEntry::delete()\Zend_Gdata_Entry::delete()\Zend_Gdata_Media_Entry::delete()
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicencode() : string | \Zend_Gdata_MediaMimeStream
inherited

Return the MIME multipart representation of this MediaEntry.

Inherited from: \Zend_Gdata_App_MediaEntry::encode()\Zend_Gdata_Entry::encode()\Zend_Gdata_Media_Entry::encode()

Can be overridden by children to provide more complex representations of entries.

Returns
TypeDescription
string | \Zend_Gdata_MediaMimeStreamThe MIME multipart representation of this MediaEntry. If the entry consisted only of XML, a string is returned.
methodpublicflushNamespaceLookupCache() : void

Empties the namespace lookup cache. Call this function if you have added data to the namespace lookup table that contradicts values that may have been cached during a previous call to lookupNamespace().

methodpublicgetAlternateLink() : \Zend_Gdata_App_Extension_Link
inherited

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.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getAlternateLink()\Zend_Gdata_App_Entry::getAlternateLink()\Zend_Gdata_App_MediaEntry::getAlternateLink()\Zend_Gdata_Entry::getAlternateLink()\Zend_Gdata_Media_Entry::getAlternateLink()

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
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetCategory() : array

Each category is represented in an atom feed by an atom:category element.

Returns
TypeDescription
arrayArray of Zend_Gdata_App_Extension_Category
methodpublicgetContributor() : array

Each contributor is represented in an atom feed by an atom:contributor XML element

Returns
TypeDescription
arrayAn array of Zend_Gdata_App_Extension_Contributor
methodpublicgetDOM(\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 application storage/persistence.

Parameters
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetEditLink() : \Zend_Gdata_App_Extension_Link

This link is in the atom feed/entry as an atom:link with a rel attribute value of 'edit'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetEtag() : string | null
Returns
TypeDescription
string | null
methodpublicgetExifTags() : string

Get the value for this element's exif:tags attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setExifTags  
methodpublicgetExtensionAttributes() : array

Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string);

Returns
TypeDescription
arrayAll extension attributes
methodpublicgetExtensionElements() : array
Returns
TypeDescription
arrayAll elements not matched to data model classes during parsing
methodpublicgetGeoRssWhere() : string

Get the value for this element's georss:where attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGeoRssWhere  
methodpublicgetGphotoAlbumId() : string

Get the value for this element's gphoto:albumid attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoAlbumId  
methodpublicgetGphotoChecksum() : string

Get the value for this element's gphoto:checksum attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoChecksum  
methodpublicgetGphotoClient() : string

Get the value for this element's gphoto:client attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoClient  
methodpublicgetGphotoCommentCount() : string

Get the value for this element's gphoto:commentCount attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoCommentCount  
methodpublicgetGphotoCommentingEnabled() : string

Get the value for this element's gphoto:commentingEnabled attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoCommentingEnabled  
methodpublicgetGphotoHeight() : string

Get the value for this element's gphoto:height attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoHeight  
methodpublicgetGphotoId() : string

Get the value for this element's gphoto:id attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoId  
methodpublicgetGphotoSize() : string

Get the value for this element's gphoto:size attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoSize  
methodpublicgetGphotoTimestamp() : string

Get the value for this element's gphoto:timestamp attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoTimestamp  
methodpublicgetGphotoVersion() : string

Get the value for this element's gphoto:version attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoVersion  
methodpublicgetGphotoWidth() : string

Get the value for this element's gphoto:width attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setGphotoWidth  
methodpublicgetHttpClient() : \Zend_Http_Client_Abstract

If none is set, a new Zend_Http_Client will be used.

Returns
TypeDescription
\Zend_Http_Client_Abstract
methodpublicgetLink(string $rel = null) : mixed
inherited

Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getLink()\Zend_Gdata_App_Entry::getLink()\Zend_Gdata_App_MediaEntry::getLink()\Zend_Gdata_Entry::getLink()\Zend_Gdata_Media_Entry::getLink()

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
NameTypeDescription
$relstring

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

Returns
TypeDescription
mixedEither 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)
Returns
TypeDescription
\(int | \NULL)The major protocol version in use.
Details
See
\_majorProtocolVersion  
methodpublicgetMediaGroup() : string

Get the value for this element's media:group attribute.

Returns
TypeDescription
stringThe requested attribute.
Details
See
\setMediaGroup  
methodpublicgetMediaSource() : \Zend_Gdata_App_MediaSource
inherited

Return the MediaSource object representing the file attached to this MediaEntry.

Inherited from: \Zend_Gdata_App_MediaEntry::getMediaSource()\Zend_Gdata_Entry::getMediaSource()\Zend_Gdata_Media_Entry::getMediaSource()
Returns
TypeDescription
\Zend_Gdata_App_MediaSourceThe attached MediaSource/file
methodpublicgetMinorProtocolVersion() : \(int | \NULL)
Returns
TypeDescription
\(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
inherited

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.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getNextLink()\Zend_Gdata_App_Entry::getNextLink()\Zend_Gdata_App_MediaEntry::getNextLink()\Zend_Gdata_Entry::getNextLink()\Zend_Gdata_Media_Entry::getNextLink()

This link is in the atom feed as an atom:link with a rel attribute value of 'next'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetPreviousLink() : \Zend_Gdata_App_Extension_Link
inherited

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.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getPreviousLink()\Zend_Gdata_App_Entry::getPreviousLink()\Zend_Gdata_App_MediaEntry::getPreviousLink()\Zend_Gdata_Entry::getPreviousLink()\Zend_Gdata_Media_Entry::getPreviousLink()

This link is in the atom feed as an atom:link with a rel attribute value of 'previous'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetPublished() : \Zend_Gdata_App_Extension_Published
inherited

Sets the value of the atom:published element This represents the publishing date for an entry

Inherited from: \Zend_Gdata_App_Entry::getPublished()\Zend_Gdata_App_MediaEntry::getPublished()\Zend_Gdata_Entry::getPublished()\Zend_Gdata_Media_Entry::getPublished()
methodpublicgetRights() : \Zend_Gdata_AppExtension_Rights
Returns
TypeDescription
\Zend_Gdata_AppExtension_Rights
methodpublicgetSelfLink() : \Zend_Gdata_App_Extension_Link
inherited

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getSelfLink()\Zend_Gdata_App_Entry::getSelfLink()\Zend_Gdata_App_MediaEntry::getSelfLink()\Zend_Gdata_Entry::getSelfLink()\Zend_Gdata_Media_Entry::getSelfLink()
Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetService() : \Zend_Gdata_App | null

This will be used to perform network requests, such as when calling save() and delete().

Returns
TypeDescription
\Zend_Gdata_App | nullThe current service instance, or null if not set.
methodpublicgetSummary() : \Zend_Gdata_App_Extension_Summary
inherited

Gets the value of the atom:summary element This represents a textual summary of this entry's content

Inherited from: \Zend_Gdata_App_Entry::getSummary()\Zend_Gdata_App_MediaEntry::getSummary()\Zend_Gdata_Entry::getSummary()\Zend_Gdata_Media_Entry::getSummary()
Returns
TypeDescription
\Zend_Gdata_App_Extension_Summary
methodpublicgetText( $trim = true) : string
Parameters
NameTypeDescription
$trim
Returns
TypeDescription
stringChild text node
methodpublicgetTitle() : \Zend_Gdata_App_Extension_Title

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
TypeDescription
\Zend_Gdata_App_Extension_Title
methodpublicgetTitleValue() : string

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
TypeDescription
string
methodpublicgetXML() : string
Returns
TypeDescription
stringXML content
methodpubliclookupNamespace(string $prefix, integer $majorVersion = null, integer $minorVersion = null) : string

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
NameTypeDescription
$prefixstring

The namespace prefix to lookup.

$majorVersioninteger

The major protocol version in effect. Defaults to null (auto-select).

$minorVersioninteger

The minor protocol version in effect. Defaults to null (auto-select).

Returns
TypeDescription
string
methodpublicregisterAllNamespaces(array $namespaceArray) : void

Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()

Parameters
NameTypeDescription
$namespaceArrayarray

An array of namespaces.

methodpublicregisterNamespace(string $prefix, string $namespaceUri, integer $majorVersion = 1, integer $minorVersion = 0) : void

Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().

WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().

Parameters
NameTypeDescription
$prefixstring

The namespace prefix

$namespaceUristring

The full namespace URI

$majorVersioninteger

The major protocol version in effect. Defaults to '1'.

$minorVersioninteger

The minor protocol version in effect. Defaults to null (use latest).

methodpublicreload(string | null $uri = null, string | null $className = null, array $extraHeaders = array()) : mixed

Returns a new copy of the entry as returned by the server, or null if no changes exist. This does not modify the current entry instance.

Parameters
NameTypeDescription
$uristring | null

The URI to send requests to, or null if $data contains the URI.

$classNamestring | null

The name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
mixedA new instance of the current entry with updated data, or null if the server reports that no changes have been made.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicsave(string | null $uri = null, string | null $className = null, array $extraHeaders = array()) : \Zend_Gdata_App_Entry
inherited

Uploads changes in this entry to the server using Zend_Gdata_App

Inherited from: \Zend_Gdata_App_Entry::save()\Zend_Gdata_App_MediaEntry::save()\Zend_Gdata_Entry::save()\Zend_Gdata_Media_Entry::save()
Parameters
NameTypeDescription
$uristring | null

The URI to send requests to, or null if $data contains the URI.

$classNamestring | null

The name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
\Zend_Gdata_App_EntryThe updated entry.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicsaveXML() : string
Returns
TypeDescription
stringXML content
methodpublicsetAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent

In an atom feed, each author is represented by an atom:author element

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetCategory(array $value) : \Zend_Gdata_App_FeedEntryParent

Each category is represented in an atom feed by an atom:category element.

Parameters
NameTypeDescription
$valuearray

Array of Zend_Gdata_App_Extension_Category

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetContent(\Zend_Gdata_App_Extension_Content $value) : \Zend_Gdata_App_Entry
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Content
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetContributor(array $value) : \Zend_Gdata_App_FeedEntryParent

Each contributor is represented in an atom feed by an atom:contributor XML element

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetControl(\Zend_Gdata_App_Extension_Control $value) : \Zend_Gdata_App_Entry
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Control
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetEtag(string | null $value) : \Zend_Gdata_App_Entry

Setting $value to null unsets the Etag.

Parameters
NameTypeDescription
$valuestring | null
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetExifTags(string $value) : \Zend_Gdata_Exif_Extension_Tags

Set the value for this element's exif:tags attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Exif_Extension_TagsThe element being modified.
methodpublicsetExtensionAttributes(array $value) : \Zend_Gdata_App_Base

Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string); This can be used to add arbitrary attributes to any data model element

Parameters
NameTypeDescription
$valuearray

All extension attributes

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetExtensionElements(array $value) : \Zend_Gdata_App_Base

This method can be used to add arbitrary child XML elements to any data model class.

Parameters
NameTypeDescription
$valuearray

All extension elements

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetGeoRssWhere(string $value) : \Zend_Gdata_Geo_Extension_GeoRssWhere

Set the value for this element's georss:where attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Geo_Extension_GeoRssWhereThe element being modified.
methodpublicsetGphotoAlbumId(string $value) : \Zend_Gdata_Photos_Extension_AlbumId

Set the value for this element's gphoto:albumid attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_AlbumIdThe element being modified.
methodpublicsetGphotoChecksum(string $value) : \Zend_Gdata_Photos_Extension_Checksum

Set the value for this element's gphoto:checksum attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_ChecksumThe element being modified.
methodpublicsetGphotoClient(string $value) : \Zend_Gdata_Photos_Extension_Client

Set the value for this element's gphoto:client attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_ClientThe element being modified.
methodpublicsetGphotoCommentCount(string $value) : \Zend_Gdata_Photos_Extension_CommentCount

Set the value for this element's gphoto:commentCount attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_CommentCountThe element being modified.
methodpublicsetGphotoCommentingEnabled(string $value) : \Zend_Gdata_Photos_Extension_CommentingEnabled

Set the value for this element's gphoto:commentingEnabled attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_CommentingEnabledThe element being modified.
methodpublicsetGphotoHeight(string $value) : \Zend_Gdata_Photos_Extension_Height

Set the value for this element's gphoto:height attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_HeightThe element being modified.
methodpublicsetGphotoId(string $value) : \Zend_Gdata_Photos_Extension_Id

Set the value for this element's gphoto:id attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_IdThe element being modified.
methodpublicsetGphotoSize(string $value) : \Zend_Gdata_Photos_Extension_Size

Set the value for this element's gphoto:size attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_SizeThe element being modified.
methodpublicsetGphotoTimestamp(string $value) : \Zend_Gdata_Photos_Extension_Timestamp

Set the value for this element's gphoto:timestamp attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_TimestampThe element being modified.
methodpublicsetGphotoVersion(string $value) : \Zend_Gdata_Photos_Extension_Version

Set the value for this element's gphoto:version attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_VersionThe element being modified.
methodpublicsetGphotoWidth(string $value) : \Zend_Gdata_Photos_Extension_Width

Set the value for this element's gphoto:width attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Photos_Extension_WidthThe element being modified.
methodpublicsetHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedEntryParent

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

Parameters
NameTypeDescription
$httpClient\Zend_Http_Client
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetLink(array $value) : \Zend_Gdata_App_FeedEntryParent
Parameters
NameTypeDescription
$valuearray

The array of Zend_Gdata_App_Extension_Link elements

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetMajorProtocolVersion(\(int | \NULL) $value) : void

Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

Parameters
NameTypeDescription
$value\(int | \NULL)

The major protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_majorProtocolVersion  
methodpublicsetMediaGroup(string $value) : \Zend_Gdata_Media_Extension_MediaGroup

Set the value for this element's media:group attribute.

Parameters
NameTypeDescription
$valuestring

The desired value for this attribute.

Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaGroupThe element being modified.
methodpublicsetMediaSource(\Zend_Gdata_App_MediaSource $value) : \Zend_Gdata_App_MediaEntry
Parameters
NameTypeDescription
$value\Zend_Gdata_App_MediaSource

The attached MediaSource/file

Returns
TypeDescription
\Zend_Gdata_App_MediaEntryProvides a fluent interface
methodpublicsetMinorProtocolVersion(\(int | \NULL) $value) : void

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
NameTypeDescription
$value\(int | \NULL)

The minor protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_minorProtocolVersion  
methodpublicsetPublished(\Zend_Gdata_App_Extension_Published $value) : \Zend_Gdata_App_Entry
inherited

Sets the value of the atom:published element This represents the publishing date for an entry

Inherited from: \Zend_Gdata_App_Entry::setPublished()\Zend_Gdata_App_MediaEntry::setPublished()\Zend_Gdata_Entry::setPublished()\Zend_Gdata_Media_Entry::setPublished()
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Published
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetService(\Zend_Gdata_App $instance) : \Zend_Gdata_App_FeedEntryParent

This will be used to perform network requests, such as when calling save() and delete().

Parameters
NameTypeDescription
$instance\Zend_Gdata_App

The new service instance.

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface.
methodpublicsetSource(\Zend_Gdata_App_Extension_Source $value) : \Zend_Gdata_App_Entry
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Source
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetSummary(\Zend_Gdata_App_Extension_Summary $value) : \Zend_Gdata_App_Entry
inherited

Sets the value of the atom:summary element This represents a textual summary of this entry's content

Inherited from: \Zend_Gdata_App_Entry::setSummary()\Zend_Gdata_App_MediaEntry::setSummary()\Zend_Gdata_Entry::setSummary()\Zend_Gdata_Media_Entry::setSummary()
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Summary
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetText(string $value) : \Zend_Gdata_App_Base
Parameters
NameTypeDescription
$valuestring

Child text node

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetTitle(\Zend_Gdata_App_Extension_Title $value) : \Zend_Gdata_App_FeedEntryParent

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
NameTypeDescription
$value\Zend_Gdata_App_Extension_Title
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodprotectedtakeAttributeFromDOM(\DOMNode $attribute) : void
inherited

Given a DOMNode representing an attribute, tries to map the data into instance members.

Inherited from: \Zend_Gdata_Entry::takeAttributeFromDOM()\Zend_Gdata_Media_Entry::takeAttributeFromDOM()

If no mapping is defined, the name and value are stored in an array.

Parameters
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

methodprotectedtakeChildFromDOM(\DOMNode $child) : void

Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.

If no mapping is defined, Extension_Element objects are created and stored in an array.

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

methodpublictransferFromDOM(\DOMNode $node) : void

This is called when XML is received over the wire and the data model needs to be built to represent this XML.

Parameters
NameTypeDescription
$node\DOMNode

The DOMNode that represents this object's data

methodpublictransferFromXML(string $xml) : void
inherited

Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element).

Inherited from: \Zend_Gdata_App_Base::transferFromXML()\Zend_Gdata_App_FeedEntryParent::transferFromXML()\Zend_Gdata_App_Entry::transferFromXML()\Zend_Gdata_App_MediaEntry::transferFromXML()\Zend_Gdata_Entry::transferFromXML()\Zend_Gdata_Media_Entry::transferFromXML()

The first data model element with the same name as $this->_rootElement is used and the child elements are recursively parsed.

Parameters
NameTypeDescription
$xmlstring

The XML text to parse

Documentation was generated by phpDocumentor 2.0.0a12.