diff options
| author | Kyle Farris <kylefarris@kylefarris.gotdns.org> | 2011-10-14 21:43:25 +0200 |
|---|---|---|
| committer | Kyle Farris <kylefarris@kylefarris.gotdns.org> | 2011-10-14 21:43:25 +0200 |
| commit | ad17f4b932b3728c1e299b48f28b3ae0dbdd6b0b (patch) | |
| tree | fdb357433e76000bdef60c4d18e5ab0540b07aeb /user_guide/helpers/smiley_helper.html | |
| parent | db46d02ac23b8e0bc2416e197494d3b795b57530 (diff) | |
| parent | a2125a5d830fd390b4cf35f77e9bb0558cfa2dd7 (diff) | |
Merged with development
Diffstat (limited to 'user_guide/helpers/smiley_helper.html')
| -rw-r--r-- | user_guide/helpers/smiley_helper.html | 215 |
1 files changed, 0 insertions, 215 deletions
diff --git a/user_guide/helpers/smiley_helper.html b/user_guide/helpers/smiley_helper.html deleted file mode 100644 index 6f1fa5915..000000000 --- a/user_guide/helpers/smiley_helper.html +++ /dev/null @@ -1,215 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> -<head> - -<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<title>Smiley Helper : CodeIgniter User Guide</title> - -<style type='text/css' media='all'>@import url('../userguide.css');</style> -<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> - -<script type="text/javascript" src="../nav/nav.js"></script> -<script type="text/javascript" src="../nav/prototype.lite.js"></script> -<script type="text/javascript" src="../nav/moo.fx.js"></script> -<script type="text/javascript" src="../nav/user_guide_menu.js"></script> - -<meta http-equiv='expires' content='-1' /> -<meta http-equiv= 'pragma' content='no-cache' /> -<meta name='robots' content='all' /> -<meta name='author' content='ExpressionEngine Dev Team' /> -<meta name='description' content='CodeIgniter User Guide' /> - -</head> -<body> - -<!-- START NAVIGATION --> -<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> -<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> -<div id="masthead"> -<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> -<tr> -<td><h1>CodeIgniter User Guide Version 2.0.3</h1></td> -<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> -</tr> -</table> -</div> -<!-- END NAVIGATION --> - - -<!-- START BREADCRUMB --> -<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> -<tr> -<td id="breadcrumb"> -<a href="http://codeigniter.com/">CodeIgniter Home</a> › -<a href="../index.html">User Guide Home</a> › -Smiley Helper -</td> -<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 <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> -</tr> -</table> -<!-- END BREADCRUMB --> - -<br clear="all" /> - - -<!-- START CONTENT --> -<div id="content"> - - -<h1>Smiley Helper</h1> - -<p>The Smiley Helper file contains functions that let you manage smileys (emoticons).</p> - - -<h2>Loading this Helper</h2> - -<p>This helper is loaded using the following code:</p> -<code>$this->load->helper('smiley');</code> - -<h2>Overview</h2> - -<p>The Smiley helper has a renderer that takes plain text simileys, like <dfn>:-)</dfn> and turns -them into a image representation, like <img src="../images/smile.gif" width="19" height="19" border="0" alt="smile!" /></p> - -<p>It also lets you display a set of smiley images that when clicked will be inserted into a form field. -For example, if you have a blog that allows user commenting you can show the smileys next to the comment form. -Your users can click a desired smiley and with the help of some JavaScript it will be placed into the form field.</p> - - - -<h2>Clickable Smileys Tutorial</h2> - -<p>Here is an example demonstrating how you might create a set of clickable smileys next to a form field. This example -requires that you first download and install the smiley images, then create a controller and the View as described.</p> - -<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 -a publicly accessible place on your server. This helper also assumes you have the smiley replacement array located at -<dfn>application/config/smileys.php</dfn></p> - - -<h3>The Controller</h3> - -<p>In your <dfn>application/controllers/</dfn> folder, create a file called <kbd>smileys.php</kbd> and place the code below in it.</p> - -<p><strong>Important:</strong> Change the URL in the <dfn>get_clickable_smileys()</dfn> function below so that it points to -your <dfn>smiley</dfn> folder.</p> - -<p>You'll notice that in addition to the smiley helper we are using the <a href="../libraries/table.html">Table Class</a>.</p> - -<textarea class="textarea" style="width:100%" cols="50" rows="25"> -<?php - -class Smileys extends CI_Controller { - - function __construct() - { - parent::__construct(); - } - - function index() - { - $this->load->helper('smiley'); - $this->load->library('table'); - - $image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comments'); - - $col_array = $this->table->make_columns($image_array, 8); - - $data['smiley_table'] = $this->table->generate($col_array); - - $this->load->view('smiley_view', $data); - } - -} -?> -</textarea> - -<p>In your <dfn>application/views/</dfn> folder, create a file called <kbd>smiley_view.php</kbd> and place this code in it:</p> - -<textarea class="textarea" style="width:100%" cols="50" rows="20"> -<html> -<head> -<title>Smileys</title> - -<?php echo smiley_js(); ?> - -</head> -<body> - -<form name="blog"> -<textarea name="comments" id="comments" cols="40" rows="4"></textarea> -</form> - -<p>Click to insert a smiley!</p> - -<?php echo $smiley_table; ?> - -</body> -</html> -</textarea> - - -<p>When you have created the above controller and view, load it by visiting <dfn>http://www.example.com/index.php/smileys/</dfn></p> - - -<h3>Field Aliases</h3> - -<p>When making changes to a view it can be inconvenient to have the field id in the controller. To work around this, -you can give your smiley links a generic name that will be tied to a specific id in your view.</p> -<code>$image_array = get_smiley_links("http://example.com/images/smileys/", "comment_textarea_alias");</code> - -<p>To map the alias to the field id, pass them both into the smiley_js function:</p> -<code>$image_array = smiley_js("comment_textarea_alias", "comments");</code> - - -<h1>Function Reference</h1> - -<h2>get_clickable_smileys()</h2> - -<p>Returns an array containing your smiley images wrapped in a clickable link. You must supply the URL to your smiley folder -and a field id or field alias.</p> - -<code>$image_array = get_smiley_links("http://example.com/images/smileys/", "comment");</code> -<p class="important">Note: Usage of this function without the second parameter, in combination with js_insert_smiley has been deprecated.</p> - - -<h2>smiley_js()</h2> - -<p>Generates the JavaScript that allows the images to be clicked and inserted into a form field. -If you supplied an alias instead of an id when generating your smiley links, you need to pass the -alias and corresponding form id into the function. -This function is designed to be placed into the <head> area of your web page.</p> - -<code><?php echo smiley_js(); ?></code> -<p class="important">Note: This function replaces js_insert_smiley, which has been deprecated.</p> - - -<h2>parse_smileys()</h2> - -<p>Takes a string of text as input and replaces any contained plain text smileys into the image -equivalent. The first parameter must contain your string, the second must contain the URL to your smiley folder:</p> - -<code> -$str = 'Here are some simileys: :-) ;-)'; - -$str = parse_smileys($str, "http://example.com/images/smileys/"); - -echo $str; -</code> -</div> -<!-- END CONTENT --> - - -<div id="footer"> -<p> -Previous Topic: <a href="security_helper.html">Security Helper</a> - · -<a href="#top">Top of Page</a> · -<a href="../index.html">User Guide Home</a> · -Next Topic: <a href="string_helper.html">String Helper</a> -</p> -<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2011 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> -</div> - -</body> -</html>
\ No newline at end of file |