Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 68d7bd62840b1154a4a6d9b5caa41cbdd73a851a / . / user_guide / libraries / calendar.html
blob: 22c55674b665cd2969d54c0832fc0e881ed181f9 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Derek Allardafd99ac2008-01-19 19:59:14 +0000[diff] [blame]2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]3<head>
4
Derek Allard8039d4c2008-05-31 02:47:56 +0000[diff] [blame]5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Derek Jonesfd93d222008-05-06 15:18:50 +0000[diff] [blame]6<title>Calendaring Class : CodeIgniter User Guide</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]7
8<style type='text/css' media='all'>@import url('../userguide.css');</style>
9<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]11<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]13<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]15
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
Derek Allard3d879d52008-01-18 19:41:32 +0000[diff] [blame]19<meta name='author' content='ExpressionEngine Dev Team' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Jones1ca3fc42008-06-27 00:19:33 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.6.3</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
Derek Jones7a9193a2008-01-21 18:39:20 +0000[diff] [blame]43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Calendaring Class
46</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]47<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58
59
60
61<h1>Calendaring Class</h1>
62
admine334c472006-10-21 19:44:22 +0000[diff] [blame]63<p>The Calendar class enables you to dynamically create calendars. Your calendars can be formatted through the use of a calendar
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]64template, allowing 100% control over every aspect of its design. In addition, you can pass data to your calendar cells.</p>
65
66<h2>Initializing the Class</h2>
67
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]68<p>Like most other classes in CodeIgniter, the Calendar class is initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]69
70<code>$this->load->library('calendar');</code>
71<p>Once loaded, the Calendar object will be available using: <dfn>$this->calendar</dfn></p>
72
73
74<h2>Displaying a Calendar</h2>
75
76<p>Here is a very simple example showing how you can display a calendar:</p>
77
78<code>$this->load->library('calendar');<br />
79<br />
80echo $this->calendar->generate();</code>
81
82<p>The above code will generate a calendar for the current month/year based on your server time.
83To show a calendar for a specific month and year you will pass this information to the calendar generating function:</p>
84
85<code>$this->load->library('calendar');<br />
86<br />
87echo $this->calendar->generate(<kbd>2006</kbd>, <kbd>6</kbd>);</code>
88
89<p>The above code will generate a calendar showing the month of June in 2006. The first parameter specifies the year, the second parameter specifies the month.</p>
90
91<h2>Passing Data to your Calendar Cells</h2>
92
93<p>To add data to your calendar cells involves creating an associative array in which the keys correspond to the days
94you wish to populate and the array value contains the data. The array is passed to the third parameter of the calendar
95generating function. Consider this example:</p>
96
97<code>$this->load->library('calendar');<br />
98<br />
99$data = array(<br />
Derek Jonesff845f92008-06-26 17:05:55 +0000[diff] [blame]100&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;3&nbsp; => 'http://example.com/news/article/2006/03/',<br />
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;7&nbsp; => 'http://example.com/news/article/2006/07/',<br />
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;13 => 'http://example.com/news/article/2006/13/',<br />
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;26 => 'http://example.com/news/article/2006/26/'<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);<br />
105<br />
106echo $this->calendar->generate(<kbd>2006</kbd>, <kbd>6</kbd>, <var>$data</var>);</code>
107
108<p>Using the above example, day numbers 3, 7, 13, and 26 will become links pointing to the URLs you've provided.</p>
109
admine334c472006-10-21 19:44:22 +0000[diff] [blame]110<p class="important"><strong>Note:</strong> By default it is assumed that your array will contain links.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]111In the section that explains the calendar template below you'll see how you can customize
112how data passed to your cells is handled so you can pass different types of information.</p>
113
114
115<h2>Setting Display Preferences</h2>
116
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]117<p>There are seven preferences you can set to control various aspects of the calendar. Preferences are set by passing an
118array of preferences in the second parameter of the loading function. Here is an example:</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]119
120
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]121<code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]122$prefs = array (<br />
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'start_day'&nbsp;&nbsp;&nbsp; => 'saturday',<br />
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'month_type'&nbsp;&nbsp; => 'long',<br />
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'day_type'&nbsp;&nbsp;&nbsp;&nbsp; => 'short'<br />
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);<br />
127<br />
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]128$this->load->library('calendar', $prefs);<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]129<br />
130echo $this->calendar->generate();</code>
131
132<p>The above code would start the calendar on saturday, use the "long" month heading, and the "short" day names. More information
133regarding preferences below.</p>
134
135
136
137
138<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
139<tr>
140<th>Preference</th>
141<th>Default&nbsp;Value</th>
142<th>Options</th>
143<th>Description</th>
144</tr><tr>
145<td class="td"><strong>template</strong></td><td class="td">None</td><td class="td">None</td><td class="td">A string containing your calendar template. See the template section below.</td>
146</tr><tr>
147<td class="td"><strong>local_time</strong></td><td class="td">time()</td><td class="td">None</td><td class="td">A Unix timestamp corresponding to the current time.</td>
148</tr><tr>
149<td class="td"><strong>start_day</strong></td><td class="td">sunday</td><td class="td">Any week day (sunday, monday, tuesday, etc.)</td><td class="td">Sets the day of the week the calendar should start on.</td>
150</tr><tr>
151<td class="td"><strong>month_type</strong></td><td class="td">long</td><td class="td">long, short</td><td class="td">Determines what version of the month name to use in the header. long = January, short = Jan.</td>
152</tr><tr>
153<td class="td"><strong>day_type</strong></td><td class="td">abr</td><td class="td">long, short, abr</td><td class="td">Determines what version of the weekday names to use in the column headers. long = Sunday, short = Sun, abr = Su.</td>
154</tr><tr>
155<td class="td"><strong>show_next_prev</strong></td><td class="td">FALSE</td><td class="td">TRUE/FALSE (boolean)</td><td class="td">Determines whether to display links allowing you to toggle to next/previous months. See information on this feature below.</td>
156</tr><tr>
157<td class="td"><strong>next_prev_url</strong></td><td class="td">None</td><td class="td">A URL</td><td class="td">Sets the basepath used in the next/previous calendar links.</td>
158</tr>
159</table>
160
161
162
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]163<h2>Showing Next/Previous Month Links</h2>
164
165<p>To allow your calendar to dynamically increment/decrement via the next/previous links requires that you set up your calendar
166code similar to this example:</p>
167
168
Derek Allard08e6b0c2007-08-23 01:04:53 +0000[diff] [blame]169<code>$prefs = array (<br />
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'show_next_prev'&nbsp;&nbsp;=> TRUE,<br />
Derek Jonesff845f92008-06-26 17:05:55 +0000[diff] [blame]171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'next_prev_url'&nbsp;&nbsp; => 'http://example.com/index.php/calendar/show/'<br />
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);<br />
173<br />
Derek Allard08e6b0c2007-08-23 01:04:53 +0000[diff] [blame]174$this-&gt;load-&gt;library('calendar', $prefs);<br />
175<br />
176echo $this->calendar->generate(<var>$this->uri->segment(3)</var>, <var>$this->uri->segment(4)</var>);</code>
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]177
178<p>You'll notice a few things about the above example:</p>
179
180<ul>
181<li>You must set the "show_next_prev" to TRUE.</li>
182<li>You must supply the URL to the controller containing your calendar in the "next_prev_url" preference.</li>
183<li>You must supply the "year" and "month" to the calendar generating function via the URI segments where they appear (Note: The calendar class automatically adds the year/month to the base URL you provide.).</li>
184</ul>
185
186
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]187
188<h2>Creating a Calendar Template</h2>
189
190<p>By creating a calendar template you have 100% control over the design of your calendar. Each component of your
191calendar will be placed within a pair of pseudo-variables as shown here:</p>
192
193
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]194<code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]195$prefs['template'] = '<br /><br />
196&nbsp;&nbsp;&nbsp;<dfn>{table_open}</dfn><var>&lt;table border="0" cellpadding="0" cellspacing="0"></var><dfn>{/table_open}</dfn><br />
197<br />
198&nbsp;&nbsp;&nbsp;<dfn>{heading_row_start}</dfn><var>&lt;tr></var><dfn>{/heading_row_start}</dfn><br />
199<br />
200&nbsp;&nbsp;&nbsp;<dfn>{heading_previous_cell}</dfn><var>&lt;th>&lt;a href="</var><kbd>{previous_url}</kbd><var>">&amp;lt;&amp;lt;&lt;/a>&lt;/th></var><dfn>{/heading_previous_cell}</dfn><br />
201&nbsp;&nbsp;&nbsp;<dfn>{heading_title_cell}</dfn><var>&lt;th colspan="</var><kbd>{colspan}</kbd><var>"></var><kbd>{heading}</kbd><var>&lt;/th></var><dfn>{/heading_title_cell}</dfn><br />
202&nbsp;&nbsp;&nbsp;<dfn>{heading_next_cell}</dfn><var>&lt;th>&lt;a href="</var><kbd>{next_url}</kbd><var>">&amp;gt;&amp;gt;&lt;/a>&lt;/th></var><dfn>{/heading_next_cell}</dfn><br />
203<br />
204&nbsp;&nbsp;&nbsp;<dfn>{heading_row_end}</dfn><var>&lt;/tr></var><dfn>{/heading_row_end}</dfn><br />
205<br />
206&nbsp;&nbsp;&nbsp;<dfn>{week_row_start}</dfn><var>&lt;tr></var><dfn>{/week_row_start}</dfn><br />
207&nbsp;&nbsp;&nbsp;<dfn>{week_day_cell}</dfn><var>&lt;td></var><dfn>{week_day}</dfn><var>&lt;/td></var><dfn>{/week_day_cell}</dfn><br />
208&nbsp;&nbsp;&nbsp;<dfn>{week_row_end}</dfn><var>&lt;/tr></var><dfn>{/week_row_end}</dfn><br />
209<br />
210&nbsp;&nbsp;&nbsp;<dfn>{cal_row_start}</dfn><var>&lt;tr></var><dfn>{/cal_row_start}</dfn><br />
211&nbsp;&nbsp;&nbsp;<dfn>{cal_cell_start}</dfn><var>&lt;td></var><dfn>{/cal_cell_start}</dfn><br />
212<br />
213&nbsp;&nbsp;&nbsp;<dfn>{cal_cell_content}</dfn><var>&lt;a href="</var><kbd>{content}</kbd><var>"></var><kbd>{day}</kbd><var>&lt;/a></var><dfn>{/cal_cell_content}</dfn><br />
214&nbsp;&nbsp;&nbsp;<dfn>{cal_cell_content_today}</dfn><var>&lt;div class="highlight">&lt;a href="</var><kbd>{content}</kbd><var>"></var><kbd>{day}</kbd><var>&lt;/a>&lt;/div></var><dfn>{/cal_cell_content_today}</dfn><br />
215<br />
216&nbsp;&nbsp;&nbsp;<dfn>{cal_cell_no_content}</dfn><var></var><kbd>{day}</kbd><var></var><dfn>{/cal_cell_no_content}</dfn><br />
217&nbsp;&nbsp;&nbsp;<dfn>{cal_cell_no_content_today}</dfn><var>&lt;div class="highlight"></var><kbd>{day}</kbd><var>&lt;/div></var><dfn>{/cal_cell_no_content_today}</dfn><br />
218<br />
219&nbsp;&nbsp;&nbsp;<dfn>{cal_cell_blank}</dfn><var>&amp;nbsp;</var><dfn>{/cal_cell_blank}</dfn><br />
220<br />
221&nbsp;&nbsp;&nbsp;<dfn>{cal_cell_end}</dfn><var>&lt;/td></var><dfn>{/cal_cell_end}</dfn><br />
adminc1fa0742006-09-21 23:50:23 +0000[diff] [blame]222&nbsp;&nbsp;&nbsp;<dfn>{cal_row_end}</dfn><var>&lt;/tr></var><dfn>{/cal_row_end}</dfn><br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]223<br />
224&nbsp;&nbsp;&nbsp;<dfn>{table_close}</dfn><var>&lt;/table></var><dfn>{/table_close}</dfn><br />
225';<br />
226<br />
adminb93464d2006-10-31 00:36:32 +0000[diff] [blame]227$this->load->library('calendar', $prefs);<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]228<br />
229echo $this->calendar->generate();</code>
230
231
232
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]233</div>
234<!-- END CONTENT -->
235
236
237<div id="footer">
238<p>
239Previous Topic:&nbsp;&nbsp;<a href="benchmark.html">Benchmarking Class</a>
240&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
241<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
242<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
243Next Topic:&nbsp;&nbsp;<a href="config.html">Config Class</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]244</p>
Derek Jones07870432008-02-13 03:49:26 +0000[diff] [blame]245<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]246</div>
247
248</body>
249</html>