Details

Written by: cayenneAdmin

Category: Google Calendar

Published: 18 March 2025

Hits: 232

Google Cloud > Kaikoma > APIs & Services > Enabled APIs and Services

Create Credentials 

 

Details

Written by: cayenneAdmin

Category: Google Calendar

Published: 16 March 2025

Hits: 269

Turning the Google Calendar OAuth 2.0 PHP integration into an installable Joomla 5 component is totally doable. This is a walk-through of how to create a Joomla 5 component that integrates with Google Calendar API, based on the PHP code we discussed earlier.

✅ Joomla 5 Component Structure for Google Calendar Integration

In Joomla, components are structured extensions with MVC architecture, and the installable package includes:

1. Component folder (site/admin files)
2. manifest.xml file
3. PHP scripts (controllers, views, models)
4. Helper classes (like for Google API)
5. Templates for output

✅ Step 1: Basic Folder Structure

Here's a simplified directory structure for your Joomla 5 component:

/com_gcalendar
├── admin
│   ├── src
│   │   ├── Controller
│   │   ├── Model
│   │   ├── View
│   │   ├── Service
│   │   └── Helper
│   └── tmpl
├── site
│   ├── src
│   │   ├── Controller
│   │   ├── Model
│   │   ├── View
│   │   ├── Service
│   │   └── Helper
│   └── tmpl
├── language
│   └── en-GB
│       └── en-GB.com_gcalendar.ini
└── com_gcalendar.xml (manifest file)

➡️ The admin folder handles backend management.
➡️ The site folder is where you display calendar events or forms on the public website.

✅ Step 2: Install Google API Library in Joomla

You can:

1. Use Composer inside your component folder:

   cd com_gcalendar
   composer require google/apiclient:^2.0
   

2. Or manually include the required Google API libraries inside libraries or your Helper folder.

For Joomla best practice, it’s recommended to install the library via Composer in your Joomla project root or your component and autoload it in your component.

✅ Step 3: Create the manifest.xml

This file defines your Joomla component and the files it uses.

<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="5.0" method="upgrade">
    <name>com_gcalendar</name>
    <author>Your Name</author>
    <creationDate>2025-03-17</creationDate>
    <version>1.0.0</version>
    <description>Google Calendar Integration for Joomla 5</description>

    <files folder="site">
        <folder>src</folder>
        <folder>tmpl</folder>
    </files>

    <administration>
        <files folder="admin">
            <folder>src</folder>
            <folder>tmpl</folder>
        </files>
    </administration>
</extension>

✅ Step 4: Joomla MVC Basics (How to Handle OAuth and Events)

➤ Controller Example (site/src/Controller/CalendarController.php)

<?php

namespace Joomla\Component\Gcalendar\Site\Controller;

\defined('_JEXEC') or die;

use Joomla\CMS\MVC\Controller\BaseController;

class CalendarController extends BaseController
{
    public function authorize()
    {
        $app = \Joomla\CMS\Factory::getApplication();
        $client = $this->getGoogleClient();

        $authUrl = $client->createAuthUrl();
        $app->redirect($authUrl);
    }

    public function callback()
    {
        $app = \Joomla\CMS\Factory::getApplication();
        $input = $app->input;
        $code = $input->get('code');

        if (!$code) {
            $app->enqueueMessage('Authorization code missing', 'error');
            $this->setRedirect('index.php');
            return;
        }

        $client = $this->getGoogleClient();
        $token = $client->fetchAccessTokenWithAuthCode($code);

        if (isset($token['error'])) {
            $app->enqueueMessage('Authorization failed: ' . $token['error'], 'error');
            $this->setRedirect('index.php');
            return;
        }

        // Save tokens to Joomla user profile or your component table
        $user = \Joomla\CMS\Factory::getUser();
        $db = \Joomla\CMS\Factory::getDbo();

        // Example: Insert tokens into your custom table (or user profile)
        // Your table logic goes here...

        $this->setRedirect('index.php?option=com_gcalendar&view=calendar');
    }

    private function getGoogleClient()
    {
        require_once JPATH_COMPONENT_SITE . '/vendor/autoload.php';

        $client = new \Google_Client();
        $client->setClientId('YOUR_CLIENT_ID');
        $client->setClientSecret('YOUR_CLIENT_SECRET');
        $client->setRedirectUri(' https://www.japansailing.com/index.php?option=com_gcalendar&task=calendar.callback');
        $client->addScope(\Google_Service_Calendar::CALENDAR);
        $client->setAccessType('offline');
        $client->setPrompt('consent');

        return $client;
    }
}

✅ Step 5: Joomla View to Trigger OAuth

➤ Site View (site/src/View/Calendar/HtmlView.php)

