README

Yii2 Google Calendar Api 扩展

安装

安装此扩展的首选方法是使用 composer

composer require --prefer-dist vadgab/yii2-google-calendar-api

基本信息

此应用程序使用基于Google Calendar服务账户认证，这意味着登录过程在后台进行。它允许查询、创建、修改和删除第三方用户的日历相关事件，无需在弹出窗口中进行认证。

配置

您需要在Google Cloud控制台中创建一个服务账户，并授予其访问日历的适当权限，以及一个认证密钥，您需要下载并放置以便应用程序访问，并提供其路径。

基本用法

getEvents() - 获取事件列表

参数

• 参数 (可选) - 完整参数列表：https://developers.google.com/calendar/api/v3/reference/events/list

use vadgab\Yii2GoogleCalendar\GoogleCalendar;

$serviceAccount = new GoogleCalendar(
            "your_service_email", 
            "./../your_downloaded_key.json", array(
            "https://www.googleapis.com/auth/calendar",
            "https://www.googleapis.com/auth/calendar.events"
        )
    );        

$serviceAccount->calendarId = "calendarId";  //required
$params = ['timeMin'=>'2020-06-03T10:00:00Z']; //opcional
$serviceAccount->evenId = "eventId"; //opcional
$events = $serviceAccount->getEvents($params);

echo "<pre>"; var_dump($events); echo "</pre>";

insertEvent() - 在您的日历上添加事件

参数

• 负载 (必需) - 完整参数列表：https://developers.google.com/calendar/api/v3/reference/events/insert

use vadgab\Yii2GoogleCalendar\GoogleCalendar;

$serviceAccount = new GoogleCalendar(
            "your_service_email", 
            "./../your_downloaded_key.json", array(
            "https://www.googleapis.com/auth/calendar",
            "https://www.googleapis.com/auth/calendar.events"
        )
    );        

$serviceAccount->calendarId = "calendarId";  //required
$payload = array(
    'summary' => 'Teszt Event',
    'description' => 'Teszt description',
    'location' => 'Budapest',
    'start' => array('dateTime' => "2023-05-10T10:00:00Z"),
    'end' => array('dateTime' => "2023-05-10T11:00:00Z"),
);

$events = $serviceAccount->insertEvent($payload);


echo "<pre>";
var_dump($events);
echo "</pre>";

响应

array(18) { ["kind"]=> string(14) "calendar#event" ["etag"]=> string(18) """" ["id"]=> string(26) "tme6m9k9g4p0n6sr48693oq4fo" ["status"]=> string(9) "confirmed" ["htmlLink"]=> string(93) "https://www.google.com/calendar/event?eid=***" ["created"]=> string(24) "2023-05-05T11:17:57.000Z" ["updated"]=> string(24) "2023-05-05T11:17:57.483Z" ["summary"]=> string(11) "Teszt Event" ["description"]=> string(17) "Teszt description" ["location"]=> string(8) "Budapest" ["creator"]=> array(1) { ["email"]=> string(75) "**************************" } ["organizer"]=> array(2) { ["email"]=> string(19) "" ["self"]=> bool(true) } ["start"]=> array(2) { ["dateTime"]=> string(25) "2023-05-10T12:00:00+02:00" ["timeZone"]=> string(3) "UTC" } ["end"]=> array(2) { ["dateTime"]=> string(25) "2023-05-10T13:00:00+02:00" ["timeZone"]=> string(3) "UTC" } ["iCalUID"]=> string(37) "**************" ["sequence"]=> int(0) ["reminders"]=> array(1) { ["useDefault"]=> bool(true) } ["eventType"]=> string(7) "default" }

updateEvent() - 在您的日历上添加事件

参数

• 负载 (必需) - 完整参数列表：https://developers.google.com/calendar/api/v3/reference/events/update

use vadgab\Yii2GoogleCalendar\GoogleCalendar;

$serviceAccount = new GoogleCalendar(
            "your_service_email", 
            "./../your_downloaded_key.json", array(
            "https://www.googleapis.com/auth/calendar",
            "https://www.googleapis.com/auth/calendar.events"
        )
    );        

$serviceAccount->calendarId = "calendarId";  //required
$serviceAccount->eventId = "eventId";  //required
$payload = array(
    'summary' => 'Teszt Event update',
    'description' => 'Teszt description update',
    'location' => 'Budapest',
    'start' => array('dateTime' => "2023-05-10T10:00:00Z"),
    'end' => array('dateTime' => "2023-05-10T11:00:00Z"),
);
$events = $serviceAccount->updateEvent($payload);


echo "<pre>";
var_dump($events);
echo "</pre>";

响应

array(18) { ["kind"]=> string(14) "calendar#event" ["etag"]=> string(18) """" ["id"]=> string(26) "tme6m9k9g4p0n6sr48693oq4fo" ["status"]=> string(9) "confirmed" ["htmlLink"]=> string(93) "https://www.google.com/calendar/event?eid=***" ["created"]=> string(24) "2023-05-05T11:17:57.000Z" ["updated"]=> string(24) "2023-05-05T11:17:57.483Z" ["summary"]=> string(11) "Teszt Event update" ["description"]=> string(17) "Teszt description update" ["location"]=> string(8) "Budapest" ["creator"]=> array(1) { ["email"]=> string(75) "**************************" } ["organizer"]=> array(2) { ["email"]=> string(19) "" ["self"]=> bool(true) } ["start"]=> array(2) { ["dateTime"]=> string(25) "2023-05-10T12:00:00+02:00" ["timeZone"]=> string(3) "UTC" } ["end"]=> array(2) { ["dateTime"]=> string(25) "2023-05-10T13:00:00+02:00" ["timeZone"]=> string(3) "UTC" } ["iCalUID"]=> string(37) "**************" ["sequence"]=> int(0) ["reminders"]=> array(1) { ["useDefault"]=> bool(true) } ["eventType"]=> string(7) "default" }

deleteEvent() - 在您的日历上删除事件

use vadgab\Yii2GoogleCalendar\GoogleCalendar;

$serviceAccount = new GoogleCalendar(
            "your_service_email", 
            "./../your_downloaded_key.json", array(
            "https://www.googleapis.com/auth/calendar",
            "https://www.googleapis.com/auth/calendar.events"
        )
    );        

$serviceAccount->calendarId = "calendarId";  //required
$serviceAccount->eventId = "eventId";  //required
$events = $serviceAccount->deleteEvent();