https://github.com/donatj/simplecalendar
A simple PHP calendar rendering class
https://github.com/donatj/simplecalendar
calendar-view event-calendar php
Last synced: 19 days ago
JSON representation
A simple PHP calendar rendering class
- Host: GitHub
- URL: https://github.com/donatj/simplecalendar
- Owner: donatj
- License: mit
- Created: 2010-06-30T19:38:08.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2024-11-24T12:22:15.000Z (5 months ago)
- Last Synced: 2025-04-01T14:14:38.309Z (26 days ago)
- Topics: calendar-view, event-calendar, php
- Language: PHP
- Homepage: https://donatstudios.com/SimpleCalendar
- Size: 158 KB
- Stars: 80
- Watchers: 13
- Forks: 46
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Simple Calendar
[](https://packagist.org/packages/donatj/simplecalendar)
[](https://packagist.org/packages/donatj/simplecalendar)
[](https://github.com/donatj/SimpleCalendar/actions/workflows/ci.yml)
A very simple, easy to use PHP calendar rendering class.
## Requirements
- **php**: >=7.2
- **ext-calendar**: *
## Installing
Install the latest version with:
```bash
composer require 'donatj/simplecalendar'
```
## Examples
```php
';
$calendar = new donatj\SimpleCalendar('June 2010');
echo $calendar->render();
```
```php
';
$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
```php
function __construct([ $calendarDate = null [, $today = null]])
```
##### Parameters:
- ***\DateTimeInterface*** | ***int*** | ***string*** | ***null*** `$calendarDate`
- ***\DateTimeInterface*** | ***false*** | ***int*** | ***string*** | ***null*** `$today`
---
#### Method: SimpleCalendar->setDate
```php
function setDate([ $date = null]) : void
```
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.
**Throws**: `\Exception`
---
#### Method: SimpleCalendar->setCalendarClasses
```php
function setCalendarClasses(array $classes) : void
```
Sets the class names used in the calendar
```php
[
'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
```php
function setToday([ $today = null]) : void
```
Sets "today"'s date. Defaults to today.
##### Parameters:
- ***\DateTimeInterface*** | ***false*** | ***int*** | ***string*** | ***null*** `$today` - `null` will default to today, `false` will disable the
rendering of Today.
**Throws**: `\Exception`
---
#### Method: SimpleCalendar->setWeekDayNames
```php
function setWeekDayNames([ ?array $weekDayNames = null]) : void
```
##### Parameters:
- ***string[]*** | ***null*** `$weekDayNames`
---
#### Method: SimpleCalendar->addDailyHtml
```php
function addDailyHtml(string $html, $startDate [, $endDate = null]) : void
```
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
**Throws**: `\Exception`
---
#### Method: SimpleCalendar->clearDailyHtml
```php
function clearDailyHtml() : void
```
Clear all daily events for the calendar
---
#### Method: SimpleCalendar->setStartOfWeek
```php
function setStartOfWeek($offset) : void
```
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
```php
function show([ bool $echo = true]) : string
```
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
```php
function render() : string
```
Returns the generated Calendar