ingress-it-solutions/laravel-calendar

Laravel helper for FullCalendar.io

Maintainers

Details

github.com/ingress-it-solutions/laravel-calendar

Source

Installs: 7

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 54

Type:package

v2.0 2023-02-01 08:17 UTC

Requires

MIT b5c2cd099c82d5bcc6400bb0edcb8061e5911ef2

  • ingress-team <hello.woop@ingressit.com>

This package is auto-updated.

Last update: 2024-10-29 12:22:42 UTC

README

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

Thanks to @maddhatter for the initial repo for laravel < 7

Thanks to @acaronlex for the initial repo from laravel < 8

Installing

Require the package with composer using the following command:

composer require ingress-it-solutions/laravel-calendar

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():

$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',
  ]
);

Implementing Event Interface

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

class EventModel extends Eloquent implements
  \IngressITSolutions\LaravelCalendar\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 Interface

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

class EventModel extends Eloquent implements \IngressITSolutions\LaravelCalendar\IdentifiableEvent
{

    // Implement all Event methods ...

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

}

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():

$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
  ]
);

Add an getEventOptions method to your event class

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

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

  //...
}

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 (Using Script Tags and Browser Globals)

$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
);

$calendar = new Calendar();
$calendar->addEvents($events);
$calendar->setOptions([
  'locales' => 'allLocales',
  'locale' => 'fr',
  'firstDay' => 0,
  'displayEventTime' => true,
  'selectable' => true,
  'initialView' => 'timeGridWeek',
  'headerToolbar' => [
    'left' => 'prev,next today myCustomButton',
    'center' => 'title',
    'right' => 'dayGridMonth,timeGridWeek,timeGridDay',
  ],
  'customButtons' => [
    'myCustomButton' => [
      'text' => 'custom!',
      'click' => 'function() {
                alert(\'clicked the custom button!\');
            }',
    ],
  ],
]);
$calendar->setId('1');
$calendar->setCallbacks([
  'select' => 'function(selectionInfo){}',
  'eventClick' => 'function(event){}',
]);

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

Sample Controller code (Using ES6 build system)

$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
);

$calendar = new Calendar();
$calendar->addEvents($events)->setOptions([
  'plugins' => [
    'window.interaction',
    'window.momentPlugin',
    'window.dayGridPlugin',
    'window.timeGridPlugin',
    'window.listPlugin',
  ],
  'locales' => 'window.allLocales',
  'locale' => 'fr',
  'firstDay' => 0,
  'displayEventTime' => true,
  'selectable' => true,
  'initialView' => 'timeGridWeek',
  'headerToolbar' => [
    'left' => 'prev,next today myCustomButton',
    'center' => 'title',
    'right' => 'dayGridMonth,timeGridWeek,timeGridDay',
  ],
  'customButtons' => [
    'myCustomButton' => [
      'text' => 'custom!',
      'click' => 'function() {
                alert(\'clicked the custom button!\');
            }',
    ],
  ],
]);
$calendar->setId('1');
$calendar->setEs6();
$calendar->setCallbacks([
  'select' => 'function(info) {
        alert(\'selected \' + info.startStr + \' to \' + info.endStr);
    }',
  'eventClick' => 'function(info) {
        alert(\'Event: \' + info.event.title);
        alert(\'Coordinates: \' + info.jsEvent.pageX + \',\' + info.jsEvent.pageY);
        alert(\'View: \' + info.view.type);
        
        // change the border color just for fun
        info.el.style.borderColor = \'red\';
    }',
  'dateClick' => 'function(info) {
        alert(\'clicked \' + info.dateStr);
    }',
]);

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

Sample View (Using Script Tags and Browser Globals)

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

<!DOCTYPE html>
<html lang="en">
  <head>
    <script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>
    <script src="//cdnjs.cloudflare.com/ajax/libs/moment.js/2.9.0/moment.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/fullcalendar@5.5.0/main.min.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/fullcalendar@5.5.0/locales-all.min.js"></script>

    <link
      rel="stylesheet"
      href="https://cdn.jsdelivr.net/npm/fullcalendar@5.5.0/main.css"
    />

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

Sample View (Using ES6 build system)

In your /resources/js/app.js add any necessary plugins after installing them with NPM.

// FullCalendar.io
import { Calendar } from '@fullcalendar/core';
window.Calendar = Calendar;

import interaction from '@fullcalendar/interaction';
window.interaction = interaction;

import dayGridPlugin from '@fullcalendar/daygrid';
window.dayGridPlugin = dayGridPlugin;

import timeGridPlugin from '@fullcalendar/timegrid';
window.timeGridPlugin = timeGridPlugin;

import listPlugin from '@fullcalendar/list';
window.listPlugin = listPlugin;

import momentPlugin from '@fullcalendar/moment';
window.momentPlugin = momentPlugin;

import allLocales from '@fullcalendar/core/locales-all';
window.allLocales = allLocales;

In your resources/css/app.scss add the necessary CSS.

// Fullcalendar
@import '~@fullcalendar/bootstrap/main.css';
@import '~@fullcalendar/daygrid/main.css';
@import '~@fullcalendar/timegrid/main.css';
@import '~@fullcalendar/list/main.css';

Then in your blade view file output the HTML:

<!DOCTYPE html>
<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
<head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <link href="{{ mix('/css/app.css') }}" rel="stylesheet">

    <script src="{{ mix('/js/app.js') }}"></script>
</head>
<body>
    {!! $calendar->calendar() !!}
    {!! $calendar->script() !!}
</body>
</html>

Notes

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.