Gdata/Calendar/EventEntry.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 [email protected] 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
Calendar  
Version
$Id: EventEntry.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Calendar_EventEntry

Package: Zend\Gdata\Calendar

Data model class for a Google Calendar Event Entry

Google Calendar has a separate EventEntry class which extends this.

Parent(s)
\Zend_Gdata_Kind_EventEntry < \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

Propertyprotected$_comments = null
inheritedInherited from: \Zend_Gdata_Kind_EventEntry::$$_comments
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_comments  
Propertyprotected\Zend_Gdata_App_Extension_Edited $_edited = null
Propertyprotectedstring $_entryClassName = 'Zend_Gdata_Calendar_EventEntry'

Class name for each entry in this feed*

Default value'Zend_Gdata_Calendar_EventEntry'Details
Type
string
Propertyprotected$_entryLink = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_entryLink  
Propertyprotectedstring|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_Kind_EventEntry::$$_etag  
Propertyprotected$_eventStatus = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_eventStatus  
Propertyprotected$_extendedProperty = array()
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_extendedProperty  
Propertyprotected$_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_Kind_EventEntry::$$_majorProtocolVersion  
See
\global\setMajorProtocolVersion()  
See
\global\getMajorProtocolVersion()  
Propertyprotected\Zend_Gdata_App_MediaSource $_mediaSource = null
Propertyprotected$_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_Kind_EventEntry::$$_minorProtocolVersion  
See
\global\setMinorProtocolVersion()  
See
\global\getMinorProtocolVersion()  
Propertyprotectedarray $_namespaceLookupCache = array()
staticinherited

<p>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().</p> 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_Kind_EventEntry::$$_namespaceLookupCache
Propertyprotectedarray $_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_Kind_EventEntry::$$_namespaces  
See
\global\lookupNamespace()  
See
\global\registerNamespace()  
See
\global\registerAllNamespaces()  
Propertyprotected$_originalEvent = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_originalEvent  
Propertyprotected$_quickadd = null
Default valuenullDetails
Type
n/a
Propertyprotected$_recurrence = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_recurrence  
Propertyprotected$_recurrenceException = array()
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_recurrenceException  
Propertyprotectedstring $_rootElement = 'entry'
Default value'entry'Details
Type
string
Inherited_from
\Zend_Gdata_App_Entry::$$_rootElement  
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_rootElement  
Inherited_from
\Zend_Gdata_Entry::$$_rootElement  
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_rootElement  
Propertyprotected$_sendEventNotifications = null
Default valuenullDetails
Type
n/a
Propertyprotected$_service = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_service  
Inherited_from
\Zend_Gdata_App_Entry::$$_service  
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_service  
Inherited_from
\Zend_Gdata_Entry::$$_service  
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_service  
See
\global\setService(),  
Propertyprotected\Zend_Gdata_App_Extension_Source $_source = null
Propertyprotected$_timezone = null
Default valuenullDetails
Type
n/a
Propertyprotected$_transparency = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_transparency  
Propertyprotected$_visibility = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_visibility  
Propertyprotected$_when = array()
inheritedInherited from: \Zend_Gdata_Kind_EventEntry::$$_when
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_when  
Propertyprotected$_where = array()
inheritedInherited from: \Zend_Gdata_Kind_EventEntry::$$_where
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_where  
Propertyprotected$_who = array()
inheritedInherited from: \Zend_Gdata_Kind_EventEntry::$$_who
Default valuearray()Details
Type
n/a
Inherited_from
\Zend_Gdata_Kind_EventEntry::$$_who  

Methods

methodpublic__construct(\DOMElement $element = null) : void

Constructs a new MediaEntry, representing XML data and optional file to upload

Parameters
Name Type Description
$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_Kind_EventEntry::__get()

TODO Remove ability to bypass getFoo() methods??

Parameters
Name Type Description
$name string

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
Name Type Description
$name string
$val
methodpublic__toString() : string
Returns
Type Description
string The 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_Kind_EventEntry::delete()
Throws
Exception Description
\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_Kind_EventEntry::encode()

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

Returns
Type Description
string | \Zend_Gdata_MediaMimeStream The 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_Kind_EventEntry::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
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetCategory() : array

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

Returns
Type Description
array Array of Zend_Gdata_App_Extension_Category
methodpublicgetComments() : void
inherited

