gregoryxg/laravel-fullcalendar

Laravel对FullCalendar.io的辅助工具

dev-master 2022-08-06 06:27 UTC

This package is auto-updated.

Last update: 2024-09-06 11:00:41 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License

对于Laravel 4.2:使用laravel-4分支

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

安装

使用以下命令通过composer安装包

composer require gregoryxg/laravel-fullcalendar

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

"require": {
	"gregoryxg/laravel-fullcalendar": "*"
}

Laravel 5.4(及之前版本)

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

src\LaravelFullCalendar\Models\ServiceProvider::class,

可选地创建别名

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

Laravel 5.5+

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

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

使用方法

创建事件

使用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接口

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

class EventModel extends Eloquent implements \src\LaravelFullCalendar\Models\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,请实现\src\LaravelFullCalendar\Models\IdentifiableEvent,该接口扩展了\src\LaravelFullCalendar\Models\Event并添加了一个getId()方法

class EventModel extends Eloquent implements \src\LaravelFullCalendar\Models\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?
    '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 \src\LaravelFullCalendar\Models\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 src\LaravelFullCalendar\Models\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被包含之后。

这将生成(2015年2月)