Zend/Gdata/Calendar/EventQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Calendar_EventQuery

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 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_Calendar_EventQuery
jump to top

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

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

Properties


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


                 $_defaultFeedUri= 'self::CALENDAR_FEED_URI'

The default URI used for feeds.

Default valueself::CALENDAR_FEED_URIDetails

Type


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


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


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


                 $_visibility= ''public''

Default value'public'Details

Type

Methods

__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

getComments(
          
          )
        
        :
          string

Returns

Type	Description
string	comments

Details

See: \$_comments;

getEvent(
          
          )
        
        :
          string

Returns

Type	Description
string	event

Details

See: \$_event;

getFutureEvents(
          
          )
        
        :
          string

Returns

Type	Description
string	futureevents

getOrderBy(
          
          )
        
        :
          string

Returns

Type	Description
string	orderby

getProjection(
          
          )
        
        :
          string

Returns

Type	Description
string	projection

Details

See: \$_projection

getQueryUrl(
          
          )
        
        :
          string

Returns

Type	Description
string	url

getRecurrenceExpansionEnd(
          
          )
        
        :
          string

Returns

Type	Description
string	recurrence-expansion-end

getRecurrenceExpansionStart(
          
          )
        
        :
          string

Returns

Type	Description
string	recurrence-expansion-start

getSingleEvents(
          
          )
        
        :
          \Zend_Gdata_Calendar_EventQuery

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

getSortOrder(
          
          )
        
        :
          string

Returns

Type	Description
string	sortorder

getStartMax(
          
          )
        
        :
          int

Returns

Type	Description
int	start-max

getStartMin(
          
          )
        
        :
          int

Returns

Type	Description
int	start-min

getUser(
          
          )
        
        :
          string

Returns

Type	Description
string	user

Details

See: \$_user

getVisibility(
          
          )
        
        :
          string

Returns

Type	Description
string	visibility

Details

See: \$_visibility

setComments(
          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

setEvent(
          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

setFutureEvents(
          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

setOrderBy(
          string $value
          )
        
        :
          \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

setProjection(
          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

setRecurrenceExpansionEnd(
           $value
          )
        
        :
          string

Parameters

Name	Type	Description
$value

Returns

Type	Description
string	recurrence-expansion-end

setRecurrenceExpansionStart(
           $value
          )
        
        :
          string

Parameters

Name	Type	Description
$value

Returns

Type	Description
string	recurrence-expansion-start

setSingleEvents(
          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

setSortOrder(
           $value
          )
        
        :
          string

Parameters

Name	Type	Description
$value

Returns

Type	Description
string	sortorder

setStartMax(
          int $value
          )
        
        :
          \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

setStartMin(
          int $value
          )
        
        :
          \Zend_Gdata_Calendar_EventQuery

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Calendar_EventQuery	Provides a fluent interface

setUser(
          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

setVisibility(
          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

API Documentation

Zend/Gdata/Calendar/EventQuery.php

\Zend_Gdata_Calendar_EventQueryjump to top

Constants

Properties

Methods

\Zend_Gdata_Calendar_EventQuery
jump to top