Gdata/Calendar/EventQuery.php

+ Show: +

inherited

+ Classes +
- \Zend_Gdata_Calendar_EventQuery

+ 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: Calendar + +
Version: $Id: EventQuery.php 24593 2012-01-05 20:35:02Z matthew $ + +

\Zend_Gdata_Calendar_EventQuery
jump to top

Package: Zend\Gdata\Calendar

Assists in constructing queries for Google Calendar events

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

Parent(s): \Zend_Gdata_Query
Category: Zend + +
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) + +
License: New BSD License + +
Link: http://code.google.com/apis/gdata/calendar/ + +

Constants

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

Properties

string $_category = null

inherited

Category for the query

Inherited from: + \Zend_Gdata_Query::$$_category

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_category + +

$_comments = 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.

Default valuenullDetails

Type: n/a

string $_defaultFeedUri = self::CALENDAR_FEED_URI

The default URI used for feeds.

Default valueself::CALENDAR_FEED_URIDetails

Type: string

$_event = null

The event ID to retrieve.

If null, no specific event will be retrieved +unless already included in the query URI.

Default valuenullDetails

Type: n/a

array $_params = array()

inherited

Query parameters.

Inherited from: + \Zend_Gdata_Query::$$_params

Default valuearray()Details

Type: array
Inherited_from: \Zend_Gdata_Query::$$_params + +

$_projection = 'full'

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.

Default value'full'Details

Type: n/a

string $_url = null

inherited

Base URL +TODO: Add setters and getters

Inherited from: + \Zend_Gdata_Query::$$_url

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_url + +

$_user = 'default'

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.

Default value'default'Details

Type: n/a

$_visibility = 'public'

Default value'public'Details

Type: n/a

Methods

__construct(string $url = null) : void

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

+ +

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.

Parameters

Name	Type	Description
$url	string	The URL to use as the base path for requests

__get( $name) : void

inherited

Inherited from: + \Zend_Gdata_Query::__get()

Parameters

Name	Type	Description
$name

__set( $name, $val) : void

inherited

Inherited from: + \Zend_Gdata_Query::__set()

Parameters

Name	Type	Description
$name
$val

getAlt() : string

inherited

Inherited from: + \Zend_Gdata_Query::getAlt()

Returns

Type	Description
string	rss or atom

getAuthor() : string

inherited

Inherited from: + \Zend_Gdata_Query::getAuthor()

Returns

Type	Description
string	author

getCategory() : void

inherited

Inherited from: + \Zend_Gdata_Query::getCategory()

getComments() : string

Returns

Type	Description
string	comments

Details

See: \$_comments; + +

getEvent() : string

Returns

Type	Description
string	event

Details

See: \$_event; + +

getFutureEvents() : string

Returns

Type	Description
string	futureevents

getMaxResults() : int

inherited

Inherited from: + \Zend_Gdata_Query::getMaxResults()

Returns

Type	Description
int	maxResults

getOrderBy() : string

Returns

Type	Description
string	orderby

getParam(string $name) : void

inherited

Inherited from: + \Zend_Gdata_Query::getParam()

Parameters

Name	Type	Description
$name	string

getProjection() : string

Returns

Type	Description
string	projection

Details

See: \$_projection + +

getPublishedMax() : string

inherited

Inherited from: + \Zend_Gdata_Query::getPublishedMax()

Returns

Type	Description
string	publishedMax

getPublishedMin() : string

inherited

Inherited from: + \Zend_Gdata_Query::getPublishedMin()

Returns

Type	Description
string	publishedMin

getQuery() : string

inherited

Inherited from: + \Zend_Gdata_Query::getQuery()

Returns

Type	Description
string	query

getQueryString() : string

inherited

Inherited from: + \Zend_Gdata_Query::getQueryString()

Returns

Type	Description
string	querystring

getQueryUrl() : string

Returns

Type	Description
string	url

getRecurrenceExpansionEnd() : string

Returns

Type	Description
string	recurrence-expansion-end

getRecurrenceExpansionStart() : string

Returns

Type	Description
string	recurrence-expansion-start

getSingleEvents() : \Zend_Gdata_Calendar_EventQuery

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

getSortOrder() : string

Returns

Type	Description
string	sortorder

getStartIndex() : int

inherited

Inherited from: + \Zend_Gdata_Query::getStartIndex()

Returns

Type	Description
int	startIndex

getStartMax() : int

Returns

Type	Description
int	start-max

getStartMin() : int

Returns

Type	Description
int	start-min

getUpdatedMax() : string

inherited

Inherited from: + \Zend_Gdata_Query::getUpdatedMax()

Returns

Type	Description
string	updatedMax

getUpdatedMin() : string

inherited

Inherited from: + \Zend_Gdata_Query::getUpdatedMin()

Returns

Type	Description
string	updatedMin

getUser() : string

Returns

Type	Description
string	user

Details

See: \$_user + +

getVisibility() : string

Returns

Type	Description
string	visibility

Details

See: \$_visibility + +

resetParameters() : void

inherited

Inherited from: + \Zend_Gdata_Query::resetParameters()

setAlt(string $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setAlt()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setAuthor(string $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setAuthor()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setCategory(string $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setCategory()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setComments(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

Details

See: \$_comments + +

setEvent(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

Details

See: \$_event + +

setFutureEvents(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	string	Also accepts bools. If using a string, must be either "true" or "false" or + an exception will be thrown on retrieval. +

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

setMaxResults(int $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setMaxResults()

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setOrderBy(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

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

inherited

Inherited from: + \Zend_Gdata_Query::setParam()

Parameters

Name	Type	Description
$name	string
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setProjection(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

Details

See: \$_projection + +

setPublishedMax(string $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setPublishedMax()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setPublishedMin(string $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setPublishedMin()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setQuery(string $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setQuery()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setRecurrenceExpansionEnd( $value) : string

Parameters

Name	Type	Description
$value

Returns

Type	Description
string	recurrence-expansion-end

setRecurrenceExpansionStart( $value) : string

Parameters

Name	Type	Description
$value

Returns

Type	Description
string	recurrence-expansion-start

setSingleEvents(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	string	Also accepts bools. If using a string, must be either "true" or "false". +

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

setSortOrder( $value) : string

Parameters

Name	Type	Description
$value

Returns

Type	Description
string	sortorder

setStartIndex(int $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setStartIndex()

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setStartMax(int $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

setStartMin(int $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

setUpdatedMax(string $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setUpdatedMax()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setUpdatedMin(string $value) : \Zend_Gdata_Query

inherited

Inherited from: + \Zend_Gdata_Query::setUpdatedMin()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setUser(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

Details

See: \$_user + +

setVisibility(bool $value) : \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	bool

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

Details

See: \$_visibility + +

Gdata/Calendar/EventQuery.php

\Zend_Gdata_Calendar_EventQueryjump to top

Constants

Properties

Methods

\Zend_Gdata_Calendar_EventQuery
jump to top