Gdata/Calendar/EventQuery.php

category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Calendar
version: $Id: EventQuery.php 23805 2011-03-16 00:55:40Z tjohns $
Classes: Zend_Gdata_Calendar_EventQuery

Description

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.

Zend_Gdata_Calendar_EventQuery
jump to top

Extends from: Zend_Gdata_Query
category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://code.google.com/apis/gdata/calendar/
package: Zend_Gdata
subpackage: Calendar
Constants: CALENDAR_FEED_URI
Properties: $_defaultFeedUri; $_comments; $_user; $_visibility; $_projection; $_event
Methods: __construct; setComments; setEvent; setProjection; setUser; setVisibility; getComments; getEvent; getProjection; getUser; getVisibility; setStartMax; setStartMin; setOrderBy; getStartMax; getStartMin; getOrderBy; getSortOrder; setSortOrder; getRecurrenceExpansionStart; setRecurrenceExpansionStart; getRecurrenceExpansionEnd; setRecurrenceExpansionEnd; getSingleEvents; setSingleEvents; getFutureEvents; setFutureEvents; getQueryUrl

Description

Assists in constructing queries for Google Calendar events

Constants

CALENDAR_FEED_URI
jump to class

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

Details

value: https://www.google.com/calendar/feeds

Properties

$_comments
jump to class

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

Details

visibility: protected
default: null
final: false
static: false

$_defaultFeedUri
jump to class

$_defaultFeedUri = 'self'

The default URI used for feeds.

Details

visibility: protected
default: self
final: false
static: false

$_event
jump to class

$_event = 'null'

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

Details

visibility: protected
default: null
final: false
static: false

$_projection
jump to class

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

Details

visibility: protected
default: full
final: false
static: false

$_user
jump to class

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

Details

visibility: protected
default: default
final: false
static: false

$_visibility
jump to class

$_visibility = 'public'

Details

visibility: protected
default: public
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $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.

Arguments

$url: string
The URL to use as the base path for requests

Details

visibility: public
final: false
static: false

getComments
jump to class

getComments(
          
          )
        
        :
        string

Output

string: comments

Details

visibility: public
final: false
static: false
see: $_comments;

getEvent
jump to class

getEvent(
          
          )
        
        :
        string

Output

string: event

Details

visibility: public
final: false
static: false
see: $_event;

getFutureEvents
jump to class

getFutureEvents(
          
          )
        
        :
        string

Output

string: futureevents

Details

visibility: public
final: false
static: false

getOrderBy
jump to class

getOrderBy(
          
          )
        
        :
        string

Output

string: orderby

Details

visibility: public
final: false
static: false

getProjection
jump to class

getProjection(
          
          )
        
        :
        string

Output

string: projection

Details

visibility: public
final: false
static: false
see: $_projection

getQueryUrl
jump to class

getQueryUrl(
          
          )
        
        :
        string

Output

string: url

Details

visibility: public
final: false
static: false

getRecurrenceExpansionEnd
jump to class

getRecurrenceExpansionEnd(
          
          )
        
        :
        string

Output

string: recurrence-expansion-end

Details

visibility: public
final: false
static: false

getRecurrenceExpansionStart
jump to class

getRecurrenceExpansionStart(
          
          )
        
        :
        string

Output

string: recurrence-expansion-start

Details

visibility: public
final: false
static: false

getSingleEvents
jump to class