<?php

namespace Joomla\Component\Gcalendar\Site\View\Calendar;

\defined('_JEXEC') or die;

use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;

class HtmlView extends BaseHtmlView
{
    protected $items;

    public function display($tpl = null)
    {
        $this->items = []; // You can retrieve calendar events here later

        parent::display($tpl);
    }
}

➤ Template (site/tmpl/calendar/default.php)

<?php
\defined('_JEXEC') or die;

use Joomla\CMS\Router\Route;

$authLink = Route::_('index.php?option=com_gcalendar&task=calendar.authorize');

echo "<h1>Google Calendar Integration</h1>";
echo "<a href='$authLink' class='btn btn-primary'>Connect to Google Calendar</a>";

✅ Step 6: Create Admin Interface (Optional)

• Add an admin model/view/controller structure if you want backend management.
• Example: Manage calendar ID selection, event templates, default settings.

✅ Step 7: Package Your Joomla Component

1. Zip your component folder (com_gcalendar).
2. Install in Joomla via Extensions ➜ Manage ➜ Install.

✅ Step 8: Database Table for Tokens (Optional But Recommended)

Create a table for storing:

• user_id
• access_token
• refresh_token
• expires_in

Example SQL:

CREATE TABLE `#__gcalendar_tokens` (
  `id` INT AUTO_INCREMENT PRIMARY KEY,
  `user_id` INT NOT NULL,
  `access_token` TEXT NOT NULL,
  `refresh_token` TEXT,
  `expires_at` TIMESTAMP,
  FOREIGN KEY (`user_id`) REFERENCES `#__users`(`id`)
);

✅ Step 9: Security Best Practices

• Use Joomla ACL to control who can connect to Google Calendar.
• Encrypt refresh tokens in the database.
• Validate input and output strictly.
• Use Joomla’s session system to handle logged-in users.

✅ Final Deliverable: What You’ll Have

• A Joomla 5 component (com_gcalendar) that:
  • Authenticates users via Google OAuth 2.0
  • Lets them create/edit/delete Google Calendar events from Joomla
  • Can be packaged and installed on www.japansailing.com or any subdomain like kaikoma.japansailing.com

✅ Next Steps (Optional Enhancements)

✅ Ready for Code Samples?

If you want, I can:

1. Provide a zip file structure you can start from.
2. Walk you through setting up the token database table and saving tokens properly.
3. Show you how to integrate FullCalendar.js into the Joomla 5 component.

What’s your preference?

Details

Written by: cayenneAdmin

Category: Google Calendar

Published: 16 March 2025

Hits: 182

Let's move step by step through the OAuth 2.0 flow setup and coding using PHP for your Google Calendar integration.

✅ What We’re Building

➡️ A PHP app that:

1. Lets users (like Jack) authorize your website to access their Google Calendar.
2. Retrieves an access token (and refresh token).
3. Lets them create/edit/delete events on Google Calendar directly from your website.

✅ Prerequisites

✅ Step 1: Install the Google API Client Library for PHP

➤ Install via Composer

In your project directory, run:

If you don’t have Composer:

• Download it here ➜ https://getcomposer.org/

✅ Step 2: Create a Google Cloud Project & OAuth Credentials

➤ Recap of Setup:

1. Go to Google Cloud Console.
2. Create a new project or use an existing one.
3. Go to APIs & Services ➜ Library ➜ Enable Google Calendar API.
4. Go to Credentials ➜ Create Credentials ➜ OAuth client ID.
5. Set redirect URIs (e.g., https://www.japansailing.com/oauth2callback.php).

➡️ Save your Client ID and Client Secret.

✅ Step 3: Create Files for OAuth 2.0 Flow

We’ll need:

1. index.php ➜ The landing page with the Connect Google Calendar button.
2. oauth2callback.php ➜ The callback handler after user authorization.
3. calendar.php ➜ To create/edit/delete events.

✅ index.php

➡️ Replace credentials.json with the actual file you downloaded from Google Cloud Console OR manually pass the Client ID/Secret like:

✅ oauth2callback.php

➡️ This page handles Google’s redirect, exchanges the code for a token, and stores it in $_SESSION.

✅ calendar.php

Now that we have an access token, let's do something useful—create an event!

✅ Step 4: Securely Store Tokens

If you don’t want to use $_SESSION, store access tokens/refresh tokens in a database:

• Associate them with your user accounts.
• Use encryption for refresh tokens.

✅ Step 5: Additional Operations

➤ List Events

➤ Update Event

➤ Delete Event

✅ Step 6: Testing

Test your workflow:

1. Go to index.php
2. Authenticate with Google
3. Create an event via calendar.php

✅ Optional Enhancements