funayaki/cakephp-calendar

A CakePHP plugin to easily create calendars.

CakePHP Calendar plugin

, _(*1)

A plugin to render simple calendars., _(*2)

This branch is for CakePHP 3.5+., _(*3)

Features

• Simple and robust
• No JS needed, more responsive than solutions like fullcalendar
• Persistent year/month URL pieces (copy-paste and link/redirect friendly)

Demo

See the demo Calendar example at the sandbox., _(*4)

Setup

composer require dereuromark/cakephp-calendar

Then make sure the plugin is loaded in bootstrap:, _(*5)

bin/cake plugin load Calendar

You can also just manually put this in:, _(*6)

Plugin::load('Calendar');

Usage

Load the component in your controller:, _(*7)

$this->loadComponent('Calendar.Calendar');

And also your helper in the View class:, _(*8)

$this->loadHelper('Calendar.Calendar');

Your action:, _(*9)

    /**
     * @param string|null $year
     * @param string|null $month
     * @return void
     */
    public function calendar($year = null, $month = null) {
        $this->Calendar->init($year, $month);

        // Fetch calendar items (like events, birthdays, ...)
        $options = [
            'year' => $this->Calendar->year(),
            'month' => $this->Calendar->month(),
        ];
        $events = $this->Events->find('calendar', $options);

        $this->set(compact('events'));
    }

In your index template:, _(*10)

Html->link($event->title, ['action' => 'view', $event->id]);
        $this->Calendar->addRow($event->date, $content, ['class' => 'event']);
    }

    echo $this->Calendar->render();
?>

Calendar->isCurrentMonth()) { ?>
    <?php echo $this->Html->link(__('Jump to the current month') . '...', ['action' => 'index'])?>

And in your view template you can have a backlink as easy as:, _(*11)

<?php echo $this->Html->link(
    __('List {0}', __('Events')), 
    $this->Calendar->calendarUrlArray(['action' => 'index'], $event->date)
); ?>

It will redirect back to the current year and month this calendar item has been linked from. So you have a persistent calendar - even with some clicking around, the user will still be able to navigate very easily through the calendar items., _(*12)

Multi-day events

In case you have a beginning and end for dates, and those can span over multiple days, use:, _(*13)

Calendar->addRowFromTo($event->beginning, $event->end, $content, $attr);
    }

    echo $this->Calendar->render();
?>

Configuration

Integrity

The component validates both year and month input and throws 404 exception for invalid ones., _(*14)

The component has a max limit in each direction, defined by init() call:, _(*15)

$this->Calendar->init($year, $month, 5);

This will allow the calendar to work 5 years in both directions. Out of bounds are 404 exceptions. The helper knows not to generate links for over the limit dates., _(*16)

Presentation

You can configure the URL elements to contain the month either as number (default) or text., _(*17)

/controller/action/2017/08
/controller/action/2017/august

When loading the helper, pass 'monthAsString' => true for the textual option., _(*18)