(PHP Extension) Google Calendar Search Events (List Events with Optional Query Parameters)

See more Google Calendar Examples

Demonstrates how to specify optional query parameters for listing events. This example uses the "q" parameter to free-text search for events, and uses the "timeMin" parameter to specify a lower bound for an event's end time.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// This example uses a previously obtained access token having permission for the 
// Google Calendar scope.

// In this example, Get Google Calendar OAuth2 Access Token, the access
// token was saved to a JSON file.  This example fetches the access token from the file..
$jsonToken = new CkJsonObject();
$success = $jsonToken->LoadFile('qa_data/tokens/googleCalendar.json');
if ($jsonToken->HasMember('access_token') == false) {
    print 'No access token found.' . "\n";
    exit;
}

$http = new CkHttp();
$http->put_AuthToken($jsonToken->stringOf('access_token'));

// We'll want to build a URL with the query params..
$sbUrl = new CkStringBuilder();
$sbUrl->Append('https://www.googleapis.com/calendar/v3/calendars/{$calendarId}/events?');

// Use the HTTP request object as a helper for creating the URL encoded query param list..
$req = new CkHttpRequest();

// Find events with the word "pizza".
$req->AddParam('q','pizza');

// Get events for the current date/time or later.
$dt = new CkDateTime();
$dt->SetFromCurrentSystemTime();
$req->AddParam('timeMin',$dt->getAsTimestamp(false));

// Add these query params to the URL:
$sbUrl->Append($req->getUrlEncodedParams());

// Examine the URL..
print 'URL: ' . $sbUrl->getAsString() . "\n";

// The URL looks like this:
// https://www.googleapis.com/calendar/v3/calendars/{$calendarId}/events?q=pizza&timeMin=2017-08-11T13%3A35%3A28Z

// Let's get events in the primary calendar.  A calendar ID could have be used instead of "primary".
$http->SetUrlVar('calendarId','primary');
$sbResponse = new CkStringBuilder();
$success = $http->QuickGetSb($sbUrl->getAsString(),$sbResponse);
if ($success != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

if ($http->get_LastStatus() != 200) {
    // Note: If a 401 unauthorized response is received, it likely means that the OAuth2 access token needs
    // to be refreshed or re-fetched.
    print 'Error response status: ' . $http->get_LastStatus() . "\n";
    print $sbResponse->getAsString() . "\n";
    exit;
}

print $sbResponse->getAsString() . "\n";

// A sample JSON response:
// (Code for parsing the Google Calendar events is shown below.)

// {
//  "kind": "calendar#events",
//  "etag": "\"p32cafkumkb7ta0g\"",
//  "summary": "support@chilkatcloud.com",
//  "updated": "2017-08-11T13:19:48.143Z",
//  "timeZone": "America/Chicago",
//  "accessRole": "owner",
//  "defaultReminders": [
//   {
//    "method": "popup",
//    "minutes": 10
//   }
//  ],
//  "nextSyncToken": "CJin09aiz9UCEJin09aiz9UCGAU=",
//  "items": [
//   {
//    "kind": "calendar#event",
//    "etag": "\"3004915160212000\"",
//    "id": "02pv1cpdp7vm11htnfi3ii7iie",
//    "status": "confirmed",
//    "htmlLink": "https://www.google.com/calendar/event?eid=MDJwdjFjcGRwN3ZtMTFodG5maTNpaTdpaWUgc3VwcG9ydEBjaGlsa2F0Y2xvdWQuY29t",
//    "created": "2017-08-11T13:19:40.000Z",
//    "updated": "2017-08-11T13:19:40.106Z",
//    "summary": "Eat Lou Malnati's Pizza",
//    "creator": {
//     "email": "support@chilkatcloud.com",
//     "self": true
//    },
//    "organizer": {
//     "email": "support@chilkatcloud.com",
//     "self": true
//    },
//    "start": {
//     "dateTime": "2017-08-12T12:00:00-05:00"
//    },
//    "end": {
//     "dateTime": "2017-08-12T13:00:00-05:00"
//    },
//    "iCalUID": "02pv1cpdp7vm11htnfi3ii7iie@google.com",
//    "sequence": 0,
//    "hangoutLink": "https://plus.google.com/hangouts/_/chilkatcloud.com/support?hceid=c3VwcG9ydEBjaGlsa2F0Y2xvdWQuY29t.02pv1cpdp7vm11htnfi3ii7iie",
//    "reminders": {
//     "useDefault": true
//    }
//   }
//  ]
// }
// 
// 

$json = new CkJsonObject();
$json->LoadSb($sbResponse);

$numEvents = $json->SizeOfArray('items');
$i = 0;
while ($i < $numEvents) {
    $json->put_I($i);
    print $json->stringOf('items[i].summary') . "\n";
    print $json->stringOf('items[i].start.dateTime') . "\n";
    print $json->stringOf('items[i].end.dateTime') . "\n";
    print '--' . "\n";
    $i = $i + 1;
}

// Sample output:

// Eat Lou Malnati's Pizza
// 2017-08-12T12:00:00-05:00
// 2017-08-12T13:00:00-05:00
// --

?>