Joomla! API

Download
Launch

JGoogleDataCalendar

Extends \JGoogleData

Google Calendar data class for the Joomla Platform.

deprecated
since

3.1.4
deprecated

4.0 Use the joomla/google package via Composer instead
package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JGoogleAuth $auth = null)
inherited
since

3.1.4

Arguments

$options

\Joomla\Registry\RegistryGoogle options object.

$auth

\JGoogleAuthGoogle data http client object.

addCalendar

Method to add a calendar to a user's Google Calendar list

addCalendar(string $calendarID, array $options = array()) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringNew calendar ID

$options

arrayNew calendar settings

Response

mixedData from Google

authenticate

Method to authenticate to Google

authenticate() : boolean
inherited
since

3.1.4

Response

booleanTrue on success.

clearCalendar

Method to clear a Google Calendar

clearCalendar(string $calendarID) : boolean
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringID of calendar to clear

Response

booleanSuccess or failure

createCalendar

Method to create a Google Calendar

createCalendar(string $title, array $options = array()) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$title

stringNew calendar title

$options

arrayNew calendar settings

Response

mixedData from Google.

createEvent

Method to create a Google Calendar event

createEvent(string $calendarID, mixed $start, mixed $end = false, array $options = array(), mixed $timezone = false, boolean $allday = false, boolean $notify = false) : mixed
since

3.1.4
throws

\InvalidArgumentException

\UnexpectedValueException

Arguments

$calendarID

stringID of calendar

$start

mixedEvent start time

$end

mixedEvent end time

$options

arrayNew event settings

$timezone

mixedTimezone for event

$allday

booleanTreat event as an all-day event

$notify

booleanNotify participants

Response

mixedData from Google.

deleteCalendar

Method to delete a calendar from Google

deleteCalendar(string $calendarID) : boolean
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringID of calendar to delete.

Response

booleanSuccess or failure

deleteEvent

Method to delete an event from a Google Calendar

deleteEvent(string $calendarID, string $eventID) : boolean
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringID of calendar to delete from

$eventID

stringID of event to delete.

Response

booleanSuccess or failure.

editCalendar

Method to edit a Google Calendar

editCalendar(string $calendarID, array $options) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringCalendar ID.

$options

arrayCalendar settings.

Response

mixedData from Google.

editCalendarSettings

Method to edit a Google Calendar's settings

editCalendarSettings(string $calendarID, array $options) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringCalendar ID

$options

arrayCalendar settings

Response

mixedData from Google

editEvent

Method to edit a Google Calendar event

editEvent(string $calendarID, string $eventID, array $options, boolean $notify = false) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringCalendar ID

$eventID

stringID of the event to change

$options

arrayEvent settings

$notify

booleanNotify participants of changes

Response

mixedData from Google.

getCalendar

Method to get a calendar's settings from Google

getCalendar(string $calendarID) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringID of calendar to get.

Response

mixedData from Google

getEvent

Method to get an event from a Google Calendar

getEvent(string $calendarID, string $eventID, array $options = array()) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringID of calendar

$eventID

stringID of event to get

$options

arrayOptions to send to Google

Response

mixedData from Google.

getOption

Get an option from the JGoogleData instance.

getOption(string $key) : mixed
inherited
since

3.1.4

Arguments

$key

stringThe name of the option to get.

Response

mixedThe option value.

isAuthenticated

Check authentication

isAuthenticated() : boolean
inherited
since

3.1.4

Response

booleanTrue if authenticated.

listCalendars

Method to retrieve calendar list from Google

listCalendars(array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$options

arraySearch settings

$maxpages

integerMaximum number of pages of calendars to return

Response

mixedData from Google

listEvents

Method to retrieve a list of events on a Google calendar

listEvents(string $calendarID, array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringCalendar ID

$options

arrayCalendar settings

$maxpages

integerCycle through pages of data to generate a complete list

Response

mixedData from Google.

listGetData

Method to retrieve a list of data

listGetData(array $url, integer $maxpages = 1, string $token = null) : mixed
inherited
since

3.1.4
throws

\UnexpectedValueException

Arguments

$url

arrayURL to GET

$maxpages

integerMaximum number of pages to return

$token

stringNext page token

Response

mixedData from Google

listRecurrences

Method to retrieve a list of events on a Google calendar

listRecurrences(string $calendarID, string $eventID, array $options = array(), integer $maxpages = 1) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringCalendar ID

$eventID

stringID of the event to change

$options

arraySearch settings

$maxpages

integerMinimum number of events to retrieve (more may be retrieved depending on page size)

Response

mixedData from Google.

moveEvent

Method to move an event from one calendar to another

moveEvent(string $calendarID, string $eventID, string $destID, boolean $notify = false) : mixed
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringCalendar ID

$eventID

stringID of the event to change

$destID

stringCalendar ID

$notify

booleanNotify participants of changes

Response

mixedData from Google.

query

Method to retrieve data from Google

query(string $url, mixed $data = null, array $headers = null, string $method = 'get') : mixed
inherited
since

3.1.4

Arguments

$url

stringThe URL for the request.

$data

mixedThe data to include in the request.

$headers

arrayThe headers to send with the request.

$method

stringThe type of http request to send.

Response

mixedData from Google.

removeCalendar

Method to remove a calendar from a user's calendar list

removeCalendar(string $calendarID) : boolean
since

3.1.4
throws

\UnexpectedValueException

Arguments

$calendarID

stringID of calendar to delete

Response

booleanSuccess or failure

safeXml

Method to validate XML

safeXml(string $data) : \SimpleXMLElement
inherited static
since

3.1.4
throws

\UnexpectedValueException

Arguments

$data

stringXML data to be parsed

Response

\SimpleXMLElementXMLElement of parsed data

setOption

Set an option for the JGoogleData instance.

setOption(string $key, mixed $value) : \JGoogleData
inherited
since

3.1.4

Arguments

$key

stringThe name of the option to set.

$value

mixedThe option value to set.

Response

\JGoogleDataThis object for method chaining.

Properties

options

Options for the Google data object.

inherited
since

3.1.4

Type(s)

\Joomla\Registry\Registry

auth

Authentication client for the Google data object.

inherited
since

3.1.4

Type(s)

\JGoogleAuth
  • \ \
  • \ JGoogleDataCalendar