getSingleEvents(
          
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

getSortOrder
jump to class

getSortOrder(
          
          )
        
        :
        string

Output

string: sortorder

Details

visibility: public
final: false
static: false

getStartMax
jump to class

getStartMax(
          
          )
        
        :
        int

Output

int: start-max

Details

visibility: public
final: false
static: false

getStartMin
jump to class

getStartMin(
          
          )
        
        :
        int

Output

int: start-min

Details

visibility: public
final: false
static: false

getUser
jump to class

getUser(
          
          )
        
        :
        string

Output

string: user

Details

visibility: public
final: false
static: false
see: $_user

getVisibility
jump to class

getVisibility(
          
          )
        
        :
        string

Output

string: visibility

Details

visibility: public
final: false
static: false
see: $_visibility

setComments
jump to class

setComments(
          string $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: string

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
see: $_comments

setEvent
jump to class

setEvent(
          string $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: string

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
see: $_event

setFutureEvents
jump to class

setFutureEvents(
          string $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: string
Also accepts bools. If using a string, must be either "true" or "false" or an exception will be thrown on retrieval.

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setOrderBy
jump to class

setOrderBy(
          string $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: string

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setProjection
jump to class

setProjection(
          string $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: string

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
see: $_projection

setRecurrenceExpansionEnd
jump to class

setRecurrenceExpansionEnd(
           $value
          )
        
        :
        string

Arguments

$value

Output

string: recurrence-expansion-end

Details

visibility: public
final: false
static: false

setRecurrenceExpansionStart
jump to class

setRecurrenceExpansionStart(
           $value
          )
        
        :
        string

Arguments

$value

Output

string: recurrence-expansion-start

Details

visibility: public
final: false
static: false

setSingleEvents
jump to class

setSingleEvents(
          string $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: string
Also accepts bools. If using a string, must be either "true" or "false".

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setSortOrder
jump to class

setSortOrder(
           $value
          )
        
        :
        string

Arguments

$value

Output

string: sortorder

Details

visibility: public
final: false
static: false

setStartMax
jump to class

setStartMax(
          int $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: int

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setStartMin
jump to class

setStartMin(
          int $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: int

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setUser
jump to class

setUser(
          string $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: string

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
see: $_user

setVisibility
jump to class

setVisibility(
          bool $value
          )
        
        :
        Zend_Gdata_Calendar_EventQuery

Arguments

$value: bool

Output

Zend_Gdata_Calendar_EventQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
see: $_visibility

API Documentation

Gdata/Calendar/EventQuery.php

Description

Zend_Gdata_Calendar_EventQueryjump to top

Description

Constants

CALENDAR_FEED_URIjump to class

Details

Properties

$_commentsjump to class

Details

$_defaultFeedUrijump to class

Details

$_eventjump to class

Details

$_projectionjump to class

Details

$_userjump to class

Details

$_visibilityjump to class

Details

Methods

__constructjump to class

Arguments

Details

getCommentsjump to class

Output

Details

getEventjump to class

Output

Details

getFutureEventsjump to class

Output

Details

getOrderByjump to class

Output

Details

getProjectionjump to class

Output

Details

getQueryUrljump to class

Output

Details

getRecurrenceExpansionEndjump to class

Output

Details

getRecurrenceExpansionStartjump to class

Output

Details

getSingleEventsjump to class

Output

Details

getSortOrderjump to class

Output

Details

getStartMaxjump to class

Output

Details

getStartMinjump to class

Output

Details

getUserjump to class

Output

Details

getVisibilityjump to class

Output

Details

setCommentsjump to class

Arguments

Output

Details

setEventjump to class

Arguments

Output

Details

setFutureEventsjump to class

Arguments

Output

Details

setOrderByjump to class

Zend_Gdata_Calendar_EventQuery
jump to top

CALENDAR_FEED_URI
jump to class

$_comments
jump to class

$_defaultFeedUri
jump to class

$_event
jump to class

$_projection
jump to class

$_user
jump to class

$_visibility
jump to class

__construct
jump to class

getComments
jump to class

getEvent
jump to class

getFutureEvents
jump to class

getOrderBy
jump to class

getProjection
jump to class

getQueryUrl
jump to class

getRecurrenceExpansionEnd
jump to class

getRecurrenceExpansionStart
jump to class

getSingleEvents
jump to class

getSortOrder
jump to class

getStartMax
jump to class

getStartMin
jump to class

getUser
jump to class

getVisibility
jump to class

setComments
jump to class

setEvent
jump to class

setFutureEvents
jump to class

setOrderBy
jump to class

setProjection
jump to class

setRecurrenceExpansionEnd
jump to class

setRecurrenceExpansionStart
jump to class

setSingleEvents
jump to class

setSortOrder
jump to class

setStartMax
jump to class

setStartMin
jump to class

setUser
jump to class

setVisibility
jump to class