naowas/laravel-full-calendar

Laravel 全日历.io 辅助库。基于 https://github.com/maddhatter/laravel-fullcalendar 的分支

v2.0.0 2024-03-13 03:03 UTC

README

这是基于 https://github.com/nelkasovic/laravel-full-calendar 的分支。一个简单的辅助库,使在 Laravel 应用中生成 http://fullcalendar.io 更加容易。因为原包已废弃,我决定分支并发布一个与 Laravel 6 兼容的版本。

安装

使用以下命令通过 Composer 安装包:

composer require qlick/laravel-full-calendar

或者在 composer.json 的 require 部分添加以下内容,并执行 composer update

"require": {
	"qlick/laravel-full-calendar": "~1.0"
}

Laravel 5.4 及更早版本

app.php 配置文件中注册服务提供者

LaravelFullCalendar\FullCalendarServiceProvider::class,

可选地创建一个别名

'Calendar' => LaravelFullCalendar\Facades\Calendar::class,

Laravel 5.5+

提供者和 Calendar 别名将自动注册。

您还需要将 fullcalendar.io 的文件包含到您的 HTML 中。

使用方法

创建事件

使用 event()

创建事件的简单方法是传递事件信息到 Calendar::event()

$event = \Calendar::event(
    "Valentine's Day", //event title
    true, //full day event?
    '2020-02-14', //start time, must be a DateTime object or valid DateTime format (http://bit.ly/1z7QWbg)
    '2020-02-14', //end time, must be a DateTime object or valid DateTime format (http://bit.ly/1z7QWbg),
	1, //optional event ID
	[
		'url' => 'http://full-calendar.io'
	]
);

实现 Event 接口

或者,您可以使用现有的类并让它实现 LaravelFullCalendar\Event。以下是一个实现 Event 接口的 Eloquent 模型示例

class EventModel extends Eloquent implements \LaravelFullCalendar\Event
{

    protected $dates = ['start', 'end'];

    /**
     * Get the event's id number
     *
     * @return int
     */
    public function getId() {
		return $this->id;
	}

    /**
     * Get the event's title
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Is it an all day event?
     *
     * @return bool
     */
    public function isAllDay()
    {
        return (bool)$this->all_day;
    }

    /**
     * Get the start time
     *
     * @return DateTime
     */
    public function getStart()
    {
        return $this->start;
    }

    /**
     * Get the end time
     *
     * @return DateTime
     */
    public function getEnd()
    {
        return $this->end;
    }
}

IdentifiableEvent 接口

如果您希望现有类具有事件 ID,请实现 \LaravelFullcalendar\IdentifiableEvent 而不是 \LaravelFullcalendar\Event。此接口扩展 \LaravelFullcalendar\Event 并添加一个 getId() 方法

class EventModel extends Eloquent implements \LaravelFullcalendar\IdentifiableEvent
{

	// Implement all Event methods ...

    /**
     * Get the event's ID
     *
     * @return int|string|null
     */
    public function getId();

}

额外的事件参数

如果您想向事件添加 额外参数,有两种选项

使用 Calendar::event()

将一个包含 'parameter' => 'value' 对的数组作为第六个参数传递给 Calendar::event()

$event = \Calendar::event(
    "Valentine's Day", //event title
    true, //full day event?
    '2020-02-14', //start time, must be a DateTime object or valid DateTime format (http://bit.ly/1z7QWbg)
    '2020-02-14', //end time, must be a DateTime object or valid DateTime format (http://bit.ly/1z7QWbg),
	1, //optional event ID
	[
		'url' => 'http://full-calendar.io',
		//any other full-calendar supported parameters
	]
);

向您的事件类添加 getEventOptions 方法

<?php
class CalendarEvent extends \Illuminate\Database\Eloquent\Model implements \LaravelFullcalendar\Event
{
	//...

	/**
     * Optional FullCalendar.io settings for this event
     *
     * @return array
     */
    public function getEventOptions()
    {
        return [
            'color' => $this->background_color,
			//etc
        ];
    }

	//...
}

创建日历

要创建日历,在路由或控制器中创建事件,然后传递给 Calendar::addEvent()Calendar::addEvents()(以添加事件数组)。addEvent()addEvents() 可以流畅地使用(链式使用)。它们的第二个参数接受一个有效的 FullCalendar 事件对象参数 数组。

示例控制器代码

$events = [];

$events[] = \Calendar::event(
    'Event One', //event title
    false, //full day event?
    '2020-02-11T0800', //start time (you can also use Carbon instead of DateTime)
    '2020-02-12T0800', //end time (you can also use Carbon instead of DateTime)
	0 //optionally, you can specify an event ID
);

$events[] = \Calendar::event(
    "Valentine's Day", //event title
    true, //full day event?
    new \DateTime('2020-02-14'), //start time (you can also use Carbon instead of DateTime)
    new \DateTime('2020-02-14'), //end time (you can also use Carbon instead of DateTime)
	'stringEventId' //optionally, you can specify an event ID
);

$eloquentEvent = EventModel::first(); //EventModel implements LaravelFullcalendar\Event

$calendar = \Calendar::addEvents($events) //add an array with addEvents
    ->addEvent($eloquentEvent, [ //set custom color fo this event
        'color' => '#800',
    ])->setOptions([ //set fullcalendar options
		'firstDay' => 1
	])->setCallbacks([ //set fullcalendar callback options (will not be JSON encoded)
        'viewRender' => 'function() {alert("Callbacks!");}'
    ]);

return view('hello', compact('calendar'));

示例视图

然后要在视图中显示,请添加以下代码:

<!doctype html>
<html lang="en">
<head>
    <script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
    <script src="//cdnjs.cloudflare.com/ajax/libs/moment.js/2.9.0/moment.min.js"></script>
    <script src="//cdnjs.cloudflare.com/ajax/libs/fullcalendar/2.2.7/fullcalendar.min.js"></script>
    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/fullcalendar/2.2.7/fullcalendar.min.css"/>


    <style>
        /* ... */
    </style>
</head>
<body>
    {!! $calendar->calendar() !!}
    {!! $calendar->script() !!}
</body>
</html>

注意:来自 calendar()script() 的输出必须是未转义的,因此请使用 {!!!!(或您配置的 Blade 编译器原始标签指令)。

script() 可以放在 calendar() 之后任何位置,并且必须在包含 fullcalendar 之后。

这将生成(2020 年 2 月)