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

\Zend_Gdata_Calendar_EventQuery

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

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

Properties

>VPropertyprotectedstring $_category = null
inherited
Category for the query
Inherited from: \Zend_Gdata_Query::$$_category
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_category  
>VPropertyprotected$_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
>VPropertyprotectedstring $_defaultFeedUri = self::CALENDAR_FEED_URI
The default URI used for feeds.
Default valueself::CALENDAR_FEED_URIDetails
Type
string
>VPropertyprotected$_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
>VPropertyprotectedarray $_params = array()
inherited
Query parameters.
Inherited from: \Zend_Gdata_Query::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_Query::$$_params  
>VPropertyprotected$_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
>VPropertyprotectedstring $_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  
>VPropertyprotected$_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
>VPropertyprotected$_visibility = 'public'
Default value'public'Details
Type
n/a

Methods

methodpublic__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
NameTypeDescription
$urlstring

The URL to use as the base path for requests

methodpublic__get( $name) : void
inherited

Inherited from: \Zend_Gdata_Query::__get()
Parameters
NameTypeDescription
$name
methodpublic__set( $name,  $val) : void
inherited

Inherited from: \Zend_Gdata_Query::__set()
Parameters
NameTypeDescription
$name
$val
methodpublicgetAlt() : string
inherited

Inherited from: \Zend_Gdata_Query::getAlt()
Returns
TypeDescription
stringrss or atom
methodpublicgetAuthor() : string
inherited

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns
TypeDescription
stringauthor
methodpublicgetCategory() : void
inherited

Inherited from: \Zend_Gdata_Query::getCategory()
methodpublicgetComments() : string

Returns
TypeDescription
stringcomments
Details
See
\$_comments;  
methodpublicgetEvent() : string

Returns
TypeDescription
stringevent
Details
See
\$_event;  
methodpublicgetFutureEvents() : string

Returns
TypeDescription
stringfutureevents
methodpublicgetMaxResults() : int
inherited

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns
TypeDescription
intmaxResults
methodpublicgetOrderBy() : string

Returns
TypeDescription
stringorderby
methodpublicgetParam(string $name) : void
inherited

Inherited from: \Zend_Gdata_Query::getParam()
Parameters
NameTypeDescription
$namestring
methodpublicgetProjection() : string

Returns
TypeDescription
stringprojection
Details
See
\$_projection  
methodpublicgetPublishedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns
TypeDescription
stringpublishedMax
methodpublicgetPublishedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns
TypeDescription
stringpublishedMin
methodpublicgetQuery() : string
inherited

Inherited from: \Zend_Gdata_Query::getQuery()
Returns
TypeDescription
stringquery
methodpublicgetQueryString() : string
inherited

Inherited from: \Zend_Gdata_Query::getQueryString()
Returns
TypeDescription
stringquerystring
methodpublicgetQueryUrl() : string

Returns
TypeDescription
stringurl
methodpublicgetRecurrenceExpansionEnd() : string

Returns
TypeDescription
stringrecurrence-expansion-end
methodpublicgetRecurrenceExpansionStart() : string

Returns
TypeDescription
stringrecurrence-expansion-start
methodpublicgetSingleEvents() : \Zend_Gdata_Calendar_EventQuery

Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
methodpublicgetSortOrder() : string

Returns
TypeDescription
stringsortorder
methodpublicgetStartIndex() : int
inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns
TypeDescription
intstartIndex
methodpublicgetStartMax() : int

Returns
TypeDescription
intstart-max
methodpublicgetStartMin() : int

Returns
TypeDescription
intstart-min
methodpublicgetUpdatedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns
TypeDescription
stringupdatedMax
methodpublicgetUpdatedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns
TypeDescription
stringupdatedMin
methodpublicgetUser() : string

Returns
TypeDescription
stringuser
Details
See
\$_user  
methodpublicgetVisibility() : string

Returns
TypeDescription
stringvisibility
Details
See
\$_visibility  
methodpublicresetParameters() : void
inherited

Inherited from: \Zend_Gdata_Query::resetParameters()
methodpublicsetAlt(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetAuthor(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAuthor()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetCategory(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setCategory()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetComments(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
Details
See
\$_comments  
methodpublicsetEvent(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
Details
See
\$_event  
methodpublicsetFutureEvents(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valuestring

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

Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
methodpublicsetMaxResults(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetOrderBy(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
methodpublicsetParam(string $name, string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setParam()
Parameters
NameTypeDescription
$namestring
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetProjection(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
Details
See
\$_projection  
methodpublicsetPublishedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetQuery(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setQuery()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetRecurrenceExpansionEnd( $value) : string

Parameters
NameTypeDescription
$value
Returns
TypeDescription
stringrecurrence-expansion-end
methodpublicsetRecurrenceExpansionStart( $value) : string

Parameters
NameTypeDescription
$value
Returns
TypeDescription
stringrecurrence-expansion-start
methodpublicsetSingleEvents(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valuestring

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

Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
methodpublicsetSortOrder( $value) : string

Parameters
NameTypeDescription
$value
Returns
TypeDescription
stringsortorder
methodpublicsetStartIndex(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setStartIndex()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetStartMax(int $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
methodpublicsetStartMin(int $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
methodpublicsetUpdatedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUser(string $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
Details
See
\$_user  
methodpublicsetVisibility(bool $value) : \Zend_Gdata_Calendar_EventQuery

Parameters
NameTypeDescription
$valuebool
Returns
TypeDescription
\Zend_Gdata_Calendar_EventQueryProvides a fluent interface
Details
See
\$_visibility  
Documentation was generated by phpDocumentor 2.0.0a12.