Inherited from: \Zend_Gdata_Kind_EventEntry::getComments()
methodpublicgetContributor() : array

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(\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.

Parameters
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
Type Description
\DOMElement The 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
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetEntryLink() : \Zend_Gdata_Extension_EntryLink
inherited

Get this entry's EntryLink element.

Inherited from: \Zend_Gdata_Kind_EventEntry::getEntryLink()
Returns
Type Description
\Zend_Gdata_Extension_EntryLink The requested entry.
methodpublicgetEtag() : string | null
Returns
Type Description
string | null
methodpublicgetEventStatus() : void
methodpublicgetExtendedProperty() : void
methodpublicgetExtensionAttributes() : array

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

Returns
Type Description
array All extension attributes
methodpublicgetExtensionElements() : array
Returns
Type Description
array All elements not matched to data model classes during parsing
methodpublicgetHttpClient() : \Zend_Http_Client_Abstract

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

Returns
Type Description
\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_Kind_EventEntry::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
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)
Returns
Type Description
\(int | \NULL) The major protocol version in use.
Details
See
\global\_majorProtocolVersion  
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_Kind_EventEntry::getMediaSource()
Returns
Type Description
\Zend_Gdata_App_MediaSource The attached MediaSource/file
methodpublicgetMinorProtocolVersion() : \(int | \NULL)
Returns
Type Description
\(int | \NULL) The major protocol version in use, or NULL if no minor version is specified.
Details
See
\global\_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_Kind_EventEntry::getNextLink()

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
methodpublicgetOriginalEvent() : void
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_Kind_EventEntry::getPreviousLink()

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
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_Kind_EventEntry::getPublished()
Returns
Type Description
\Zend_Gdata_App_Extension_Published
methodpublicgetQuickAdd() : void

methodpublicgetRecurrence() : void
methodpublicgetRecurrenceExcption() : void
methodpublicgetRights() : \Zend_Gdata_AppExtension_Rights
Returns
Type Description
\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_Kind_EventEntry::getSelfLink()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetSendEventNotifications() : void

methodpublicgetService() : \Zend_Gdata_App | null

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.
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_Kind_EventEntry::getSummary()
Returns
Type Description
\Zend_Gdata_App_Extension_Summary
methodpublicgetText( $trim = true) : string
Parameters
Name Type Description
$trim
Returns
Type Description
string Child text node
methodpublicgetTimezone() : void

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
Type Description
\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
Type Description
string
methodpublicgetTransparency() : void
methodpublicgetVisibility() : void
methodpublicgetWhen() : void
inherited

Inherited from: \Zend_Gdata_Kind_EventEntry::getWhen()
methodpublicgetWhere() : void
inherited

Inherited from: \Zend_Gdata_Kind_EventEntry::getWhere()
methodpublicgetWho() : void
inherited

Inherited from: \Zend_Gdata_Kind_EventEntry::getWho()
methodpublicgetXML() : string
Returns
Type Description
string XML 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
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
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
Name Type Description
$namespaceArray array

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
Name Type Description
$prefix string

The namespace prefix

$namespaceUri string

The full namespace URI

$majorVersion integer

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

$minorVersion integer

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
Name Type Description
$uri string | null

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

$className string | null

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

$extraHeaders array

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

Returns
Type Description
mixed A new instance of the current entry with updated data, or null if the server reports that no changes have been made.
Throws
Exception Description
\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_Kind_EventEntry::save()
Parameters
Name Type Description
$uri string | null

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

$className string | null

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

$extraHeaders array

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

Returns
Type Description
\Zend_Gdata_App_Entry The updated entry.
Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicsaveXML() : string
Returns
Type Description
string XML content
methodpublicsetAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent

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

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
methodpublicsetComments(array $value) : \Zend_Gdata_Kind_EventEntry
inherited

Inherited from: \Zend_Gdata_Kind_EventEntry::setComments()
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
methodpublicsetContent(\Zend_Gdata_App_Extension_Content $value) : \Zend_Gdata_App_Entry
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Content
Returns
Type Description
\Zend_Gdata_App_Entry Provides 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
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetControl(\Zend_Gdata_App_Extension_Control $value) : \Zend_Gdata_App_Entry
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Control
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetEntryLink(\Zend_Gdata_Extension_EntryLink $value) : \Zend_Gdata_Extension_Who
inherited

Set the child's EntryLink element.

