Gdata/Calendar/EventQuery.php
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
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
null
Details- Type
- string
- Inherited_from
- \Zend_Gdata_Query::$$_category


$_comments = null
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.
null
Details- Type
- n/a


string $_defaultFeedUri = self::CALENDAR_FEED_URI
self::CALENDAR_FEED_URI
Details- Type
- string


$_event = null
If null, no specific event will be retrieved unless already included in the query URI.
null
Details- Type
- n/a


array $_params = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Gdata_Query::$$_params


$_projection = 'full'
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'
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
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.
Name | Type | Description |
---|---|---|
$url | string | The URL to use as the base path for requests |


__get( $name) : void
Name | Type | Description |
---|---|---|
$name |


__set( $name, $val) : void
Name | Type | Description |
---|---|---|
$name | ||
$val |


getAlt() : string
Type | Description |
---|---|
string | rss or atom |


getAuthor() : string
Type | Description |
---|---|
string | author |


getMaxResults() : int
Type | Description |
---|---|
int | maxResults |


getParam(string $name) : void
Name | Type | Description |
---|---|---|
$name | string |


getPublishedMax() : string
Type | Description |
---|---|
string | publishedMax |


getPublishedMin() : string
Type | Description |
---|---|
string | publishedMin |


getQuery() : string
Type | Description |
---|---|
string | query |


getQueryString() : string
Type | Description |
---|---|
string | querystring |


getSingleEvents() : \Zend_Gdata_Calendar_EventQuery
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |


getStartIndex() : int
Type | Description |
---|---|
int | startIndex |


getUpdatedMax() : string
Type | Description |
---|---|
string | updatedMax |


getUpdatedMin() : string
Type | Description |
---|---|
string | updatedMin |


setAlt(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setAuthor(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setCategory(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setComments(string $value) : \Zend_Gdata_Calendar_EventQuery
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \$_comments


setEvent(string $value) : \Zend_Gdata_Calendar_EventQuery
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \$_event


setFutureEvents(string $value) : \Zend_Gdata_Calendar_EventQuery
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
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setOrderBy(string $value) : \Zend_Gdata_Calendar_EventQuery
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |


setParam(string $name, string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$name | string | |
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setProjection(string $value) : \Zend_Gdata_Calendar_EventQuery
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \$_projection


setPublishedMax(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setPublishedMin(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setQuery(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setRecurrenceExpansionEnd( $value) : string
Name | Type | Description |
---|---|---|
$value |
Type | Description |
---|---|
string | recurrence-expansion-end |


setRecurrenceExpansionStart( $value) : string
Name | Type | Description |
---|---|---|
$value |
Type | Description |
---|---|
string | recurrence-expansion-start |


setSingleEvents(string $value) : \Zend_Gdata_Calendar_EventQuery
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
Name | Type | Description |
---|---|---|
$value |
Type | Description |
---|---|
string | sortorder |


setStartIndex(int $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setStartMax(int $value) : \Zend_Gdata_Calendar_EventQuery
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |


setStartMin(int $value) : \Zend_Gdata_Calendar_EventQuery
Name | Type | Description |
---|---|---|
$value | int |
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |


setUpdatedMax(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setUpdatedMin(string $value) : \Zend_Gdata_Query
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Query | Provides a fluent interface |


setUser(string $value) : \Zend_Gdata_Calendar_EventQuery
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \$_user


setVisibility(bool $value) : \Zend_Gdata_Calendar_EventQuery
Name | Type | Description |
---|---|---|
$value | bool |
Type | Description |
---|---|
\Zend_Gdata_Calendar_EventQuery | Provides a fluent interface |
- See
- \$_visibility