Installation

( Installation code : kurtjensen.mycalendar )

Download the plugin to the plugins directory and logout and log in back into October backend. Go to the MyCalendar page in the backend and add your events.

MyCalendar plugin

This plugin adds a simple calendar with events database feature to OctoberCMS.

• Easily add a calendar to your site and populate with your own event dates
• Store dates in a simple table through backend form
• Events can be edited with a rich editor in the backend with installation of Wysiwyg Editors by Anand Patel(*NEW)

MyCalendar was built soley to be extended to do what you need. You can use it as is or add fields with your own plugins.

Go to the MyCalendar page in the backend and add your events.

Display Month calendar on page

• Drag "Month Component" to the page layout.

  {% component 'Month' %}

• Edit Page URL to provide "Next" and "Previous" link to allow users to scroll through months. ( /calendarpage/ with no month or year will default to current month and year)

  /calendarpage/:month?/:year?

Display Month calendar on page and make it wider

• Drag "Month Component" to the page layout and edit as below.

  <style>
      table.mycal { width: 900px;}
  </style>

  {% component 'Month' %}

Display Month calendar on page and insert events from DB

• Drag "Events Component" to add it to page.
• Drag "Month Component" to the page layout and edit as below.

  {% component 'Events' %}
  {% component 'Month' events = MyEvents %}

The "Events Component" injects the MyEvents array into the page. It also has a modal pop-up for showing event details.

Display Event list calendar on page and insert events from today to 60 days from now

• Drag "Events Component" to the page.
• Drag "List Component" to the page layout and edit as below.
• In "Events Component" set property "Future Days" to 60

  <div style="width:100px">
  {% component 'Events' %}
  {% component 'EvList' events = MyEvents %}
  </div>

The "List Component" only shows up when there are events for the month indicated. The "Events Component" injects the MyEvents array into the page.

You have multiple optional properties for each component

• Month (month) - The month you want to show. ( defaults to now )
• Year (year) -The year you want to show. ( defaults to now )
• Events (events) - Array of the events you want to show.
• Calendar Color (color) - What color do you want calendar to be? ( defaults to red )
• Day Properties (dayprops) - Array of the properties you want to put on the day indicator.
• Load Style Sheet (loadstyle) - Do you want to load the default stylesheet?

These properties can be set by clicking on component and changing them there or in the page layout as below:

{% component 'Month' month = 2 events = MyEvents %}

Passing you own "Events" and/or "Day Properties" to the calendar

If passing you own "Events" and/or "Day Properties" to the calendar using an array in the page, here is the formate used:

    /**
    * ======================================================
    * Sample of array format used to pass events to calendar
    * ======================================================
    **/
    $this->page['MyEvents'] = [
        2015 => [   // Year
            2 => [    // Month
                20 => [  // Day
                    [
                        'txt' => 'October CMS', 
                        'link' => 'http://octobercms.com/'
                    ], 
                    [
                        'txt' => '<p>Text to show on calendar</p>', 
                        // You can add properties to anchor tag if needed.
                        'link' => '#content-confirmation" data-toggle="modal',
                        // You can add a CSS class tag to the <li> tag for this event.
                        'class' => 'text-success',
                        // You can add an on-hover "title" property to the <li> tag for this event.
                        'title' => 'Just another test. This text shows on hover of event.' 
                    ],
                ],
                22 => [
                    [
                        'txt' => 'My really long and dumb event name',
                        'title' => 'More about my really long and dumb event named event.'
                    ],
                ],
            ],
        ]
    ];
    /**
    * ==============================================================
    * Sample of array format used to pass Day Properties to calendar
    * ==============================================================
    **/
    $this->page['MyDayProps'] = [
        2015 => [   // Year
            2 => [    // Month
                20 => [ // Day
                    // You can add a link to the day indicator in the calendar.
                    // ( This example was for a modal AJAX dialog box. )
                    'link' => '#content-confirmation" data-toggle="modal'
                ],
                22 => [
                    // You can add a CSS class to the day indicator in the calendar.
                    'class' => 'dis'
                ],
            ],
        ] 
    ];

Thank You Early Users

Early users have discovered that several issues with the original design of this plugin. I want to sincerely apologize for those missteps and flaws that became very apparent when December and January events did not show as expected on your calendars. This is my third project involving calendars in PHP and each time I learn something new and often forget the many pitfalls of working with dates. This plugin was no exception.

I very much appreciate your patience and assistance in finding and addressing issues that I should have found before first publishing. I am committed to getting this right but there is still work to be done before I am completely satisfied with this product. Please hang in there and continue to point out any issues you may discover.

Did You Add Your Own Language File?

Please share it with the community by contacting me directly using the contact form at https://octobercms.com/author/KurtJensen

Like this plugin?

If you like this plugin or if you use some of my plugins, you can help me by submiting a review in the market.

Please do not hesitate to find me in the IRC channel or contact me for assistance. Sincerely Kurt Jensen

Upgrade guide

• Upgrading to 1.0.10 from 1.0.9
• Upgrading to 1.0.18
• Upgrading to 1.1.5 from 1.1.4
• Upgrading to 1.1.8 from 1.1.7

<a name="upgrade-1.1.8"></a>

Upgrading To 1.1.8

This is an important update that contains breaking changes.

The Super Simple Calendar is Growing Up. Several customers have requested the ability to have recurring dates on MyCalendar. This feature has now been added and I want to make sure existing customers understand how this update will effect them and their current installation. Details about the changes and upgrade instructions can be found at: http://firemankurt.com/mycalendar

<a name="upgrade-1.1.5"></a>

Upgrading To 1.1.5

This is an important update that contains breaking changes.

MyCalendar will now be using Passage Permission Keys plugin for permissions.

You will need to install that plugin using code "kurtjensen.passage".

You should follow directions in Passage Permission Keys plugin to transfer your permissions over from the Roles plugin. No other changes should be needed for existing MyCalendar data to work as long as the "id" of the permissions in Passage Permission Keys matches the "id" old of the permissions in Roles.

If you do not install Passage Permission Keys plugin then your protected events may not show or may be visible to anyone who visits your site until you do add PassagePermission Keys plugin.

This change was due to some unresolved issues in the Roles plugin that made it unreliable and out of our control to fix.

IF YOU USE PERMISSIONS, DO NOT UPGRADE TO 1.1.5 UNLESS YOU ARE GOING TO INSTALL Passage Permission Keys PLUGIN.

This update also added raw data element to event array and applied config date/time to all components.

<a name="upgrade-1.0.18"></a>

Upgrading To 1.0.18

The database has been changed to the more common and easier to use date field instead of separate year,month, and day fields. There is very good reason for using one date type field and I should have thought that through better prior to original design. If you are ever thinking of breaking dates across multiple DB fields in one of your own projects, DON'T DO IT. Dates are a nightmare already without adding a non-standard method of storage to the problem.

Your data should transfer to this new date field automagicaly on upgrade and you should not need to change any data.

Please review instructions as some things have changed for displaying "Event Lists". This should be much easier now.

I have discovered that some items in Backend still do not use translation and those will areas be addressed in upcoming updates. Thank you for your patients.

<a name="upgrade-1.0.10"></a>

Upgrading To 1.0.10

The Month Component now includes a "Next" and "Previous" link to allow users to scroll through months. You will need to add parameters to your page URL to accept these parameters. Example:

/calendarpage/:month?/:year?

This will make the parameters optional and default to current month and year.