maket
/
MaketRandevu
1
1
Fork 0
Code Issues 15 Pull Requests Packages Projects Releases 4 Wiki Activity

Updated the Google_sync.php library to work with the updated code.

This commit is contained in:
Alex Tselegidis 2021-10-28 14:00:10 +02:00
parent e4c01f54f8
commit f540922abc
1 changed files with 94 additions and 135 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

229
application/libraries/Google_sync.php
View File

@ -11,50 +11,42 @@
* @since v1.0.0
* ---------------------------------------------------------------------------- */
use Google\Service\Calendar\Events;
/**
* Class Google_sync
* Google sync library
*
* This class implements all the core synchronization between the Google Calendar and the Easy!Appointments system.
*
* Do not place any model handling inside this library.
* Handles Google Calendar API related functionality.
*
* @package Libraries
*/
class Google_sync {
/**
* CodeIgniter Instance
*
* @var EA_Controller
*/
protected $CI;
/**
* Google API Client
*
* @var Google_Client
*/
protected $client;
/**
* Google Calendar Service
*
* @var Google_Service_Calendar
*/
protected $service;
/**
* Class Constructor
* Google_sync constructor.
*
* This method initializes the Google client class and the Calendar service
* class so that they can be used by the other methods.
* This method initializes the Google client class and the Calendar service class so that they can be used by the
* other methods.
*/
public function __construct()
{
$this->CI =& get_instance();
// Initialize google client and calendar service.
$this->client = new Google_Client();
$this->client->setApplicationName(config('google_application_name'));
$this->client->setClientId(config('google_client_id'));
$this->client->setClientSecret(config('google_client_secret'));
@ -66,7 +58,6 @@ class Google_sync {
Google_Service_Calendar::CALENDAR,
Google_Service_Calendar::CALENDAR_READONLY
]);
$this->service = new Google_Service_Calendar($this->client);
}
@ -76,28 +67,26 @@ class Google_sync {
* This url must be used to redirect the user to the Google user consent page,
* where the user grants access to his data for the Easy!Appointments app.
*/
public function get_auth_url()
public function get_auth_url(): string
{
// "max_auth_age" is needed because the user needs to always log in
// and not use an existing session.
// The "max_auth_age" is needed because the user needs to always log in and not use an existing session.
return $this->client->createAuthUrl() . '&max_auth_age=0';
}
/**
* Authenticate the Google API usage.
*
* When the user grants consent for his data usage, google is going to redirect
* the browser back to the given redirect url. There a authentication code is
* provided. Using this code, we can authenticate the API usage and store the
* token information to the database.
* When the user grants consent for his data usage, Google is going to redirect the browser back to the given
* redirect URL. There an authentication code is provided. Using this code, we can authenticate the API usage and
* store the token information to the database.
*
* @param $code
* @param string $code
*
* @return array
*
* @throws Exception
*/
public function authenticate($code)
public function authenticate(string $code): array
{
$response = $this->client->fetchAccessTokenWithAuthCode($code);
@ -112,17 +101,14 @@ class Google_sync {
/**
* Refresh the Google Client access token.
*
* This method must be executed every time we need to make actions on a
* provider's Google Calendar account. A new token is necessary and the
* only way to get it is to use the stored refresh token that was provided
* when the provider granted consent to Easy!Appointments for use his
* Google Calendar account.
* This method must be executed every time we need to make actions on a provider's Google Calendar account. A new
* token is necessary and the only way to get it is to use the stored refresh token that was provided when the
* provider granted consent to Easy!Appointments for use his Google Calendar account.
*
* @param string $refresh_token The provider's refresh token. This value is
* stored in the database and used every time we need to make actions to his
* Google Caledar account.
* @param string $refresh_token The provider's refresh token. This value is stored in the database and used every
* time we need to make actions to his Google Calendar account.
*/
public function refresh_token($refresh_token)
public function refresh_token(string $refresh_token)
{
$this->client->refreshToken($refresh_token);
}
@ -134,31 +120,31 @@ class Google_sync {
* and the stored access token is still valid. If yes, the selected appointment record is going to be added to the
* Google Calendar account.
*
* @param array $appointment Contains the appointment record data.
* @param array $provider Contains the provider record data.
* @param array $service Contains the service record data.
* @param array $customer Contains the customer recod data.
* @param array $settings Contains some company settings that are used by this method.
* @param array $appointment Appointment data.
* @param array $provider Provider data.
* @param array $service Service data.
* @param array $customer Customer data.
* @param array $settings Required settings.
*
* @return Google_Service_Calendar_Event Returns the Google_Event class object.
*
* @throws Exception
*/
public function add_appointment($appointment, $provider, $service, $customer, $settings)
public function add_appointment(array $appointment, array $provider, array $service, array $customer, array $settings): Google_Service_Calendar_Event
{
$this->CI->load->helper('general');
$event = new Google_Service_Calendar_Event();
$event->setSummary(($service != NULL) ? $service['name'] : 'Unavailable');
$event->setSummary(! empty($service) ? $service['name'] : 'Unavailable');
$event->setDescription($appointment['notes']);
$event->setLocation(isset($appointment['location']) ? $appointment['location'] : $settings['company_name']);
$event->setLocation($appointment['location'] ?? $settings['company_name']);
$timezone = new DateTimeZone($provider['timezone']);
$start = new Google_Service_Calendar_EventDateTime();
$start->setDateTime((new DateTime($appointment['start_datetime'], $timezone))->format(DateTime::RFC3339));
$start->setDateTime((new DateTime($appointment['start_datetime'], $timezone))->format(DateTimeInterface::RFC3339));
$event->setStart($start);
$end = new Google_Service_Calendar_EventDateTime();
$end->setDateTime((new DateTime($appointment['end_datetime'], $timezone))->format(DateTime::RFC3339));
$end->setDateTime((new DateTime($appointment['end_datetime'], $timezone))->format(DateTimeInterface::RFC3339));
$event->setEnd($end);
$event->attendees = [];
@ -169,7 +155,7 @@ class Google_sync {
$event_provider->setEmail($provider['email']);
$event->attendees[] = $event_provider;
if ($customer != NULL)
if ( ! empty($customer))
{
$event_customer = new Google_Service_Calendar_EventAttendee();
$event_customer->setDisplayName($customer['first_name'] . ' ' . $customer['last_name']);
@ -177,45 +163,43 @@ class Google_sync {
$event->attendees[] = $event_customer;
}
// Add the new event to the google calendar.
$created_event = $this->service->events->insert($provider['settings']['google_calendar'], $event);
return $created_event;
// Add the new event to the Google Calendar.
return $this->service->events->insert($provider['settings']['google_calendar'], $event);
}
/**
* Update an existing appointment that is already synced with Google Calendar.
*
* This method updates the google calendar event item that is connected with the
* provided appointment record of Easy!Appointments.
* This method updates the Google Calendar event item that is connected with the provided appointment record of
* Easy!Appointments.
*
* @param array $appointment Contains the appointment record data.
* @param array $provider Contains the provider record data.
* @param array $service Contains the service record data.
* @param array $customer Contains the customer recod data.
* @parma array $settings Contains some company settings that are used by this method.
* @param array $appointment Appointment data.
* @param array $provider Provider data.
* @param array $service Service data.
* @param array $customer Customer data.
* @parma array $settings Required settings.
*
* @return Google_Service_Calendar_Event Returns the Google_Service_Calendar_Event class object.
*
* @throws Exception
*/
public function update_appointment($appointment, $provider, $service, $customer, $settings)
public function update_appointment(array $appointment, array $provider, array $service, array $customer, array $settings): Google_Service_Calendar_Event
{
$this->CI->load->helper('general');
$event = $this->service->events->get($provider['settings']['google_calendar'],
$appointment['id_google_calendar']);
$event->setSummary($service['name']);
$event->setDescription($appointment['notes']);
$event->setLocation(isset($appointment['location']) ? $appointment['location'] : $settings['company_name']);
$event->setLocation($appointment['location'] ?? $settings['company_name']);
$timezone = new DateTimeZone($provider['timezone']);
$start = new Google_Service_Calendar_EventDateTime();
$start->setDateTime((new DateTime($appointment['start_datetime'], $timezone))->format(DateTime::RFC3339));
$start->setDateTime((new DateTime($appointment['start_datetime'], $timezone))->format(DateTimeInterface::RFC3339));
$event->setStart($start);
$end = new Google_Service_Calendar_EventDateTime();
$end->setDateTime((new DateTime($appointment['end_datetime'], $timezone))->format(DateTime::RFC3339));
$end->setDateTime((new DateTime($appointment['end_datetime'], $timezone))->format(DateTimeInterface::RFC3339));
$event->setEnd($end);
$event->attendees = [];
@ -225,7 +209,7 @@ class Google_sync {
$event_provider->setEmail($provider['email']);
$event->attendees[] = $event_provider;
if ($customer != NULL)
if ( ! empty($customer))
{
$event_customer = new Google_Service_Calendar_EventAttendee();
$event_customer->setDisplayName($customer['first_name'] . ' '
@ -234,43 +218,32 @@ class Google_sync {
$event->attendees[] = $event_customer;
}
$updated_event = $this->service->events->update($provider['settings']['google_calendar'],
$event->getId(), $event);
return $updated_event;
return $this->service->events->update($provider['settings']['google_calendar'], $event->getId(), $event);
}
/**
* Delete an existing appointment from Google Calendar.
*
* @param array $provider Contains the provider record data.
* @param string $google_event_id The Google Calendar event id to
* be deleted.
* @param array $provider Provider data.
* @param string $google_event_id The Google Calendar event ID to be removed.
*/
public function delete_appointment($provider, $google_event_id)
public function delete_appointment(array $provider, string $google_event_id)
{
try
{
$this->service->events->delete($provider['settings']['google_calendar'], $google_event_id);
}
catch (Exception $ex)
{
// Event was not found on Google Calendar.
}
$this->service->events->delete($provider['settings']['google_calendar'], $google_event_id);
}
/**
* Add unavailable period event to Google Calendar.
*
* @param array $provider Contains the provider record data.
* @param array $unavailable Contains unavailable period's data.
* @param array $provider Provider data.
* @param array $unavailable Unavailable data.
*
* @return Google_Service_Calendar_Event Returns the google event's object.
* @return Google_Service_Calendar_Event Returns the Google event.
*
* @throws Exception
*/
public function add_unavailable($provider, $unavailable)
public function add_unavailable(array $provider, array $unavailable): Google_Service_Calendar_Event
{
$this->CI->load->helper('general');
$event = new Google_Service_Calendar_Event();
$event->setSummary('Unavailable');
$event->setDescription($unavailable['notes']);
@ -278,79 +251,67 @@ class Google_sync {
$timezone = new DateTimeZone($provider['timezone']);
$start = new Google_Service_Calendar_EventDateTime();
$start->setDateTime((new DateTime($unavailable['start_datetime'], $timezone))->format(DateTime::RFC3339));
$start->setDateTime((new DateTime($unavailable['start_datetime'], $timezone))->format(DateTimeInterface::RFC3339));
$event->setStart($start);
$end = new Google_Service_Calendar_EventDateTime();
$end->setDateTime((new DateTime($unavailable['end_datetime'], $timezone))->format(DateTime::RFC3339));
$end->setDateTime((new DateTime($unavailable['end_datetime'], $timezone))->format(DateTimeInterface::RFC3339));
$event->setEnd($end);
// Add the new event to the google calendar.
$created_event = $this->service->events->insert($provider['settings']['google_calendar'], $event);
return $created_event;
// Add the new event to the Google Calendar.
return $this->service->events->insert($provider['settings']['google_calendar'], $event);
}
/**
* Update Google Calendar unavailable period event.
*
* @param array $provider Contains the provider record data.
* @param array $unavailable Contains the unavailable period data.
* @param array $provider Provider data.
* @param array $unavailable Unavailable data.
*
* @return Google_Service_Calendar_Event Returns the Google_Service_Calendar_Event object.
*
* @throws Exception
*/
public function update_unavailable($provider, $unavailable)
public function update_unavailable(array $provider, array $unavailable): Google_Service_Calendar_Event
{
$this->CI->load->helper('general');
$event = $this->service->events->get($provider['settings']['google_calendar'], $unavailable['id_google_calendar']);
$event = $this->service->events->get($provider['settings']['google_calendar'],
$unavailable['id_google_calendar']);
$event->setDescription($unavailable['notes']);
$timezone = new DateTimeZone($provider['timezone']);
$start = new Google_Service_Calendar_EventDateTime();
$start->setDateTime((new DateTime($unavailable['start_datetime'], $timezone))->format(DateTime::RFC3339));
$start->setDateTime((new DateTime($unavailable['start_datetime'], $timezone))->format(DateTimeInterface::RFC3339));
$event->setStart($start);
$end = new Google_Service_Calendar_EventDateTime();
$end->setDateTime((new DateTime($unavailable['end_datetime'], $timezone))->format(DateTime::RFC3339));
$end->setDateTime((new DateTime($unavailable['end_datetime'], $timezone))->format(DateTimeInterface::RFC3339));
$event->setEnd($end);
$updated_event = $this->service->events->update($provider['settings']['google_calendar'],
$event->getId(), $event);
return $updated_event;
return $this->service->events->update($provider['settings']['google_calendar'], $event->getId(), $event);
}
/**
* Delete unavailable period event from Google Calendar.
*
* @param array $provider Contains the provider record data.
* @param string $google_event_id Google Calendar event id to be deleted.
* @param array $provider Provider data.
* @param string $google_event_id Google Calendar event ID to be removed.
*/
public function delete_unavailable($provider, $google_event_id)
public function delete_unavailable(array $provider, string $google_event_id)
{
try
{
$this->service->events->delete($provider['settings']['google_calendar'], $google_event_id);
}
catch (Exception $ex)
{
// Event was not found on Google Calendar.
}
$this->service->events->delete($provider['settings']['google_calendar'], $google_event_id);
}
/**
* Get an event object from gcal
* Get a Google Calendar event.
*
* @param array $provider Contains the provider record data.
* @param string $google_event_id Id of the google calendar event.
* @param array $provider Provider data.
* @param string $google_event_id Google Calendar event ID.
*
* @return Google_Service_Calendar_Event Returns the google event object.
* @return Google_Service_Calendar_Event Returns the Google Calendar event.
*/
public function get_event($provider, $google_event_id)
public function get_event(array $provider, string $google_event_id): Google_Service_Calendar_Event
{
return $this->service->events->get($provider['settings']['google_calendar'], $google_event_id);
}
@ -358,20 +319,17 @@ class Google_sync {
/**
* Get all the events between the sync period.
*
* @param string $google_calendar The name of the google calendar to be used.
* @param string $google_calendar The name of the Google Calendar to be used.
* @param string $start The start date of sync period.
* @param string $end The end date of sync period.
*
* @return object Returns an array with Google_Service_Calendar_Event objects that belong on the given
* sync period (start, end).
* @return Events Returns a collection of events.
*/
public function get_sync_events($google_calendar, $start, $end)
public function get_sync_events(string $google_calendar, string $start, string $end): Events
{
$this->CI->load->helper('general');
$params = [
'timeMin' => date(DateTime::RFC3339, $start),
'timeMax' => date(DateTime::RFC3339, $end),
'timeMin' => date(DateTimeInterface::RFC3339, $start),
'timeMax' => date(DateTimeInterface::RFC3339, $end),
'singleEvents' => TRUE,
];
@ -379,20 +337,20 @@ class Google_sync {
}
/**
* Return available google calendars for specific user.
* Return available Google Calendars for specific user.
*
* The given user's token must already exist in db in order to get access to his
* Google Calendar account.
*
* @param string $google_token The user's token will be used to grant access to google calendar.
*
* @return array Returns an array with the available calendars.
*/
public function get_google_calendars()
public function get_google_calendars(): array
{
$calendarList = $this->service->calendarList->listCalendarList();
$calendar_list = $this->service->calendarList->listCalendarList();
$calendars = [];
foreach ($calendarList->items as $google_calendar)
foreach ($calendar_list->items as $google_calendar)
{
if ($google_calendar->getAccessRole() === 'reader')
{
@ -404,6 +362,7 @@ class Google_sync {
'summary' => $google_calendar->summary
];
}
return $calendars;
}
}