Blame - user_guide/libraries/calendar.html - code-igniter-v3-giggi

<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.codeigniter.com/user_guide/" />Search User Guide  <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>

53

</tr>

54

</table>

55

<h1>Calendaring Class</h1>

67

68

<p>The Calendar class enables you to dynamically create calendars. Your calendars can be formatted through the use of a calendar

69

template, allowing 100% control over every aspect of its design. In addition, you can pass data to your calendar cells.</p>

70

71

<h2>Initializing the Class</h2>

72

73

<p>Like most other classes in Code Igniter, the Calendar class is initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>

74

75

<code>$this->load->library('calendar');</code>

76

<p>Once loaded, the Calendar object will be available using: <dfn>$this->calendar</dfn></p>

77

78

79

<h2>Displaying a Calendar</h2>

80

81

<p>Here is a very simple example showing how you can display a calendar:</p>

82

83

<code>$this->load->library('calendar');<br />

84

<br />

85

echo $this->calendar->generate();</code>

86

87

<p>The above code will generate a calendar for the current month/year based on your server time.

88

To show a calendar for a specific month and year you will pass this information to the calendar generating function:</p>

89

90

<code>$this->load->library('calendar');<br />

91

<br />

92

echo $this->calendar->generate(<kbd>2006</kbd>, <kbd>6</kbd>);</code>

93

94

<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>

95

96

<h2>Passing Data to your Calendar Cells</h2>

97

98

<p>To add data to your calendar cells involves creating an associative array in which the keys correspond to the days

99

you wish to populate and the array value contains the data. The array is passed to the third parameter of the calendar

100

generating function. Consider this example:</p>

101

102

<code>$this->load->library('calendar');<br />

103

<br />

104

$data = array(<br />

105

               3  => 'http://your-site.com/news/article/2006/03/',<br />

106

               7  => 'http://your-site.com/news/article/2006/07/',<br />

107

               13 => 'http://your-site.com/news/article/2006/13/',<br />

108

               26 => 'http://your-site.com/news/article/2006/26/'<br />

109

             );<br />

110

<br />

111

echo $this->calendar->generate(<kbd>2006</kbd>, <kbd>6</kbd>, <var>$data</var>);</code>

112

113

<p>Using the above example, day numbers 3, 7, 13, and 26 will become links pointing to the URLs you've provided.</p>

114

115

<p class="important"><strong>Note:</strong> By default it is assumed that your array will contain links.

116

In the section that explains the calendar template below you'll see how you can customize

117

how data passed to your cells is handled so you can pass different types of information.</p>

118

119

120

<h2>Setting Display Preferences</h2>

121

122

<p>There are seven preferences you can set to control various aspects of the calendar. Preferences are set using an initialization

123

function similar to other classes. Here is an example:

124

125

126

<code>$this->load->library('calendar');<br />

127

<br />

128

$prefs = array (<br />

129

               'start_day'    => 'saturday',<br />

130

               'month_type'   => 'long',<br />

131

               'day_type'     => 'short'<br />

132

             );<br />

133

<br />

134

$this->calendar->initialize($prefs);<br />

135

<br />

136

echo $this->calendar->generate();</code>

137

138

<p>The above code would start the calendar on saturday, use the "long" month heading, and the "short" day names. More information

139

regarding preferences below.</p>

<tr>

<th>Preference</th>

<th>Default Value</th>

<th>Options</th>

<th>Description</th>

</tr><tr>

<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>

152

</tr><tr>

153

<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>

154

</tr><tr>

155

<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>

156

</tr><tr>

157

<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>

158

</tr><tr>

159

<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>

160

</tr><tr>

161

<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>

162

</tr><tr>

163

<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>

</tr>

</table>

<h2>Creating a Calendar Template</h2>

171

172

<p>By creating a calendar template you have 100% control over the design of your calendar. Each component of your

173

calendar will be placed within a pair of pseudo-variables as shown here:</p>

174

175

176

<code>$this->load->library('calendar');<br /><br />

