README

这是一个简单的助手包，用于简化在 Laravel 应用中生成 http://fullcalendar.io 的过程。

安装

使用以下命令通过 Composer 需求此包：

composer require meunee/laravel-fullcalendar

或者将以下内容添加到你的 composer.json 的 require 部分，并执行 composer update

"require": {
	"meunee/laravel-fullcalendar": "~1.0.1"
}

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

你不需要将 fullcalendar.io 的文件包含在你的 HTML 中，版本 6.0.2 已包含在此包中。

使用方法

创建事件

使用 event()

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

$event = \Calendar::event(
    "Valentine's Day", //event title
    true, //full day event?
    '2015-02-14', //start time, must be a DateTime object or valid DateTime format (http://bit.ly/1z7QWbg)
    '2015-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 接口

或者，你可以使用一个现有的类，并使其实现 Meunee\LaravelFullcalendar\Event。以下是一个实现 Event 接口的 Eloquent 模型示例

class EventModel extends Eloquent implements \Meunee\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，则实现 \Meunee\LaravelFullcalendar\IdentifiableEvent 而不是 Event。此接口扩展 \Meunee\LaravelFullcalendar\Event 并添加一个 getId() 方法

class EventModel extends Eloquent implements \Meunee\LaravelFullcalendar\IdentifiableEvent
{

	// Implement all Event methods ...

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

}

其他事件参数

如果你想在事件中添加 其他参数，有两种选择

使用 Calendar::event()

将一个数组作为第 6 个参数传递给 Calendar::event()，其中键为 'parameter'，值为 'value'

$event = \Calendar::event(
    "Valentine's Day", //event title
    true, //full day event?
    '2015-02-14', //start time, must be a DateTime object or valid DateTime format (http://bit.ly/1z7QWbg)
    '2015-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 \Meunee\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?
    '2015-02-11T0800', //start time (you can also use Carbon instead of DateTime)
    '2015-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('2015-02-14'), //start time (you can also use Carbon instead of DateTime)
    new \DateTime('2015-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 Meunee\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">
<body>
    {!! $calendar->calendar() !!}
    {!! $calendar->script() !!}
</body>
</html>

注意：来自 calendar() 和 script() 的输出必须是非转义的，因此请使用 !! 和 !!（或者根据你配置的 Blade 编译器的原始标签指令）。

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

这将生成（在 2022 年 2 月）