Gdata/Calendar/EventQuery.php
Show:
inherited
inherited
Classes
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: EventQuery.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_Calendar_EventQuery
Package: Zend\Gdata\Calendar
Default value
Default value
Default value
Default value
Parameters
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
Properties
string $_category = null
Default value
nullDetails- Type
- string
- Inherited_from
- \Zend_Gdata_Query::$$_category
$_comments = nullThe 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.
nullDetails- Type
- n/a
string $_defaultFeedUri = self::CALENDAR_FEED_URIThe default URI used for feeds.
Default value
self::CALENDAR_FEED_URIDetails- Type
- string
$_event = nullThe event ID to retrieve.
If null, no specific event will be retrieved unless already included in the query URI.
nullDetails- Type
- n/a
array $_params = array()
Default value
array()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.
'full'Details- Type
- n/a
$_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'Details- Type
- n/a
$_visibility = 'public'
Default value
'public'Details- Type
- n/a
Methods
__construct(string $url = null) : voidCreate 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.
| 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 |
getComments() : string
Returns
Details
| Type | Description |
|---|---|
| string | comments |
- See
- \global\$_comments;
getEvent() : string
Returns
Details
| Type | Description |
|---|---|
| string | event |
- See
- \global\$_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
Details
| Type | Description |
|---|---|
| string | projection |
- See
- \global\$_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
Details
| Type | Description |
|---|---|
| string | user |
- See
- \global\$_user
getVisibility() : string
Returns
Details
| Type | Description |
|---|---|
| string | visibility |
- See
- \global\$_visibility
setAlt(string $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setAlt()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setAuthor(string $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setAuthor()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setCategory(string $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setCategory()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setComments(string $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \global\$_comments
setEvent(string $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \global\$_event
setFutureEvents(string $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
| 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. |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
setMaxResults(int $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setMaxResults()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | int |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setOrderBy(string $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| 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
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setProjection(string $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \global\$_projection
setPublishedMax(string $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setPublishedMax()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setPublishedMin(string $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setPublishedMin()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setQuery(string $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setQuery()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setRecurrenceExpansionEnd( $value) : string
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value |
| Type | Description |
|---|---|
| string | recurrence-expansion-end |
setRecurrenceExpansionStart( $value) : string
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value |
| Type | Description |
|---|---|
| string | recurrence-expansion-start |
setSingleEvents(string $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string | Also accepts bools. If using a string, must be either "true" or "false". |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
setSortOrder( $value) : string
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value |
| Type | Description |
|---|---|
| string | sortorder |
setStartIndex(int $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setStartIndex()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | int |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setStartMax(int $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | int |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
setStartMin(int $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | int |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
setUpdatedMax(string $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setUpdatedMax()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setUpdatedMin(string $value) : \Zend_Gdata_Query
inherited
Inherited from:
\Zend_Gdata_Query::setUpdatedMin()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Query | Provides a fluent interface |
setUser(string $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \global\$_user
setVisibility(bool $value) : \Zend_Gdata_Calendar_EventQuery
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $value | bool |
| Type | Description |
|---|---|
| \Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \global\$_visibility