Remove previously deprecated Smiley Helper

5 files changed, 14 insertions, 180 deletions

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index a61ad164b..4d0b4cf4d 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -21,6 +21,7 @@ Release Date: Not Released
    -  Removed previously deprecated :doc:`File Helper <helpers/file_helper>` function ``read_file()`` (use PHP's native ``file_get_contents()`` instead).
    -  Removed previously deprecated :doc:`Form Helper <helpers/form_helper>` function ``form_prep()`` (use :php:func:`html_escape()` instead).
    -  Removed previously deprecated *Email Helper* (had only two functions, aliases for PHP's native ``filter_var()`` and ``mail()``).
+   -  Removed previously deprecated *Smiley Helper*.
    -  Removed previously deprecated *Javascript Library* (it was always experimental in the first place).
 
 -  Libraries
@@ -561,7 +562,7 @@ Release Date: March 30, 2015
       - ``do_hash()`` now uses PHP's native ``hash()`` function (supporting more algorithms) and is deprecated.
       - :php:func:`strip_image_tags()` is now an alias for the same method in the :doc:`Security Library <libraries/security>`.
 
-   -  :doc:`Smiley Helper <helpers/smiley_helper>` changes include:
+   -  *Smiley Helper* changes include:
 
       - Deprecated the whole helper as too specific for CodeIgniter.
       - Removed previously deprecated function ``js_insert_smiley()``.
@@ -1850,7 +1851,7 @@ Hg Tag: v2.0.0
       string already has a scheme.
    -  Modified get_file_info in the file helper, changing filectime()
       to filemtime() for dates.
-   -  Modified smiley_js() to add optional third parameter to return
+   -  Modified ``smiley_js()`` to add optional third parameter to return
       only the javascript with no script tags.
    -  The img() function of the :doc:`HTML
       helper <./helpers/html_helper>` will now generate an empty
@@ -2005,7 +2006,7 @@ Hg Tag: v1.7.2
    -  Modified directory_map() in the :doc:`Directory
       helper <helpers/directory_helper>` to allow the inclusion of
       hidden files, and to return FALSE on failure to read directory.
-   -  Modified the :doc:`Smiley helper <helpers/smiley_helper>` to work
+   -  Modified the *Smiley helper* to work
       with multiple fields and insert the smiley at the last known
       cursor position.
 
@@ -3112,7 +3113,7 @@ Release Date: October 30, 2006
 -  Added :doc:`$this->db->platform() <./database/helpers>` function
 -  Added new :doc:`File Helper <./helpers/file_helper>`:
    get_filenames()
--  Added new helper: :doc:`Smiley Helper <./helpers/smiley_helper>`
+-  Added new helper: *Smiley Helper*
 -  Added support for <ul> and <ol> lists in the :doc:`HTML
    Helper <./helpers/html_helper>`
 -  Added the ability to rewrite :doc:`short
diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
deleted file mode 100644
index 3e7669942..000000000
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ /dev/null
@@ -1,169 +0,0 @@
-#############
-Smiley Helper
-#############
-
-The Smiley Helper file contains functions that let you manage smileys
-(emoticons).
-
-.. important:: The Smiley helper is DEPRECATED and should not be used.
-	It is currently only kept for backwards compatibility.
-
-.. contents::
-  :local:
-
-.. raw:: html
-
-  <div class="custom-index container"></div>
-
-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 smileys, 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 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.
-
-.. important:: Before you begin, please `download the smiley images
-	<https://ellislab.com/asset/ci_download_files/smileys.zip>`_
-	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/** directory, create a file called
-Smileys.php and place the code below in it.
-
-.. important:: Change the URL in the :php:func:`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 also using
-the :doc:`Table Class <../libraries/table>`::
-
-	<?php
-
-	class Smileys extends CI_Controller {
-
-		public 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);
-		}
-
-	}
-
-In your **application/views/** directory, create a file called **smiley_view.php**
-and place this code in it::
-
-	<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>
-			When you have created the above controller and view, load it by visiting http://www.example.com/index.php/smileys/
-		</body>
-	</html>
-
-Field Aliases
--------------
-
-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.
-
-::
-
-	$image_array = get_smiley_links("http://example.com/images/smileys/", "comment_textarea_alias");
-
-To map the alias to the field id, pass them both into the
-:func:`smiley_js()` function::
-
-	$image_array = smiley_js("comment_textarea_alias", "comments");
-
-Available Functions
-===================
-
-.. php:function:: get_clickable_smileys($image_url[, $alias = ''[, $smileys = NULL]])
-
-	:param	string	$image_url: URL path to the smileys directory
-	:param	string	$alias: Field alias
-	:returns:	An array of ready to use smileys
-	:rtype:	array
-
-	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.
-
-	Example::
-
-		$image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comment');
-
-.. php:function:: smiley_js([$alias = ''[, $field_id = ''[, $inline = TRUE]]])
-
-	:param	string	$alias: Field alias
-	:param	string	$field_id: Field ID
-	:param	bool	$inline: Whether we're inserting an inline smiley
-	:returns:	Smiley-enabling JavaScript code
-	:rtype:	string
-
-	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.
-
-	Example::
-
-		<?php echo smiley_js(); ?>
-
-.. php:function:: parse_smileys([$str = ''[, $image_url = ''[, $smileys = NULL]]])
-
-	:param	string	$str: Text containing smiley codes
-	:param	string	$image_url: URL path to the smileys directory
-	:param	array	$smileys: An array of smileys
-	:returns:	Parsed smileys
-	:rtype:	string
-
-	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
-
-	Example::
-
-		$str = 'Here are some smileys: :-)  ;-)';
-		$str = parse_smileys($str, 'http://example.com/images/smileys/');
-		echo $str;
-
-.. |smile!| image:: ../images/smile.gif
\ No newline at end of file
diff --git a/user_guide_src/source/images/smile.gif b/user_guide_src/source/images/smile.gif
deleted file mode 100644
index bf0922504..000000000
--- a/user_guide_src/source/images/smile.gif
+++ /dev/null
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index f00a69512..54f635cc0 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -532,9 +532,9 @@ the ``EXT`` constant has been removed. Use just '.php' instead.
 Smiley helper
 =============
 
-The :doc:`Smiley Helper <../helpers/smiley_helper>` is a legacy feature from EllisLab's
-ExpressionEngine product. However, it is too specific for a general purpose framework like
-CodeIgniter and as such it is now deprecated.
+The *Smiley Helper* is a legacy feature from EllisLab's ExpressionEngine product.
+However, it is too specific for a general purpose framework like CodeIgniter
+and as such it is now deprecated.
 
 Also, the previously deprecated ``js_insert_smiley()`` (since version 1.7.2) is now removed.
 
@@ -559,9 +559,9 @@ implemented cryptographic functions.
 The Cart library
 ================
 
-The :doc:`Cart Library <../libraries/cart>`, similarly to the :doc:`Smiley Helper
-<../helpers/smiley_helper>` is too specific for CodeIgniter. It is now deprecated
-and scheduled for removal in CodeIgniter 3.1+.
+The :doc:`Cart Library <../libraries/cart>`, similarly to the *Smiley Helper*
+is too specific for CodeIgniter. It is now deprecated and scheduled for
+removal in CodeIgniter 3.1+.
 
 .. note:: The library is still available, but you're strongly encouraged to remove its usage sooner
 	rather than later.
diff --git a/user_guide_src/source/installation/upgrade_320.rst b/user_guide_src/source/installation/upgrade_320.rst
index 4e4a73b67..597e1ecf2 100644
--- a/user_guide_src/source/installation/upgrade_320.rst
+++ b/user_guide_src/source/installation/upgrade_320.rst
@@ -132,7 +132,7 @@ The following is a list of functionalities deprecated in CodeIgniter
 version 3.0.x, that have been removed in 3.2.0:
 
 - ``CI_Input::is_cli_request()`` (use :php:func:`is_cli()` instead)
-- ``CI_Router::fetch_directory()`` (use ``CI_Router::$directory instead)
+- ``CI_Router::fetch_directory()`` (use ``CI_Router::$directory`` instead)
 - ``CI_Router::fetch_class()`` (use ``CI_Router::$class`` instead)
 - ``CI_Router::fetch_method()`` (use ``CI_Router::$method`` instead)
 - ``CI_Config::system_url()`` (encourages insecure practices)
@@ -153,3 +153,5 @@ version 3.0.x, that have been removed in 3.2.0:
 
    - ``valid_email()`` (use ``filter_var($email, FILTER_VALIDATE_EMAIL)`` instead)
    - ``send_email()`` (use ``mail()`` instead)
+
+- The entire *Smiley Helper* (an archived version is available on GitHub: `bcit-ci/ci3-smiley-helper <https://github.com/bcit-ci/ci3-smiley-helper>`_)