Inherited from: \Zend_Gdata_Kind_EventEntry::setEntryLink()
Parameters
Name Type Description
$value \Zend_Gdata_Extension_EntryLink

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Extension_Who The element being modified.
methodpublicsetEtag(string | null $value) : \Zend_Gdata_App_Entry

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
methodpublicsetEventStatus(array $value) : \Zend_Gdata_Kind_EventEntry
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
methodpublicsetExtendedProperty(array $value) : \Zend_Gdata_Kind_EventEntry
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
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
Name Type Description
$value array

All extension attributes

Returns
Type Description
\Zend_Gdata_App_Base Returns 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
Name Type Description
$value array

All extension elements

Returns
Type Description
\Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedEntryParent

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

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
\global\_majorProtocolVersion  
methodpublicsetMediaSource(\Zend_Gdata_App_MediaSource $value) : \Zend_Gdata_App_MediaEntry
Parameters
Name Type Description
$value \Zend_Gdata_App_MediaSource

The attached MediaSource/file

Returns
Type Description
\Zend_Gdata_App_MediaEntry Provides 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
Name Type Description
$value \(int | \NULL)

The minor protocol version to use.

Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
See
\global\_minorProtocolVersion  
methodpublicsetOriginalEvent(\Zend_Gdata_Extension_OriginalEvent $value) : \Zend_Gdata_Kind_EventEntry
Parameters
Name Type Description
$value \Zend_Gdata_Extension_OriginalEvent
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
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_Kind_EventEntry::setPublished()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Published
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetQuickAdd(\Zend_Gdata_Calendar_Extension_QuickAdd $value) : \Zend_Gdata_Extension_ListEntry

Parameters
Name Type Description
$value \Zend_Gdata_Calendar_Extension_QuickAdd
Returns
Type Description
\Zend_Gdata_Extension_ListEntry Provides a fluent interface
methodpublicsetRecurrence(array $value) : \Zend_Gdata_Kind_EventEntry
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
methodpublicsetRecurrenceException(array $value) : \Zend_Gdata_Kind_EventEntry
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
methodpublicsetSendEventNotifications( $value) : void

Parameters
Name Type Description
$value
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
Name Type Description
$instance \Zend_Gdata_App

The new service instance.

Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface.
methodpublicsetSource(\Zend_Gdata_App_Extension_Source $value) : \Zend_Gdata_App_Entry
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Source
Returns
Type Description
\Zend_Gdata_App_Entry Provides 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_Kind_EventEntry::setSummary()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Summary
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetText(string $value) : \Zend_Gdata_App_Base
Parameters
Name Type Description
$value string

Child text node

Returns
Type Description
\Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetTimezone(\Zend_Gdata_Calendar_Extension_Timezone $value) : \Zend_Gdata_Extension_EventEntry

Parameters
Name Type Description
$value \Zend_Gdata_Calendar_Extension_Timezone
Returns
Type Description
\Zend_Gdata_Extension_EventEntry Provides 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
Name Type Description
$value \Zend_Gdata_App_Extension_Title
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetTransparency(\Zend_Gdata_Transparency $value) : \Zend_Gdata_Kind_EventEntry
Parameters
Name Type Description
$value \Zend_Gdata_Transparency
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
methodpublicsetVisibility(\Zend_Gdata_Visibility $value) : \Zend_Gdata_Kind_EventEntry
Parameters
Name Type Description
$value \Zend_Gdata_Visibility
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
methodpublicsetWhen(array $value) : \Zend_Gdata_Kind_EventEntry
inherited

Inherited from: \Zend_Gdata_Kind_EventEntry::setWhen()
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
methodpublicsetWhere(array $value) : \Zend_Gdata_Kind_EventEntry
inherited

Inherited from: \Zend_Gdata_Kind_EventEntry::setWhere()
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides a fluent interface
methodpublicsetWho(array $value) : \Zend_Gdata_Kind_EventEntry
inherited

Inherited from: \Zend_Gdata_Kind_EventEntry::setWho()
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_Kind_EventEntry Provides 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_Kind_EventEntry::takeAttributeFromDOM()

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

Parameters
Name Type Description
$attribute \DOMNode

The DOMNode attribute needed to be handled

methodprotectedtakeChildFromDOM(\DOMNode $child) : void

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
Name Type Description
$child \DOMNode

The DOMNode needed to be handled

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
Name Type Description
$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_Kind_EventEntry::transferFromXML()

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

Parameters
Name Type Description
$xml string

The XML text to parse

Documentation was generated by phpDocumentor 2.0.0a8.