Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 72daa197768f5ff86e009ff7afc171da21adc8db / . / user_guide_src / source / helpers / smiley_helper.rst
blob: b98084089af659dd7d4a7ed3bfcbb4ce7cc85407 [file] [log] [blame]
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]1#############
2Smiley Helper
3#############
4
5The Smiley Helper file contains functions that let you manage smileys
6(emoticons).
7
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]8.. contents::
9 :local:
10
11.. raw:: html
12
13 <div class="custom-index container"></div>
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]14
15Loading this Helper
16===================
17
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]18This helper is loaded using the following code::
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]19
20 $this->load->helper('smiley');
21
22Overview
23========
24
vlakoff2efd1f22013-08-06 17:31:48 +0200[diff] [blame]25The Smiley helper has a renderer that takes plain text smileys, like
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]26:-) and turns them into a image representation, like |smile!|
27
28It also lets you display a set of smiley images that when clicked will
29be inserted into a form field. For example, if you have a blog that
30allows user commenting you can show the smileys next to the comment
31form. Your users can click a desired smiley and with the help of some
32JavaScript it will be placed into the form field.
33
34Clickable Smileys Tutorial
35==========================
36
37Here is an example demonstrating how you might create a set of clickable
38smileys next to a form field. This example requires that you first
39download and install the smiley images, then create a controller and the
40View as described.
41
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]42.. important:: Before you begin, please `download the smiley images
Steven Crothersd2001232013-07-03 02:18:00 -0700[diff] [blame]43 <http://ellislab.com/asset/ci_download_files/smileys.zip>`_
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]44 and put them in a publicly accessible place on your server.
45 This helper also assumes you have the smiley replacement array
46 located at `application/config/smileys.php`
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]47
48The Controller
49--------------
50
vlakoff1c757802013-08-06 20:25:14 +0200[diff] [blame]51In your **application/controllers/** directory, create a file called
vlakoff2efd1f22013-08-06 17:31:48 +0200[diff] [blame]52Smileys.php and place the code below in it.
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]53
Derek Jones123bb202013-07-19 16:37:51 -0700[diff] [blame]54.. important:: Change the URL in the :func:`get_clickable_smileys()`
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]55 function below so that it points to your smiley folder.
56
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]57You'll notice that in addition to the smiley helper, we are also using
58the :doc:`Table Class <../libraries/table>`::
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]59
60 <?php
61
62 class Smileys extends CI_Controller {
63
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]64 public function index()
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]65 {
66 $this->load->helper('smiley');
67 $this->load->library('table');
68
69 $image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comments');
70 $col_array = $this->table->make_columns($image_array, 8);
71
72 $data['smiley_table'] = $this->table->generate($col_array);
73 $this->load->view('smiley_view', $data);
74 }
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]75
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]76 }
77
vlakoff1c757802013-08-06 20:25:14 +0200[diff] [blame]78In your **application/views/** folder, create a file called **smiley_view.php**
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]79and place this code in it::
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]80
81 <html>
82 <head>
83 <title>Smileys</title>
84 <?php echo smiley_js(); ?>
85 </head>
86 <body>
87 <form name="blog">
88 <textarea name="comments" id="comments" cols="40" rows="4"></textarea>
89 </form>
90 <p>Click to insert a smiley!</p>
91 <?php echo $smiley_table; ?> </body> </html>
92 When you have created the above controller and view, load it by visiting http://www.example.com/index.php/smileys/
93 </body>
94 </html>
95
96Field Aliases
97-------------
98
99When making changes to a view it can be inconvenient to have the field
100id in the controller. To work around this, you can give your smiley
101links a generic name that will be tied to a specific id in your view.
102
103::
104
105 $image_array = get_smiley_links("http://example.com/images/smileys/", "comment_textarea_alias");
106
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]107To map the alias to the field id, pass them both into the
Derek Jones123bb202013-07-19 16:37:51 -0700[diff] [blame]108:func:`smiley_js()` function::
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]109
110 $image_array = smiley_js("comment_textarea_alias", "comments");
111
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]112Available Functions
113===================
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]114
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]115.. function:: get_clickable_smileys($image_url[, $alias = ''[, $smileys = NULL]])
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]116
117 :param string $image_url: URL path to the smileys directory
118 :param string $alias: Field alias
Andrey Andreev3de130c2014-02-07 23:31:49 +0200[diff] [blame]119 :returns: An array of ready to use smileys
120 :rtype: array
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]121
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]122 Returns an array containing your smiley images wrapped in a clickable
123 link. You must supply the URL to your smiley folder and a field id or
124 field alias.
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]125
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]126 Example::
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]127
Andrey Andreev3de130c2014-02-07 23:31:49 +0200[diff] [blame]128 $image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comment');
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]129
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]130.. function:: smiley_js([$alias = ''[, $field_id = ''[, $inline = TRUE]]])
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]131
132 :param string $alias: Field alias
133 :param string $field_id: Field ID
134 :param bool $inline: Whether we're inserting an inline smiley
Andrey Andreev3de130c2014-02-07 23:31:49 +0200[diff] [blame]135 :returns: Smiley-enabling JavaScript code
136 :rtype: string
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]137
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]138 Generates the JavaScript that allows the images to be clicked and
139 inserted into a form field. If you supplied an alias instead of an id
140 when generating your smiley links, you need to pass the alias and
141 corresponding form id into the function. This function is designed to be
142 placed into the <head> area of your web page.
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]143
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]144 Example::
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]145
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]146 <?php echo smiley_js(); ?>
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]147
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]148.. function:: parse_smileys([$str = ''[, $image_url = ''[, $smileys = NULL]]])
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]149
150 :param string $str: Text containing smiley codes
151 :param string $image_url: URL path to the smileys directory
152 :param array $smileys: An array of smileys
Andrey Andreev3de130c2014-02-07 23:31:49 +0200[diff] [blame]153 :returns: Parsed smileys
154 :rtype: string
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]155
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]156 Takes a string of text as input and replaces any contained plain text
157 smileys into the image equivalent. The first parameter must contain your
158 string, the second must contain the URL to your smiley folder
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]159
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]160 Example::
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]161
vlakoff2efd1f22013-08-06 17:31:48 +0200[diff] [blame]162 $str = 'Here are some smileys: :-) ;-)';
Andrey Andreevea801ab2014-01-20 15:03:43 +0200[diff] [blame]163 $str = parse_smileys($str, 'http://example.com/images/smileys/');
Derek Jonesf33091f2013-07-19 16:44:19 -0700[diff] [blame]164 echo $str;
Derek Jones8ede1a22011-10-05 13:34:52 -0500[diff] [blame]165
Andrey Andreev53b8ef52012-11-08 21:38:53 +0200[diff] [blame]166.. |smile!| image:: ../images/smile.gif