donatj/simplecalendar

A light, easy to use calendar rendering library

v0.6.2 2017-06-07 14:57 UTC

This package is auto-updated.

Last update: 2020-07-09 04:54:29 UTC


README

Latest Stable Version License Scrutinizer Code Quality Code Coverage Build Status

A very simple, easy to use PHP calendar rendering class.

Requirements

  • php: >=5.5.0
  • ext-calendar: *

Installing

Install the latest version with:

composer require 'donatj/simplecalendar'

Examples

<?php

require '../vendor/autoload.php';

echo '<link rel="stylesheet" href="../src/css/SimpleCalendar.css" />';

$calendar = new donatj\SimpleCalendar('June 2010');

echo $calendar->render();
<?php
require '../vendor/autoload.php';

echo '<link rel="stylesheet" href="../src/css/SimpleCalendar.css" />';

$calendar = new donatj\SimpleCalendar();

$calendar->setStartOfWeek('Sunday');
$calendar->addDailyHtml('Sample Event', 'today', 'tomorrow');

$calendar->setWeekDayNames([ 'Sun', 'Mon', 'Tu', 'W', 'Th', 'F', 'Sa' ]);
$calendar->setStartOfWeek('Monday');

echo $calendar->render();

Documentation

Class: \donatj\SimpleCalendar

Simple Calendar

Method: SimpleCalendar->__construct

function __construct([ $calendarDate = null [, $today = null]])
Parameters:
  • \DateTimeInterface | int | string | null $calendarDate
  • \DateTimeInterface | bool | int | string | null $today

Method: SimpleCalendar->setDate

function setDate([ $date = null])

Sets the date for the calendar.

Parameters:
  • \DateTimeInterface | int | string | null $date - DateTimeInterface or Date string parsed by strtotime for the calendar date. If null set to current timestamp.

Method: SimpleCalendar->setCalendarClasses

function setCalendarClasses([ array $classes = []])

Sets the class names used in the calendar

[  
   'calendar'     => 'SimpleCalendar',  
   'leading_day'  => 'SCprefix',  
   'trailing_day' => 'SCsuffix',  
   'today'        => 'today',  
   'event'        => 'event',  
   'events'       => 'events',  
]  
Parameters:
  • array $classes - Map of element to class names used by the calendar.

Method: SimpleCalendar->setToday

function setToday([ $today = null])

Sets "today"'s date. Defaults to today.

Parameters:
  • \DateTimeInterface | bool | string | null $today - null will default to today, false will disable the rendering of Today.

Method: SimpleCalendar->setWeekDayNames

function setWeekDayNames([ array $weekDayNames = null])
Parameters:
  • string[] | null $weekDayNames

Method: SimpleCalendar->addDailyHtml

function addDailyHtml($html, $startDate [, $endDate = null])

Add a daily event to the calendar

Parameters:
  • string $html - The raw HTML to place on the calendar for this event
  • \DateTimeInterface | int | string $startDate - Date string for when the event starts
  • \DateTimeInterface | int | string | null $endDate - Date string for when the event ends. Defaults to start date

Method: SimpleCalendar->clearDailyHtml

function clearDailyHtml()

Clear all daily events for the calendar

Method: SimpleCalendar->setStartOfWeek

function setStartOfWeek($offset)

Sets the first day of the week

Parameters:
  • int | string $offset - Day the week starts on. ex: "Monday" or 0-6 where 0 is Sunday

Method: SimpleCalendar->show

function show([ $echo = true])

Returns/Outputs the Calendar

DEPRECATED

Use render() method instead.

Parameters:
  • bool $echo - Whether to echo resulting calendar
Returns:
  • string - HTML of the Calendar

Method: SimpleCalendar->render

function render()

Returns the generated Calendar

Returns:
  • string