Zend Framework API Documentation » \Zend_Gdata_Calendar

Methods
Properties

Constants
- CALENDAR_FEED_URI
```
CALENDAR_FEED_URI
```

Assists in constructing queries for Google Calendar events

Queries are not defined for APP, but are provided by Gdata services as an extension.

link	http://code.google.com/apis/gdata/calendar/
category	Zend
package	Zend_Gdata
subpackage	Calendar
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License
inherited_from	\Zend_Gdata_Query

Methods

Create Gdata_Calendar_EventQuery object. If a URL is provided, it becomes the base URL, and additional URL components may be appended. For instance, if $url is 'https://www.google.com/calendar', the default URL constructed will be 'https://www.google.com/calendar/default/public/full'.

__construct(string $url = null)

If the URL already contains a calendar ID, projection, visibility, event ID, or comment ID, you will need to set these fields to null to prevent them from being inserted. See this class's properties for more information.

inherited_from	\Zend_Gdata_Query::__construct()

Parameters

$url

string

The URL to use as the base path for requests

Create Gdata_Query object

__construct($url = null)

Inherited

Parameters

$url

__get()

__get($name)

Inherited

Parameters

$name

__set()

__set($name, $val)

Inherited

Parameters

$name

$val

getAlt()

getAlt() : string

Inherited

Returns

stringrss or atom

getAuthor()

getAuthor() : string

Inherited

Returns

stringauthor

getCategory()

getCategory()

Inherited

getComments()

getComments() : string

see

Returns

stringcomments

getEvent()

getEvent() : string

see

Returns

stringevent

getFutureEvents()

getFutureEvents() : string

Returns

stringfutureevents

getMaxResults()

getMaxResults() : integer

Inherited

Returns

integermaxResults

getOrderBy()

getOrderBy() : string

Returns

stringorderby

getParam()

getParam(string $name)

Inherited

Parameters

$name

string

getProjection()

getProjection() : string

see

Returns

stringprojection

getPublishedMax()

getPublishedMax() : string

Inherited

Returns

stringpublishedMax

getPublishedMin()

getPublishedMin() : string

Inherited

Returns

stringpublishedMin

getQuery()

getQuery() : string

Inherited

Returns

stringquery

getQueryString()

getQueryString() : string

Inherited

Returns

stringquerystring

getQueryUrl()

getQueryUrl() : string

inherited_from	\Zend_Gdata_Query::getQueryUrl()

Returns

stringurl

getQueryUrl()

getQueryUrl() : string

Inherited

Returns

stringurl

getRecurrenceExpansionEnd()

getRecurrenceExpansionEnd() : string

Returns

stringrecurrence-expansion-end

getRecurrenceExpansionStart()

getRecurrenceExpansionStart() : string

Returns

stringrecurrence-expansion-start

getSingleEvents()

getSingleEvents() : \Zend_Gdata_Calendar_EventQuery

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

getSortOrder()

getSortOrder() : string

Returns

stringsortorder

getStartIndex()

getStartIndex() : integer

Inherited

Returns

integerstartIndex

getStartMax()

getStartMax() : integer

Returns

integerstart-max

getStartMin()

getStartMin() : integer

Returns

integerstart-min

getUpdatedMax()

getUpdatedMax() : string

Inherited

Returns

stringupdatedMax

getUpdatedMin()

getUpdatedMin() : string

Inherited

Returns

stringupdatedMin

getUser()

getUser() : string

see

Returns

stringuser

getVisibility()

getVisibility() : string

see

Returns

stringvisibility

resetParameters()

resetParameters()

Inherited

setAlt()

setAlt(string $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setAuthor()

setAuthor(string $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setCategory()

setCategory(string $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setComments()

setComments(string $value) : \Zend_Gdata_Calendar_EventQuery

see

Parameters

$value

string

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setEvent()

setEvent(string $value) : \Zend_Gdata_Calendar_EventQuery

see

Parameters

$value

string

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setFutureEvents()

setFutureEvents(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

$value

string

Also accepts bools. If using a string, must be either "true" or "false" or an exception will be thrown on retrieval.

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setMaxResults()

setMaxResults(integer $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

setOrderBy()

setOrderBy(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

$value

string

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setParam()

setParam(string $name, string $value) : \Zend_Gdata_Query

Inherited

Parameters

$name

string

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setProjection()

setProjection(string $value) : \Zend_Gdata_Calendar_EventQuery

see

Parameters

$value

string

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setPublishedMax()

setPublishedMax(string $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMin()

setPublishedMin(string $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setQuery()

setQuery(string $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setRecurrenceExpansionEnd()

setRecurrenceExpansionEnd($value) : string

Parameters

$value

Returns

stringrecurrence-expansion-end

setRecurrenceExpansionStart()

setRecurrenceExpansionStart($value) : string

Parameters

$value

Returns

stringrecurrence-expansion-start

setSingleEvents()

setSingleEvents(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

$value

string

Also accepts bools. If using a string, must be either "true" or "false".

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setSortOrder()

setSortOrder($value) : string

Parameters

$value

Returns

stringsortorder

setStartIndex()

setStartIndex(integer $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

setStartMax()

setStartMax(integer $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

$value

integer

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setStartMin()

setStartMin(integer $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

$value

integer

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setUpdatedMax()

setUpdatedMax(string $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUpdatedMin()

setUpdatedMin(string $value) : \Zend_Gdata_Query

Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUser()

setUser(string $value) : \Zend_Gdata_Calendar_EventQuery

see

Parameters

$value

string

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

setVisibility()

setVisibility(boolean $value) : \Zend_Gdata_Calendar_EventQuery

see

Parameters

$value

boolean

Returns

\Zend_Gdata_Calendar_EventQueryProvides a fluent interface

Properties

Category for the query

$_category : string

Default

null

The comment ID to retrieve. If null, no specific comment will be retrieved unless already included in the query URI. The event ID ($_event) must be set, otherwise this property is ignored.

$_comments

Default

null

The default URI used for feeds.

$_defaultFeedUri

Default

self::CALENDAR_FEED_URI

inherited_from	\Zend_Gdata_Query::_defaultFeedUri

Default URL

$_defaultFeedUri : string

Default

null

The event ID to retrieve. If null, no specific event will be retrieved unless already included in the query URI.

$_event

Default

null

Query parameters.

$_params : array

Default

array()

Projection to be requested by queries. Defaults to "full". A null value should be used when the calendar address has already been set as part of the query URI.

$_projection

Default

'full'

Base URL TODO: Add setters and getters

$_url : string

Default

null

The calendar address to be requested by queries. This may be an email address if requesting the primary calendar for a user. Defaults to "default" (the currently authenticated user). A null value should be used when the calendar address has already been set as part of the query URI.

$_user

Default

'default'

$_visibility

$_visibility

Default

'public'

Constants

CALENDAR_FEED_URI

CALENDAR_FEED_URI = 'https://www.google.com/calendar/feeds'