Class Zend_Gdata_Calendar_EventQuery

Description

Assists in constructing queries for Google Calendar events

Located in /Gdata/Calendar/EventQuery.php (line 45)

Zend_Gdata_Query
   |
   --Zend_Gdata_Calendar_EventQuery
Class Constant Summary
 CALENDAR_FEED_URI = 'http://www.google.com/calendar/feeds'
Variable Summary
 mixed $_comments
 mixed $_event
 mixed $_projection
 mixed $_user
 mixed $_visibility
Method Summary
Variables
mixed $_comments = null (line 60)

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.

  • access: protected
mixed $_defaultFeedUri = self::CALENDAR_FEED_URI (line 53)

The default URI used for feeds.

  • access: protected

Redefinition of:
Zend_Gdata_Query::$_defaultFeedUri
Default URL
mixed $_event = null (line 89)

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

  • access: protected
mixed $_projection = 'full' (line 83)

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.

  • access: protected
mixed $_user = 'default' (line 69)

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.

  • access: protected
mixed $_visibility = 'public' (line 76)
  • access: protected

Inherited Variables

Inherited from Zend_Gdata_Query

Zend_Gdata_Query::$_category
Zend_Gdata_Query::$_params
Zend_Gdata_Query::$_url
Methods
Constructor __construct (line 105)

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.

  • access: public
Zend_Gdata_Calendar_EventQuery __construct ([string $url = null])
  • string $url: The URL to use as the base path for requests

Redefinition of:
Zend_Gdata_Query::__construct()
Create Gdata_Query object
getComments (line 169)
  • return: comments
  • see: $_comments;
  • access: public
string getComments ()
getEvent (line 178)
  • return: event
  • see: $_event;
  • access: public
string getEvent ()
getFutureEvents (line 416)
  • return: futureevents
  • access: public
string getFutureEvents ()
getOrderBy (line 279)
  • return: orderby
  • access: public
string getOrderBy ()
getProjection (line 187)
string getProjection ()
getQueryUrl (line 465)
  • return: url
  • access: public
string getQueryUrl ()

Redefinition of:
Zend_Gdata_Query::getQueryUrl()
getRecurrenceExpansionEnd (line 342)
  • return: recurrence-expansion-end
  • access: public
string getRecurrenceExpansionEnd ()
getRecurrenceExpansionStart (line 316)
  • return: recurrence-expansion-start
  • access: public
string getRecurrenceExpansionStart ()
getSingleEvents (line 368)
  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Calendar_EventQuery getSingleEvents (string $value)
  • string $value: Also accepts bools.
getSortOrder (line 291)
  • return: sortorder
  • access: public
string getSortOrder ()
getStartMax (line 255)
  • return: start-max
  • access: public
int getStartMax ()
getStartMin (line 267)
  • return: start-min
  • access: public
int getStartMin ()
getUser (line 196)
string getUser ()
getVisibility (line 205)
string getVisibility ()
setComments (line 115)
Zend_Gdata_Calendar_EventQuery setComments (string $value)
  • string $value
setEvent (line 126)
Zend_Gdata_Calendar_EventQuery setEvent (string $value)
  • string $value
setFutureEvents (line 443)
  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Calendar_EventQuery setFutureEvents (string $value)
  • string $value: Also accepts bools. If using a string, must be either "true" or "false" or an exception will be thrown on retrieval.
setOrderBy (line 242)
  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Calendar_EventQuery setOrderBy (string $value)
  • string $value
setProjection (line 137)
Zend_Gdata_Calendar_EventQuery setProjection (string $value)
  • string $value
setRecurrenceExpansionEnd (line 354)
  • return: recurrence-expansion-end
  • access: public
string setRecurrenceExpansionEnd ( $value)
  • $value
setRecurrenceExpansionStart (line 328)
  • return: recurrence-expansion-start
  • access: public
string setRecurrenceExpansionStart ( $value)
  • $value
setSingleEvents (line 394)
  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Calendar_EventQuery setSingleEvents (string $value)
  • string $value: Also accepts bools. If using a string, must be either "true" or "false".
setSortOrder (line 303)
  • return: sortorder
  • access: public
string setSortOrder ( $value)
  • $value
setStartMax (line 214)
  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Calendar_EventQuery setStartMax (int $value)
  • int $value
setStartMin (line 228)
  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Calendar_EventQuery setStartMin (int $value)
  • int $value
setUser (line 148)
Zend_Gdata_Calendar_EventQuery setUser (string $value)
  • string $value
setVisibility (line 159)
Zend_Gdata_Calendar_EventQuery setVisibility (bool $value)
  • bool $value

Inherited Methods

Inherited From Zend_Gdata_Query

 Zend_Gdata_Query::__construct()
 Zend_Gdata_Query::getAlt()
 Zend_Gdata_Query::getAuthor()
 Zend_Gdata_Query::getCategory()
 Zend_Gdata_Query::getMaxResults()
 Zend_Gdata_Query::getParam()
 Zend_Gdata_Query::getPublishedMax()
 Zend_Gdata_Query::getPublishedMin()
 Zend_Gdata_Query::getQuery()
 Zend_Gdata_Query::getQueryString()
 Zend_Gdata_Query::getQueryUrl()
 Zend_Gdata_Query::getStartIndex()
 Zend_Gdata_Query::getUpdatedMax()
 Zend_Gdata_Query::getUpdatedMin()
 Zend_Gdata_Query::resetParameters()
 Zend_Gdata_Query::setAlt()
 Zend_Gdata_Query::setAuthor()
 Zend_Gdata_Query::setCategory()
 Zend_Gdata_Query::setMaxResults()
 Zend_Gdata_Query::setParam()
 Zend_Gdata_Query::setPublishedMax()
 Zend_Gdata_Query::setPublishedMin()
 Zend_Gdata_Query::setQuery()
 Zend_Gdata_Query::setStartIndex()
 Zend_Gdata_Query::setUpdatedMax()
 Zend_Gdata_Query::setUpdatedMin()
 Zend_Gdata_Query::__get()
 Zend_Gdata_Query::__set()
Class Constants
CALENDAR_FEED_URI = 'http://www.google.com/calendar/feeds' (line 48)

Documentation generated on Mon, 21 Jun 2010 15:20:28 -0400 by phpDocumentor 1.4.3