177

$prefs['template'] = '<br /><br />

178

   <dfn>{table_open}</dfn><var><table border="0" cellpadding="0" cellspacing="0"></var><dfn>{/table_open}</dfn><br />

179

<br />

180

   <dfn>{heading_row_start}</dfn><var><tr></var><dfn>{/heading_row_start}</dfn><br />

181

<br />

182

   <dfn>{heading_previous_cell}</dfn><var><th><a href="</var><kbd>{previous_url}</kbd><var>">&lt;&lt;</a></th></var><dfn>{/heading_previous_cell}</dfn><br />

183

   <dfn>{heading_title_cell}</dfn><var><th colspan="</var><kbd>{colspan}</kbd><var>"></var><kbd>{heading}</kbd><var></th></var><dfn>{/heading_title_cell}</dfn><br />

184

   <dfn>{heading_next_cell}</dfn><var><th><a href="</var><kbd>{next_url}</kbd><var>">&gt;&gt;</a></th></var><dfn>{/heading_next_cell}</dfn><br />

185

<br />

186

   <dfn>{heading_row_end}</dfn><var></tr></var><dfn>{/heading_row_end}</dfn><br />

187

<br />

188

   <dfn>{week_row_start}</dfn><var><tr></var><dfn>{/week_row_start}</dfn><br />

<br />

   <dfn>{cal_row_start}</dfn><var><tr></var><dfn>{/cal_row_start}</dfn><br />

193

   <dfn>{cal_cell_start}</dfn><var><td></var><dfn>{/cal_cell_start}</dfn><br />

194

<br />

195

   <dfn>{cal_cell_content}</dfn><var><a href="</var><kbd>{content}</kbd><var>"></var><kbd>{day}</kbd><var></a></var><dfn>{/cal_cell_content}</dfn><br />

196

   <dfn>{cal_cell_content_today}</dfn><var><div class="highlight"><a href="</var><kbd>{content}</kbd><var>"></var><kbd>{day}</kbd><var></a></div></var><dfn>{/cal_cell_content_today}</dfn><br />

197

<br />

198

   <dfn>{cal_cell_no_content}</dfn><var></var><kbd>{day}</kbd><var></var><dfn>{/cal_cell_no_content}</dfn><br />

199

   <dfn>{cal_cell_no_content_today}</dfn><var><div class="highlight"></var><kbd>{day}</kbd><var></div></var><dfn>{/cal_cell_no_content_today}</dfn><br />

200

<br />

201

   <dfn>{cal_cell_blank}</dfn><var>&nbsp;</var><dfn>{/cal_cell_blank}</dfn><br />

202

<br />

203

admin

c1fa074

2006-09-21 23:50:23 +0000

[diff] [blame]

204

admin

b0dd10f

2006-08-25 17:25:49 +0000

[diff] [blame]

205

<br />

206

   <dfn>{table_close}</dfn><var></table></var><dfn>{/table_close}</dfn><br />

207

';<br />

208

<br />

209

$this->calendar->initialize($prefs);<br />

210

<br />

211

echo $this->calendar->generate();</code>

<h2>Showing Next/Previous Month Links</h2>

216

217

<p>To allow your calendar to dynamically increment/decrement via the next/previous links requires that you set up your calendar

218

code similar to this example:</p>

219

220

221

<code>$this->load->library('calendar');<br />

222

<br />

223

$prefs = array (<br />

224

               'show_next_prev'  => TRUE,<br />

225

               'next_prev_url'   => 'http://www.your-site.com/index.php/calendar/show/'<br />

226

             );<br />

227

<br />

228

$this->calendar->initialize($prefs);<br />

229

<br />

230

echo $this->calendar->generate(<var>$this->uri->segment(3)</var>, <var>$this->uri->segment(4)</var>);</code>

231

232

<p>You'll notice a few things about the above example:</p>

<ul>

<li>You must supply the URL to the controller containing your calendar in the "next_prev_url" preference.</li>

237

<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>

</ul>

</div>