Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 2.52 KB

README.md

File metadata and controls

63 lines (49 loc) · 2.52 KB
Raw

Laravel 4 Calendar

Flexible Calendar for Laravel 4, supports Month, Week and Day Views and multiple events per date.

To change the view type dynamically, pass in a GET variable called 'cv' (calendar view) with either a 'week' or 'day' value. Day and Week views are split into 30 minute interval rows.

Install:

Add this to "require" in composer.json:

	"makzumi/calendar": "dev-master"

After that run a composer update, then in app.php add:

	'providers' => array(
				...,
				'Makzumi\Calendar\CalendarServiceProvider',
			),

To use, create a new Calender instance and generate it, below you'll find several options to customize it as well:

	$events = array(
		"2014-04-09 10:30:00" => array(
			"Event 1",
			"Event 2 <strong> with html</stong>",
		),
		"2014-04-12 14:12:23" => array(
			"Event 3",
		),
		"2014-05-14 08:00:00" => array(
			"Event 4",
		),
	);

	$cal = Calendar::make();
	/**** OPTIONAL METHODS ****/
	$cal->setDate(Input::get('cdate')); //Set starting date
	$cal->setBasePath('/dashboard'); // Base path for navigation URLs
	$cal->showNav(true); // Show or hide navigation
	$cal->setView(Input::get('cv')); //'day' or 'week' or null
	$cal->setStartEndHours(8,20); // Set the hour range for day and week view
	$cal->setTimeClass('ctime'); //Class Name for times column on day and week views
	$cal->setEventsWrap(array('<p>', '</p>')); // Set the event's content wrapper
	$cal->setDayWrap(array('<div>','</div>')); //Set the day's number wrapper
	$cal->setNextIcon('>>'); //Can also be html: <i class='fa fa-chevron-right'></i>
	$cal->setPrevIcon('<<'); // Same as above
	$cal->setDayLabels(array('Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat')); //Label names for week days
	$cal->setMonthLabels(array('January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December')); //Month names
	$cal->setDateWrap(array('<div>','</div>')); //Set cell inner content wrapper
	$cal->setWeekStartsMonday(true); // Make monday the first day of the week
	$cal->setHighlightEvents(true); // Highlight dates with events in month view (potential performance impact!)
	$cal->setTableClass('table'); //Set the table's class name
	$cal->setHeadClass('table-header'); //Set top header's class name
	$cal->setNextClass('btn'); // Set next btn class name
	$cal->setPrevClass('btn'); // Set Prev btn class name
	$cal->setEvents($events); // Receives the events array
	/**** END OPTIONAL METHODS ****/

	echo $cal->generate() // Return the calendar's html;