rob-lester-jr04 / laravel-google-calendar
Manage events on a Google Calendar
Requires
- php: ^7.0
- google/apiclient: ^2.2
- illuminate/support: ^5.4.0
- nesbot/carbon: ^1.21 || ^2.0
Requires (Dev)
- mockery/mockery: ^1.0
- orchestra/testbench: ~3.4.6
- phpunit/phpunit: ^6.2
README
This package makes working with a Google Calendar a breeze. Once it has been set up you can do these things:
use Lester\GoogleCalendar\Event; //create a new event $event = new Event; $event->name = 'A new event'; $event->startDateTime = Carbon\Carbon::now(); $event->endDateTime = Carbon\Carbon::now()->addHour(); $event->addAttendee(['email' => 'youremail@gmail.com']); $event->addAttendee(['email' => 'anotherEmail@gmail.com']); $event->save(); // get all future events on a calendar $events = Event::get(); // update existing event $firstEvent = $events->first(); $firstEvent->name = 'updated name'; $firstEvent->save(); $firstEvent->update(['name' => 'updated again']); // create a new event Event::create([ 'name' => 'A new event', 'startDateTime' => Carbon\Carbon::now(), 'endDateTime' => Carbon\Carbon::now()->addHour(), ]); // delete an event $event->delete();
Installation
You can install the package via composer:
composer require rob-lester-jr04/laravel-google-calendar
Next up the service provider must be registered:
'providers' => [ ... Lester\GoogleCalendar\GoogleCalendarServiceProvider::class, ];
Optionally the Lester\GoogleCalendar\GoogleCalendarFacade
must be registered:
'aliases' => [ ... 'GoogleCalendar' => Lester\GoogleCalendar\GoogleCalendarFacade::class, ... ]
You must publish the configuration with this command:
php artisan vendor:publish --provider="Lester\GoogleCalendar\GoogleCalendarServiceProvider"
This will publish file called google-calendar.php
in your config-directory with this contents:
return [
/*
* Path to the json file containing the credentials.
*/
'service_account_credentials_json' => storage_path('app/google-calendar/service-account-credentials.json'),
/*
* The id of the Google Calendar that will be used by default.
*/
'calendar_id' => env('GOOGLE_CALENDAR_ID'),
];
How to obtain the credentials to communicate with Google Calendar
The first thing you’ll need to do is to get some credentials to use Google API’s. I’m assuming that you’ve already created a Google account and are signed in. Head over to Google API console and click "Select a project" in the header.
Next up we must specify which API's the project may consume. In the list of available API's click "Google Calendar API". On the next screen click "Enable".
Now that you've created a project that has access to the Calendar API it's time to download a file with these credentials. Click "Credentials" in the sidebar. You'll want to create a "Service account key".
On the next screen you can give the service account a name. You can name it anything you’d like. In the service account id you’ll see an email address. We’ll use this email address later on in this guide. Select "JSON" as the key type and click "Create" to download the JSON file.
Save the json inside your Laravel project at the location specified in the service_account_credentials_json
key of the config file of this package. Because the json file contains potentially sensitive information I don't recommend committing it to your git repository.
Now that everything is set up on the API site, we’ll need to configure some things on the Google Calendar site. Head over Google Calendar and view the settings of the calendar you want to work with via PHP. On the “Share this Calendar” tab add the service account id that was displayed when creating credentials on the API site.
Open up the “Calendar Details” tab to see the id of the calendar. You need to specify that id in the config file.
Usage
Getting events
You can fetch all events by simply calling Event::get();
this will return all events of the coming year. An event comes in the form of a Lester\GoogleCalendar\Event
object.
The full signature of the function is:
public static function get(Carbon $startDateTime = null, Carbon $endDateTime = null, array $queryParameters = [], string $calendarId = null): Collection
The parameters you can pass in $queryParameters
are listed on the documentation on list
at the Google Calendar API docs.
Accessing start and end dates of an event
You can use these getters to retrieve start and end date as Carbon instances:
$events = Event::get(); $events[0]->startDate; $events[0]->startDateTime; $events[0]->endDate; $events[0]->endDateTime;
Creating an event
You can just new up a Lester\GoogleCalendar\Event
-object
$event = new Event; $event->name = 'A new event'; $event->startDateTime = Carbon\Carbon::now(); $event->endDateTime = Carbon\Carbon::now()->addHour(); $event->save();
You can also call create
statically:
Event::create([ 'name' => 'A new event', 'startDateTime' => Carbon\Carbon::now(), 'endDateTime' => Carbon\Carbon::now()->addHour(), ]);
This will create an event with a specific start and end time. If you want to create a full day event you must use startDate
and endDate
instead of startDateTime
and endDateTime
.
$event = new Event; $event->name = 'A new full day event'; $event->startDate = Carbon\Carbon::now(); $event->endDate = Carbon\Carbon::now()->addDay(); $event->save();
Getting a single event
Google assigns a unique id to every single event. You can get this id by getting events using the get
method and getting the id
property on a Lester\GoogleCalendar\Event
-object:
// get the id of the first upcoming event in the calendar. $eventId = Event::get()->first()->id;
You can use this id to fetch a single event from Google:
Event::find($eventId);
Updating an event
Easy, just change some properties and call save()
:
$event = Event::find($eventId); $event->name = 'My updated title'; $event->save();
Alternatively you can use the update method:
$event = Event::find($eventId) $event->update(['name' => 'My updated title']);
Deleting an event
Nothing to it!
$event = Event::find($eventId); $event->delete();
Limitations
The Google Calendar API provides many options. This package doesn't support all of them. For instance recurring events cannot be managed properly with this package. If you stick to creating events with a name and a date you should be fine.
Upgrading from v1 to v2
The only major difference between v1
and v2
is that under the hood Google API v2 is used instead of v1. Here are the steps required to upgrade:
- rename the config file from
laravel-google-calendar
togoogle-calendar
- in the config file rename the
client_secret_json
key toservice_account_credentials_json
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email robertlesterjr@mac.com instead of using the issue tracker.
Credits
This is a Fork of Spatie's google calendar package
License
The MIT License (MIT). Please see License File for more information.