API Documentation

Zend/Gdata/Calendar/EventQuery.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Calendar_EventQuery

Package: Zend\Gdata\Calendar

Assists in constructing queries for Google Calendar events

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

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

Properties

Propertyprotected  $_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
Propertyprotected  $_defaultFeedUri= 'self::CALENDAR_FEED_URI'

The default URI used for feeds.

Default valueself::CALENDAR_FEED_URIDetails
Type
Propertyprotected  $_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
Propertyprotected  $_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
Propertyprotected  $_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
Propertyprotected  $_visibility= ''public''
Default value'public'Details
Type

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
Name Type Description
$url string

The URL to use as the base path for requests

methodpublicgetComments( ) : string

Returns
Type Description
string comments
Details
See
\$_comments;  
methodpublicgetEvent( ) : string

Returns
Type Description
string event
Details
See
\$_event;  
methodpublicgetFutureEvents( ) : string

Returns
Type Description
string futureevents
methodpublicgetOrderBy( ) : string

Returns
Type Description
string orderby
methodpublicgetProjection( ) : string

Returns
Type Description
string projection
Details
See
\$_projection  
methodpublicgetQueryUrl( ) : string

Returns
Type Description
string url
methodpublicgetRecurrenceExpansionEnd( ) : string

Returns
Type Description
string recurrence-expansion-end
methodpublicgetRecurrenceExpansionStart( ) : string

Returns
Type Description
string recurrence-expansion-start
methodpublicgetSingleEvents( ) : \Zend_Gdata_Calendar_EventQuery

Returns
Type Description
\Zend_Gdata_Calendar_EventQuery Provides a fluent interface
methodpublicgetSortOrder( ) : string

Returns
Type Description
string sortorder
methodpublicgetStartMax( ) : int

Returns
Type Description
int start-max
methodpublicgetStartMin( ) : int

Returns
Type Description
int start-min
methodpublicgetUser( ) : string

Returns
Type Description
string user
Details
See
\$_user  
methodpublicgetVisibility( ) : string

Returns
Type Description
string visibility
Details
See
\$_visibility  
methodpublicsetComments( 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  
methodpublicsetEvent( 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  
methodpublicsetFutureEvents( 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
methodpublicsetOrderBy( string $value ) : \Zend_Gdata_Calendar_EventQuery

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Calendar_EventQuery Provides a fluent interface
methodpublicsetProjection( 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  
methodpublicsetRecurrenceExpansionEnd(  $value ) : string

Parameters
Name Type Description
$value
Returns
Type Description
string recurrence-expansion-end
methodpublicsetRecurrenceExpansionStart(  $value ) : string

Parameters
Name Type Description
$value
Returns
Type Description
string recurrence-expansion-start
methodpublicsetSingleEvents( 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
methodpublicsetSortOrder(  $value ) : string

Parameters
Name Type Description
$value
Returns
Type Description
string sortorder
methodpublicsetStartMax( int $value ) : \Zend_Gdata_Calendar_EventQuery

Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Calendar_EventQuery Provides a fluent interface
methodpublicsetStartMin( int $value ) : \Zend_Gdata_Calendar_EventQuery

Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Calendar_EventQuery Provides a fluent interface
methodpublicsetUser( 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  
methodpublicsetVisibility( 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.15.1.