Download the PHP package mralston/laravel-fullcalendar without Composer

Laravel Full Calendar Helper

IMPORTANT NOTICE

This is a fork of maddhatter/laravel-fullcalendar, created solely because the original package ceases to support Laravel versions after 5.0. I have created this fork for personal usage and will attempt to maintain it for as long as I require it, but please do not rely on it for production sites.

For Laravel 4.2: use the laravel-4 branch

This is a simple helper package to make generating http://fullcalendar.io in Laravel apps easier.

Installing

Require the package with composer using the following command:

composer require mralston/laravel-fullcalendar

Or add the following to your composer.json's require section and composer update

Laravel 5.4 (and earlier)

Register the service provider in your app.php config file:

And optionally create an alias:

Laravel 5.5+

The provider and Calendar alias will be registered automatically.

You will also need to include fullcalendar.io's files in your HTML.

Usage

Creating Events

Using event():

The simpliest way to create an event is to pass the event information to Calendar::event():

Implementing Event Interface

Alternatively, you can use an existing class and have it implement Mralston\LaravelFullcalendar\Event. An example of an Eloquent model that implements the Event interface:

IdentifiableEvent Interface

If you wish for your existing class to have event IDs, implement \Mralston\LaravelFullcalendar\IdentifiableEvent instead. This interface extends \Mralston\LaravelFullcalendar\Event to add a getId() method:

Additional Event Parameters

If you want to add additional parameters to your events, there are two options:

Using Calendar::event()

Pass an array of 'parameter' => 'value' pairs as the 6th parameter to Calendar::event():

Add an getEventOptions method to your event class

Create a Calendar

To create a calendar, in your route or controller, create your event(s), then pass them to Calendar::addEvent() or Calendar::addEvents() (to add an array of events). addEvent() and addEvents() can be used fluently (chained together). Their second parameter accepts an array of valid FullCalendar Event Object parameters.

Sample Controller code:

Sample View

Then to display, add the following code to your View:

Note: The output from calendar() and script() must be non-escaped, so use {!! and !!} (or whatever you've configured your Blade compiler's raw tag directives as).

The script() can be placed anywhere after calendar(), and must be after fullcalendar was included.

This will generate (in February 2015):