Zend Framework  1.12
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Zend_Gdata_Calendar_EventQuery Class Reference

Public Member Functions

 __construct ($url=null)
 Create Gdata_Calendar_EventQuery object.
 
 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 ()
 
- Public Member Functions inherited from Zend_Gdata_Query
 __construct ($url=null)
 Create Gdata_Query object.
 
 getQueryString ()
 
 resetParameters ()
 
 getQueryUrl ()
 
 setParam ($name, $value)
 
 getParam ($name)
 
 setAlt ($value)
 
 setMaxResults ($value)
 
 setQuery ($value)
 
 setStartIndex ($value)
 
 setUpdatedMax ($value)
 
 setUpdatedMin ($value)
 
 setPublishedMax ($value)
 
 setPublishedMin ($value)
 
 setAuthor ($value)
 
 getAlt ()
 
 getMaxResults ()
 
 getQuery ()
 
 getStartIndex ()
 
 getUpdatedMax ()
 
 getUpdatedMin ()
 
 getPublishedMax ()
 
 getPublishedMin ()
 
 getAuthor ()
 
 setCategory ($value)
 
 getCategory ()
 
 __get ($name)
 
 __set ($name, $val)
 

Public Attributes

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

Protected Attributes

 $_defaultFeedUri = self::CALENDAR_FEED_URI
 The default URI used for feeds.
 
 $_comments = null
 The comment ID to retrieve.
 
 $_user = 'default'
 The calendar address to be requested by queries.
 
 $_visibility = 'public'
 
 $_projection = 'full'
 Projection to be requested by queries.
 
 $_event = null
 The event ID to retrieve.
 
- Protected Attributes inherited from Zend_Gdata_Query
 $_params = array()
 
 $_defaultFeedUri = null
 
 $_url = null
 
 $_category = null
 

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 '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
string$urlThe URL to use as the base path for requests

Member Function Documentation

getComments ( )
See Also
$_comments;
Returns
string comments
getEvent ( )
See Also
$_event;
Returns
string event
getFutureEvents ( )
Returns
string futureevents
getOrderBy ( )
Returns
string orderby
getProjection ( )
See Also
$_projection
Returns
string projection
getQueryUrl ( )
Returns
string url
getRecurrenceExpansionEnd ( )
Returns
string recurrence-expansion-end
getRecurrenceExpansionStart ( )
Returns
string recurrence-expansion-start
getSingleEvents ( )
Parameters
string$valueAlso accepts bools.
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface
getSortOrder ( )
Returns
string sortorder
getStartMax ( )
Returns
int start-max
getStartMin ( )
Returns
int start-min
getUser ( )
See Also
$_user
Returns
string user
getVisibility ( )
See Also
$_visibility
Returns
string visibility
setComments (   $value)
See Also
$_comments
Parameters
string$value
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface
setEvent (   $value)
See Also
$_event
Parameters
string$value
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface
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
setOrderBy (   $value)
Parameters
string$value
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface
setProjection (   $value)
See Also
$_projection
Parameters
string$value
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface
setRecurrenceExpansionEnd (   $value)
Returns
string recurrence-expansion-end
setRecurrenceExpansionStart (   $value)
Returns
string recurrence-expansion-start
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
setSortOrder (   $value)
Returns
string sortorder
setStartMax (   $value)
Parameters
int$value
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface
setStartMin (   $value)
Parameters
int$value
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface
setUser (   $value)
See Also
$_user
Parameters
string$value
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface
setVisibility (   $value)
See Also
$_visibility
Parameters
bool$value
Returns
Zend_Gdata_Calendar_EventQuery Provides a fluent interface

Member Data 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.

$_defaultFeedUri = self::CALENDAR_FEED_URI
protected

The default URI used for feeds.

$_event = null
protected

The event ID to retrieve.

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

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

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

$_visibility = 'public'
protected
const CALENDAR_FEED_URI = 'https://www.google.com/calendar/feeds'