CodeIgniter v3.0.0 API
\

\CI_Calendar

CodeIgniter Calendar Class

This class enables the creation of calendars

Summary

Methods
Properties
Constants
__construct()
initialize()
generate()
get_month_name()
get_day_names()
adjust_date()
get_total_days()
default_template()
parse_template()
$template
$replacements
$start_day
$month_type
$day_type
$show_next_prev
$next_prev_url
$show_other_days
No constants found
No protected methods found
$CI
N/A
No private methods found
No private properties found
N/A

Properties

$template

$template : mixed

Calendar layout template

Type

mixed

$replacements

$replacements : array

Replacements array for template

Type

array

$start_day

$start_day : string

Day of the week to start the calendar on

Type

string

$month_type

$month_type : string

How to display months

Type

string

$day_type

$day_type : string

How to display names of days

Type

string

$show_next_prev

$show_next_prev : boolean

Whether to show next/prev month links

Type

boolean

$next_prev_url

$next_prev_url : boolean

Url base to use for next/prev month links

Type

boolean

$show_other_days

$show_other_days : boolean

Show days of other months

Type

boolean

$CI

$CI : object

CI Singleton

Type

object

Methods

__construct()

__construct(array  $config = array()) : void

Class constructor

Loads the calendar language file and sets the default time reference.

Parameters

array $config

Calendar options

initialize()

initialize(  $config = array()) : \CI_Calendar

Initialize the user preferences

Accepts an associative array as input, containing display preferences

Parameters

$config

Returns

\CI_Calendar

generate()

generate(  $year = '',   $month = '',   $data = array()) : string

Generate the calendar

Parameters

$year
$month
$data

Returns

string

get_month_name()

get_month_name(  $month) : string

Get Month Name

Generates a textual month name based on the numeric month provided.

Parameters

$month

Returns

string

get_day_names()

get_day_names(  $day_type = '') : array

Get Day Names

Returns an array of day names (Sunday, Monday, etc.) based on the type. Options: long, short, abr

Parameters

$day_type

Returns

array

adjust_date()

adjust_date(  $month,   $year) : array

Adjust Date

This function makes sure that we have a valid month/year. For example, if you submit 13 as the month, the year will increment and the month will become January.

Parameters

$month
$year

Returns

array

get_total_days()

get_total_days(  $month,   $year) : integer

Total days in a given month

Parameters

$month
$year

Returns

integer

default_template()

default_template() : array

Set Default Template Data

This is used in the event that the user has not created their own template

Returns

array

parse_template()

parse_template() : \CI_Calendar

Parse Template

Harvests the data within the template {pseudo-variables} used to display the calendar

Returns

\CI_Calendar