## API Documentation

# Gdata/Calendar/EventQuery.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
  New BSD License
package
  Zend_Gdata
subpackage
  Calendar
version
  $Id: EventQuery.php 23805 2011-03-16 00:55:40Z tjohns $

## \Zend_Gdata_Calendar_EventQuery
jump to top

Assists in constructing queries for Google Calendar events

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

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

### Constants

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

### Properties

`$_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 value `null` Details

Type

`string $_defaultFeedUri= 'self'`

The default URI used for feeds.

Default value `self` Details

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 value `null` Details

Type

`$_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

`$_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

`$_visibility= 'public'`
Default value `public` Details

Type

### 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 from: \Zend_Gdata_Query::__get()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

`__set( $name, $val ) : void`

Inherited from: \Zend_Gdata_Query::__set()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |
$val |  |

`getAlt( ) : string`

Inherited from: \Zend_Gdata_Query::getAlt()
Returns

Type | Description
--- | ---
string | rss or atom

`getAuthor( ) : string`

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns

Type | Description
--- | ---
string | author

`getCategory( ) : void`

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 from: \Zend_Gdata_Query::getMaxResults()
Returns

Type | Description
--- | ---
int | maxResults

`getOrderBy( ) : string`

Returns

Type | Description
--- | ---
string | orderby

`getParam( string $name ) : void`

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 from: \Zend_Gdata_Query::getPublishedMax()
Returns

Type | Description
--- | ---
string | publishedMax

`getPublishedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns

Type | Description
--- | ---
string | publishedMin

`getQuery( ) : string`

Inherited from: \Zend_Gdata_Query::getQuery()
Returns

Type | Description
--- | ---
string | query

`getQueryString( ) : string`

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 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 from: \Zend_Gdata_Query::getUpdatedMax()
Returns

Type | Description
--- | ---
string | updatedMax

`getUpdatedMin( ) : string`

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 from: \Zend_Gdata_Query::resetParameters()
`setAlt( string $value ) : \Zend_Gdata_Query`

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

Documentation was generated by DocBlox 0.13.3.