mralston / laravel-fullcalendar
FullCalendar.io的Laravel辅助工具。由maddhatter/laravel-fullcalendar分支而来
Requires
- php: >=5.4.0
- illuminate/support: ^5.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
README
重要通知
这是一个对maddhatter/laravel-fullcalendar的分支,仅因为原始包不再支持5.0之后的Laravel版本。我创建了这个分支用于个人使用,并将尽可能地维护它,但请不要在生产网站上依赖于它。
对于Laravel 4.2:使用laravel-4分支
这是一个简单的辅助包,使在Laravel应用程序中生成http://fullcalendar.io更加容易。
安装
使用以下命令通过composer要求包
composer require mralston/laravel-fullcalendar
或者将以下内容添加到composer.json的require部分并执行composer update
"require": { "mralston/laravel-fullcalendar": "~1.0" }
Laravel 5.4(及更早版本)
在app.php
配置文件中注册服务提供者
Mralston\LaravelFullcalendar\ServiceProvider::class,
并且可选地创建一个别名
'Calendar' => Mralston\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
接口
或者,你可以使用一个现有的类,并使其实现Mralston\LaravelFullcalendar\Event
。以下是一个实现Event
接口的Eloquent模型示例
class EventModel extends Eloquent implements \Mralston\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,请使用\Mralston\LaravelFullcalendar\IdentifiableEvent
代替。此接口扩展了\Mralston\LaravelFullcalendar\Event
并添加了一个getId()
方法
class EventModel extends Eloquent implements \Mralston\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? '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 \Mralston\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 Mralston\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()
之后的位置,并且必须在全calendar包含之后。
这将生成(2015年2月)