Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_Calendar_EventQuery Class Reference
Inheritance diagram for Zend_Gdata_Calendar_EventQuery:
Collaboration diagram for Zend_Gdata_Calendar_EventQuery:

Public Member Functions

 __construct ($url=null)
 setComments ($value)
 setEvent ($value)
 setProjection ($value)
 setUser ($value)
 setVisibility ($value)
 getComments ()
 getEvent ()
 getProjection ()
 getUser ()
 getVisibility ()
 setStartMax ($value)
 setStartMin ($value)
 setOrderBy ($value)
 getStartMax ()
 getStartMin ()
 getOrderBy ()
 getSortOrder ()
 setSortOrder ($value)
 getRecurrenceExpansionStart ()
 setRecurrenceExpansionStart ($value)
 getRecurrenceExpansionEnd ()
 setRecurrenceExpansionEnd ($value)
 getSingleEvents ()
 setSingleEvents ($value)
 getFutureEvents ()
 setFutureEvents ($value)
 getQueryUrl ()

Data Fields

const CALENDAR_FEED_URI = 'http://www.google.com/calendar/feeds'

Protected Attributes

 $_defaultFeedUri = self::CALENDAR_FEED_URI
 $_comments = null
 $_user = 'default'
 $_visibility = 'public'
 $_projection = 'full'
 $_event = null

Detailed Description

Definition at line 45 of file EventQuery.php.


Constructor & Destructor Documentation

__construct ( url = null)

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 'http://www.google.com/calendar', the default URL constructed will be 'http://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:
string$urlThe URL to use as the base path for requests

Reimplemented from Zend_Gdata_Query.

Definition at line 105 of file EventQuery.php.


Member Function Documentation

See also:
$_comments;
Returns:
string comments

Definition at line 169 of file EventQuery.php.

Here is the caller graph for this function:

getEvent ( )
See also:
$_event;
Returns:
string event

Definition at line 178 of file EventQuery.php.

Here is the caller graph for this function:

Returns:
string futureevents

Definition at line 416 of file EventQuery.php.

Returns:
string orderby

Definition at line 279 of file EventQuery.php.

See also:
$_projection
Returns:
string projection

Definition at line 187 of file EventQuery.php.

Here is the caller graph for this function:

Returns:
string url

Reimplemented from Zend_Gdata_Query.

Definition at line 465 of file EventQuery.php.

Here is the call graph for this function:

Returns:
string recurrence-expansion-end

Definition at line 342 of file EventQuery.php.

Returns:
string recurrence-expansion-start

Definition at line 316 of file EventQuery.php.

Parameters:
string$valueAlso accepts bools.
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 368 of file EventQuery.php.

Returns:
string sortorder

Definition at line 291 of file EventQuery.php.

Returns:
int start-max

Definition at line 255 of file EventQuery.php.

Returns:
int start-min

Definition at line 267 of file EventQuery.php.

getUser ( )
See also:
$_user
Returns:
string user

Definition at line 196 of file EventQuery.php.

Here is the caller graph for this function:

See also:
$_visibility
Returns:
string visibility

Definition at line 205 of file EventQuery.php.

Here is the caller graph for this function:

setComments ( value)
See also:
$_comments
Parameters:
string$value
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 115 of file EventQuery.php.

setEvent ( value)
See also:
$_event
Parameters:
string$value
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 126 of file EventQuery.php.

setFutureEvents ( value)
Parameters:
string$valueAlso accepts bools. If using a string, must be either "true" or "false" or an exception will be thrown on retrieval.
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 443 of file EventQuery.php.

setOrderBy ( value)
Parameters:
string$value
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 242 of file EventQuery.php.

setProjection ( value)
See also:
$_projection
Parameters:
string$value
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 137 of file EventQuery.php.

Returns:
string recurrence-expansion-end

Definition at line 354 of file EventQuery.php.

Here is the call graph for this function:

Returns:
string recurrence-expansion-start

Definition at line 328 of file EventQuery.php.

Here is the call graph for this function:

setSingleEvents ( value)
Parameters:
string$valueAlso accepts bools. If using a string, must be either "true" or "false".
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 394 of file EventQuery.php.

setSortOrder ( value)
Returns:
string sortorder

Definition at line 303 of file EventQuery.php.

setStartMax ( value)
Parameters:
int$value
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 214 of file EventQuery.php.

Here is the call graph for this function:

setStartMin ( value)
Parameters:
int$value
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 228 of file EventQuery.php.

Here is the call graph for this function:

setUser ( value)
See also:
$_user
Parameters:
string$value
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 148 of file EventQuery.php.

setVisibility ( value)
See also:
$_visibility
Parameters:
bool$value
Returns:
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Definition at line 159 of file EventQuery.php.


Field Documentation

$_comments = null [protected]

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.

Definition at line 60 of file EventQuery.php.

$_defaultFeedUri = self::CALENDAR_FEED_URI [protected]

The default URI used for feeds.

Reimplemented from Zend_Gdata_Query.

Definition at line 53 of file EventQuery.php.

$_event = null [protected]

The event ID to retrieve. If null, no specific event will be retrieved unless already included in the query URI.

Definition at line 89 of file EventQuery.php.

$_projection = 'full' [protected]

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.

Definition at line 83 of file EventQuery.php.

$_user = 'default' [protected]

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.

Definition at line 69 of file EventQuery.php.

$_visibility = 'public' [protected]

Definition at line 76 of file EventQuery.php.

const CALENDAR_FEED_URI = 'http://www.google.com/calendar/feeds'

Definition at line 48 of file EventQuery.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations