README

此软件包使使用Google日历变得简单。一旦设置好，您就可以执行以下操作

use Spatie\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->save();

// get all future events on a calendar
$events = Event::get();

$firstEvent = $events->first();
$firstEvent->name = 'updated name';
$firstEvent->save();

// create a new event
Event::create([
   'name' => 'A new event'
   'startDateTime' => Carbon\Carbon::now(),
   'endDateTime' => Carbon\Carbon::now()->addHour(),
]);

// delete an event
$event->delete();

Spatie是一家位于比利时的安特卫普的网页设计公司。您可以在我们的网站上找到我们所有开源项目的概述在此。

Postcardware

您可以自由使用此软件包（它是MIT许可），但如果它进入您的生产环境，则必须向我们寄送一张来自您家乡的明信片，说明您正在使用我们的哪些软件包。

我们的地址是：Spatie，Samberstraat 69D，2060 安特卫普，比利时。

最好的明信片将发布在我们的网站上的开源页面上。

安装

您可以通过composer安装此软件包

composer require spatie/laravel-google-calendar

接下来，必须注册服务提供者

'providers' => [
    ...
    Spatie\GoogleCalendar\GoogleCalendarServiceProvider::class,
];

可选地，必须注册 Spatie\GoogleCalendar\GoogleCalendarFacade

'aliases' => [
	...
    'GoogleCalendar' => Spatie\GoogleCalendar\GoogleCalendarFacade::class,
    ...
]

您必须使用此命令发布配置

php artisan vendor:publish --provider="Spatie\GoogleCalendar\GoogleCalendarServiceProvider"

这将发布名为 laravel-google-calendar.php 的文件到您的配置目录，并包含以下内容

<?php

return [

    /**
     * Path to a json file containing the credentials of a Google Service account.
     */
    'client_secret_json' => storage_path('app/laravel-google-calendar/client_secret.json'),

    /**
     *  The id of the Google Calendar that will be used by default.
     */
    'calendar_id' => '',

];

阅读此博客文章，了解如何获取 client_secret_json 和 calendar_id 的正确值。

使用

获取事件

您可以通过调用 Event::get(); 轻松获取所有事件，这将返回未来一年的所有事件。事件以 Spatie\GoogleCalendar\Event 对象的形式出现。

函数的完整签名是

/**
 * @param \Carbon\Carbon|null $startDateTime
 * @param \Carbon\Carbon|null $endDateTime
 * @param array $queryParameters
 * @param string|null $calendarId
 *
 * @return \Illuminate\Support\Collection
 */
public static function get(Carbon $startDateTime = null, Carbon $endDateTime = null, array $queryParameters = [], string $calendarId = null) : Collection

您可以在 $queryParameters 中传递的参数列在 Google日历API文档中关于 list 的文档上。

访问事件的开始和结束日期

您可以使用这些getter来检索开始和结束日期作为 Carbon 实例

$events = Event::get();

$event[0]->startDate;
$event[0]->startDateTime;
$event[0]->endDate;
$event[0]->endDateTime;

创建事件

您可以简单地创建一个 Spatie\GoogleCalendar\Event-对象

$event = new Event;

$event->name = 'A new event';
$event->startDateTime = Carbon\Carbon::now();
$event->endDateTime = Carbon\Carbon::now()->addHour();

$event->save();

您也可以调用 create 静态方法

Event::create([
   'name' => 'A new event',
   'startDateTime' => Carbon\Carbon::now(),
   'endDateTime' => Carbon\Carbon::now()->addHour(),
]);

这将创建一个具有特定开始和结束时间的事件。如果您想创建一个全天事件，必须使用 startDate 和 endDate 而不是 startDateTime 和 endDateTime。

$event = new Event;

$event->name = 'A new full day event';
$event->startDate = Carbon\Carbon::now();
$event->endDate = Carbon\Carbon::now()->addDay();

$event->save();

获取单个事件

Google为每个单独的事件分配一个唯一的ID。您可以通过调用 get 方法并获取 Spatie\GoogleCalendar\Event-对象的 id 属性来获取此ID

// get the id of the first upcoming event in the calendar.
$calendarId = Event::get()->first()->id;

您可以使用此ID从Google获取单个事件

Event::find($calendarId);

更新事件

很简单，只需更改一些属性并调用 save()

$event = Event::find($eventId);

$event->name = 'My updated title';
$event->save();

删除事件

就这么简单！

$event = Event::find($eventId);

$event->delete();

限制

Google日历API提供了许多选项。本包不支持所有这些选项。例如，无法使用本包正确管理重复事件。如果您坚持创建带有名称和日期的事件，应该没问题。

更新日志

请参阅更新日志获取有关最近更改的更多信息。

测试

$ composer test

贡献

请参阅贡献指南获取详细信息。

安全

如果您发现任何安全相关的问题，请通过电子邮件freek@spatie.be联系，而不是使用问题跟踪器。

鸣谢

关于Spatie