alimehraei/laravel-fullcalendar-scheduler

Laravel component for fullcalendar scheduler module

dev-master / 1.0.x-dev 2022-07-25 23:11 UTC

Requires

• php: 8.*
• laravel/framework: 9.*

Requires (Dev)

• orchestra/testbench: ^7.6
• phpunit/phpunit: ^9.5

MIT

• Edo Freriks
• Ali Mehraei

• javascript
• event
• calendar
• scheduler
• fullcalendar-scheduler
• php 8
• laravel 9

README

Laravel fullcalendar scheduler component

ATTENTION: THIS PACKAGE IS NOT READY YET !!

Installation

The preferred way to install this extension is through composer.

To install, either run

$ php composer.phar require alimehraei/laravel-fullcalendar-scheduler "v1.2.3"

or add

"alimehraei/laravel-fullcalendar-scheduler": "v1.2.3"

to the require section of your composer.json file.

Note

This package is written based on this git repository: https://github.com/Edofre/laravel-fullcalendar-scheduler

The foxy/foxy plugin is required for this package to install properly. This plugin enables you to download bower packages through composer.

You can install it using this command:

composer global require "foxy/foxy:^1.0.0"

Configuration

Add the ServiceProvider to your config/app.php

'providers' => [
        ...
        AliMehraei\FullcalendarScheduler\FullcalendarSchedulerServiceProvider::class,
    ],

And add the facade

'aliases' => [
        ...
        'Fullcalendar' => AliMehraei\FullcalendarScheduler\Facades\FullcalendarScheduler::class,
    ],

Publish assets and configuration files

php artisan vendor:publish --tag=config
php artisan vendor:publish --tag=fullcalendar-scheduler

Manually loading script files

By setting the include_scripts option in the config/.env file to false the scripts will not be included when generating the calendar. If you want to manually include the scripts you can call the following static function in your header/footer/etc.

    \AliMehraei\FullcalendarScheduler\FullcalendarScheduler::renderScriptFiles();

Example

Use the following as your controller action

/**
 * @return \Illuminate\Http\Response
 */
public function index()
{
    // Generate a new fullcalendar instance
    $calendar = new \AliMehraei\FullcalendarScheduler\FullcalendarScheduler();

    // Set events and resources, commented lines shows how to add them via ajax
    // $calendar->setEvents(route('fullcalendar-scheduler-ajax-events'));
    $calendar->setEvents([
        ['id' => '1', 'resourceId' => 'b', 'start' => '2016-05-07T02:00:00', 'end' => '2016-05-07T07:00:00', 'title' => 'event 1'],
        ['id' => '2', 'resourceId' => 'c', 'start' => '2016-05-07T05:00:00', 'end' => '2016-05-07T22:00:00', 'title' => 'event 2'],
        ['id' => '3', 'resourceId' => 'd', 'start' => '2016-05-06', 'end' => '2016-05-08', 'title' => 'event 3'],
        ['id' => '4', 'resourceId' => 'e', 'start' => '2016-05-07T03:00:00', 'end' => '2016-05-07T08:00:00', 'title' => 'event 4'],
        ['id' => '5', 'resourceId' => 'f', 'start' => '2016-05-07T00:30:00', 'end' => '2016-05-07T02:30:00', 'title' => 'event 5'],
    ]);
    
    // $calendar->setResources(route('fullcalendar-scheduler-ajax-resources'));
    $calendar->setResources([
        ['id' => 'a', 'title' => 'Auditorium A'],
        ['id' => 'b', 'title' => 'Auditorium B', 'eventColor' => 'green'],
		['id' => 'c', 'title' => 'Auditorium C', 'eventColor' => 'orange'],
        [
            'id'       => 'd',
            'title'    => 'Auditorium D',
            'children' => [
                ['id' => 'd1', 'title' => 'Room D1'],
                ['id' => 'd2', 'title' => 'Room D2'],
            ],
        ],
        ['id' => 'e', 'title' => 'Auditorium E'],
        ['id' => 'f', 'title' => 'Auditorium F', 'eventColor' => 'red'],
        ['id' => 'g', 'title' => 'Auditorium G'],
        ['id' => 'h', 'title' => 'Auditorium H'],
        ['id' => 'i', 'title' => 'Auditorium I'],
        ['id' => 'j', 'title' => 'Auditorium J'],
        ['id' => 'k', 'title' => 'Auditorium K'],
        ['id' => 'l', 'title' => 'Auditorium L'],
        ['id' => 'm', 'title' => 'Auditorium M'],
        ['id' => 'n', 'title' => 'Auditorium N'],
        ['id' => 'o', 'title' => 'Auditorium O'],
        ['id' => 'p', 'title' => 'Auditorium P'],
        ['id' => 'q', 'title' => 'Auditorium Q'],
        ['id' => 'r', 'title' => 'Auditorium R'],
        ['id' => 's', 'title' => 'Auditorium S'],
        ['id' => 't', 'title' => 'Auditorium T'],
        ['id' => 'u', 'title' => 'Auditorium U'],
        ['id' => 'v', 'title' => 'Auditorium V'],
        ['id' => 'w', 'title' => 'Auditorium W'],
        ['id' => 'x', 'title' => 'Auditorium X'],
        ['id' => 'y', 'title' => 'Auditorium Y'],
        ['id' => 'z', 'title' => 'Auditorium Z'],
    ]);

    // Set options
    $calendar->setOptions([
        'now'               => '2016-05-07',
        'editable'          => true, // enable draggable events
        'aspectRatio'       => 1.8,
        'scrollTime'        => '00:00', // undo default 6am scrollTime
        'defaultView'       => 'timelineDay',
        'views'             => [
            'timelineThreeDays' => [
                'type'     => 'timeline',
                'duration' => [
                    'days' => 3,
                ],
            ],
        ],
        'resourceLabelText' => 'Rooms',
        'eventClick' => new \AliMehraei\FullcalendarScheduler\JsExpression("
                    function(event, jsEvent, view) {
                        console.log(event);
                    }
                "),
                'viewRender' => new \AliMehraei\FullcalendarScheduler\JsExpression("
                    function( view, element ) {
                        console.log(\"View \"+view.name+\" rendered\");
                    }
                "),
    ]);

    return view('fullcalendar-scheduler.index', [
        'calendar' => $calendar,
    ]);
}

And then add the following to your view

{!! $calendar->generate() !!}

Tests

Run the tests by executing the following command:

composer test