From a21c4ef573c1c1c0c8de6b19785962558a0fa550 Mon Sep 17 00:00:00 2001 From: admin Date: Sat, 28 Oct 2006 18:36:49 +0000 Subject: --- user_guide/helpers/smiley_helper.html | 208 ++++++++++++++++++++++++++++++++++ 1 file changed, 208 insertions(+) create mode 100644 user_guide/helpers/smiley_helper.html (limited to 'user_guide/helpers/smiley_helper.html') diff --git a/user_guide/helpers/smiley_helper.html b/user_guide/helpers/smiley_helper.html new file mode 100644 index 000000000..de847957e --- /dev/null +++ b/user_guide/helpers/smiley_helper.html @@ -0,0 +1,208 @@ + + + + +Code Igniter User Guide + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

Code Igniter User Guide Version 1.5.0

+
+ + + + + + + + + +
+ + +
+ + + +
+ + +

Smiley Helper

+ +

The Smiley Helper file contains functions that let you manage smileys (emoticons).

+ + +

Loading this Helper

+ +

This helper is loaded using the following code:

+$this->load->helper('smiley'); + +

Overview

+ +

The Smiley helper has a renderer that takes plain text simileys, like :-) and turns +them into a image representation, like smile!

+ +

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.

+ + + +

Clickable Smileys Tutorial

+ +

Here is an example demonstrating how you might create a set of clickale 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.

+ +

Important: Before you begin, please download the smiley images and put them in +a publicly accessible place on your server. This helper also assumes you have the smiley replacement array located at +application/config/smileys.php

+ + +

The Controller

+ +

In your application/controllers/ folder, create a file called smileys.php and place the code below in it.

+ +

Important: Change the URL in the get_clickable_smileys() function below so that it points to +your smiley folder.

+ +

You'll notice that in addition to the smiley helper we are using the Table Class.

+ + + +

In your application/views/ folder, create a file called smiley_view.php and place this code in it:

+ + + + + +

When you have created the above controller and view, load it by visiting http://www.your=site.com/index.php/smileys/

+ +

Function Reference

+ + +

get_clickable_smileys()

+ +

Returns an array containing your smiley images wrapped in a cliackable link. You must supply the URL to your smiley folder +via the first parameter:

+ +$image_array = get_clickable_smileys("http://www.your-site.com/images/smileys/"); + + +

js_insert_smiley()

+ +

Generates the JavaScript that allows the images to be clicked and inserted into a form field. +The first parameter must contain the name of your form, the second parameter must contain the name of the +form field. This function is designed to be placed into the <head> area of your web page.

+ +<?php echo js_insert_smiley('blog', 'comments'); ?> + + +

parse_smileys()

+ +

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 the URL to your smiley folder:

+ + + +$str = 'Here are some simileys: :-) ;-)'; + +$str = parse_smileys($str, "http://www.your-site.com/images/smileys/"); + +echo $str; + +
+ + + + + + + \ No newline at end of file -- cgit v1.2.3-24-g4f1b