There is no license information available for the latest version (dev-master) of this package.

Laravel 4 Calendar, port of the CodeIgniter Calender Library

dev-master 2015-02-05 09:43 UTC


Install the package through Composer. Edit your project's composer.json file by adding:

"require": {
	"laravel/framework": "4.0.*",
	"gloudemans/calendar": "dev-master"

Next, run the Composer update command from the Terminal:

composer update

Now all you have to do is add the service provider of the package and alias the package. To do this open your app/config/app.php file.

Add a new line to the service providers array:


And finally add a new line to the aliases array:

'Calendar'        => 'Gloudemans\Calendar\Facades\Calendar',

Now you're ready to start using the calendar package in your application.


You can use the generate method to generate a calendar.

// Generate a calendar for the current month and year

// Generate a calendar for the specified year and month
Calendar::generate(2012, 6);

// Add an array of events as the third parameter to add them to the calendar, 
// keys should be the days of the month.
$data = array(
	3  => '',
	7  => '',
	13 => '',
	26 => ''

Calendar::generate(2006, 6, $data);

There are a few config variables you can set to change the layout of the calendar:

Preference Default Value Options Description
template None None A string containing your calendar template. See the template section below.
local_time time() None A Unix timestamp corresponding to the current time.
start_day sunday Any week day (sunday, monday, tuesday, etc.) Sets the day of the week the calendar should start on.
month_type long long, short Determines what version of the month name to use in the header. long = January, short = Jan.
day_type abr long, short, abr Determines what version of the weekday names to use in the column headers. long = Sunday, short = Sun, abr = Su.
show_next_prev false true/false Determines whether to display links allowing you to toggle to next/previous months. See information on this feature below.
segments false true/false Default the next/prev link will use a query string, if you set this var to true, URI segments will be used

You can set these values using the initialize method

$config = array(
	'start_day' => 'monday',
	'month_type' => 'long'



You can also change the template used for the calendar.

$template = '
   {table_open}<table border="0" cellpadding="0" cellspacing="0">{/table_open}


   {heading_previous_cell}<th><a href="{previous_url}">&lt;&lt;</a></th>{/heading_previous_cell}
   {heading_title_cell}<th colspan="{colspan}">{heading}</th>{/heading_title_cell}
   {heading_next_cell}<th><a href="{next_url}">&gt;&gt;</a></th>{/heading_next_cell}




   {cal_cell_content}<a href="{content}">{day}</a>{/cal_cell_content}
   {cal_cell_content_today}<div class="highlight"><a href="{content}">{day}</a></div>{/cal_cell_content_today}

   {cal_cell_no_content_today}<div class="highlight">{day}</div>{/cal_cell_no_content_today}




Calendar::initialize(array('template' => $template));

echo Calendar::generate();