Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 898949fb14901bf0ab2c539e799c3efbc7cd0361 / . / user_guide / helpers / smiley_helper.html
blob: 18df9876f597f90ad33b5842e2f208cfdb98a317 [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3<head>
4
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<title>Smiley Helper : CodeIgniter User Guide</title>
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
11<script type="text/javascript" src="../nav/nav.js"></script>
12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
13<script type="text/javascript" src="../nav/moo.fx.js"></script>
14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
15
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='ExpressionEngine Dev Team' />
20<meta name='description' content='CodeIgniter User Guide' />
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_darker.jpg" width="154" height="43" 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 Jones8917af72010-03-05 12:41:45 -0600[diff] [blame]31<td><h1>CodeIgniter User Guide Version 2.0.0</h1></td>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
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">
43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Smiley Helper
46</td>
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>
48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58
59<h1>Smiley Helper</h1>
60
61<p>The Smiley Helper file contains functions that let you manage smileys (emoticons).</p>
62
63
64<h2>Loading this Helper</h2>
65
66<p>This helper is loaded using the following code:</p>
67<code>$this->load->helper('smiley');</code>
68
69<h2>Overview</h2>
70
71<p>The Smiley helper has a renderer that takes plain text simileys, like <dfn>:-)</dfn> and turns
72them into a image representation, like <img src="../images/smile.gif" width="19" height="19" border="0" alt="smile!" /></p>
73
74<p>It also lets you display a set of smiley images that when clicked will be inserted into a form field.
75For example, if you have a blog that allows user commenting you can show the smileys next to the comment form.
76Your users can click a desired smiley and with the help of some JavaScript it will be placed into the form field.</p>
77
78
79
80<h2>Clickable Smileys Tutorial</h2>
81
82<p>Here is an example demonstrating how you might create a set of clickable smileys next to a form field. This example
83requires that you first download and install the smiley images, then create a controller and the View as described.</p>
84
85<p class="important"><strong>Important:</strong> Before you begin, please <a href="http://codeigniter.com/download_files/smileys.zip">download the smiley images</a> and put them in
86a publicly accessible place on your server. This helper also assumes you have the smiley replacement array located at
87<dfn>application/config/smileys.php</dfn></p>
88
89
90<h3>The Controller</h3>
91
92<p>In your <dfn>application/controllers/</dfn> folder, create a file called <kbd>smileys.php</kbd> and place the code below in it.</p>
93
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]94<p><strong>Important:</strong> Change the URL in the <dfn>get_clickable_smileys()</dfn> function below so that it points to
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]95your <dfn>smiley</dfn> folder.</p>
96
97<p>You'll notice that in addition to the smiley helper we are using the <a href="../libraries/table.html">Table Class</a>.</p>
98
99<textarea class="textarea" style="width:100%" cols="50" rows="25">
100&lt;?php
101
Greg Aker16fcb2e2010-11-09 13:53:07 -0600[diff] [blame]102class Smileys extends CI_Controller {
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]103
Pascal Krietea7056982010-11-10 16:12:55 -0500[diff] [blame]104 function __construct()
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]105 {
Pascal Krietea7056982010-11-10 16:12:55 -0500[diff] [blame]106 parent::__construct();
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]107 }
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]108
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]109 function index()
110 {
111 $this->load->helper('smiley');
112 $this->load->library('table');
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]113
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]114 $image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comments');
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]115
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]116 $col_array = $this->table->make_columns($image_array, 8);
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]117
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]118 $data['smiley_table'] = $this->table->generate($col_array);
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]119
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]120 $this->load->view('smiley_view', $data);
121 }
Barry Mienydd671972010-10-04 16:33:58 +0200[diff] [blame]122
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]123}
124?&gt;
125</textarea>
126
127<p>In your <dfn>application/views/</dfn> folder, create a file called <kbd>smiley_view.php</kbd> and place this code in it:</p>
128
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]129<textarea class="textarea" style="width:100%" cols="50" rows="20">
130&lt;html>
131&lt;head>
132&lt;title>Smileys&lt;/title>
133
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]134&lt;?php echo smiley_js(); ?>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]135
136&lt;/head>
137&lt;body>
138
139&lt;form name="blog">
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]140&lt;textarea name="comments" id="comments" cols="40" rows="4">&lt;/textarea>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]141&lt;/form>
142
143&lt;p>Click to insert a smiley!&lt;/p>
144
145&lt;?php echo $smiley_table; ?>
146
147&lt;/body>
148&lt;/html>
149</textarea>
150
151
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]152<p>When you have created the above controller and view, load it by visiting <dfn>http://www.example.com/index.php/smileys/</dfn></p>
153
154
155<h3>Field Aliases</h3>
156
157<p>When making changes to a view it can be inconvenient to have the field id in the controller. To work around this,
158you can give your smiley links a generic name that will be tied to a specific id in your view.</p>
159<code>$image_array = get_smiley_links("http://example.com/images/smileys/", "comment_textarea_alias");</code>
160
161<p>To map the alias to the field id, pass them both into the smiley_js function:</p>
162<code>$image_array = smiley_js("comment_textarea_alias", "comments");</code>
163
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]164
165<h1>Function Reference</h1>
166
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]167<h2>get_clickable_smileys()</h2>
168
169<p>Returns an array containing your smiley images wrapped in a clickable link. You must supply the URL to your smiley folder
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]170and a field id or field alias.</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]171
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]172<code>$image_array = get_smiley_links("http://example.com/images/smileys/", "comment");</code>
173<p class="important">Note: Usage of this function without the second parameter, in combination with js_insert_smiley has been deprecated.</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]174
175
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]176<h2>smiley_js()</h2>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]177
178<p>Generates the JavaScript that allows the images to be clicked and inserted into a form field.
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]179If you supplied an alias instead of an id when generating your smiley links, you need to pass the
180alias and corresponding form id into the function.
181This function is designed to be placed into the &lt;head&gt; area of your web page.</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]182
Pascal Krietede8f4092009-07-29 13:46:37 +0000[diff] [blame]183<code>&lt;?php echo smiley_js(); ?&gt;</code>
184<p class="important">Note: This function replaces js_insert_smiley, which has been deprecated.</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]185
186
187<h2>parse_smileys()</h2>
188
189<p>Takes a string of text as input and replaces any contained plain text smileys into the image
190equivalent. The first parameter must contain your string, the second must contain the URL to your smiley folder:</p>
191
192<code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]193$str = 'Here are some simileys: :-) ;-)';
194
195$str = parse_smileys($str, "http://example.com/images/smileys/");
196
197echo $str;
198</code>
199</div>
200<!-- END CONTENT -->
201
202
203<div id="footer">
204<p>
205Previous Topic:&nbsp;&nbsp;<a href="security_helper.html">Security Helper</a>
206&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
207<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
208<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
209Next Topic:&nbsp;&nbsp;<a href="string_helper.html">String Helper</a>
210</p>
Derek Jones898949f2011-01-28 07:42:16 -0600[diff] [blame^]211<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]212</div>
213
214</body>
Derek Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame]215</html>