Class Text_Filter_emoticons

Description

The Text_Filter_emoticons:: class finds emoticon strings ( :), etc.) in a block of text and turns them into image links.

Parameters:

 entities -- If true the html entity versions of the patterns will be used.

$Horde: framework/Text_Filter/Filter/emoticons.php,v 1.17.10.15 2009/01/06 15:23:42 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Text_Filter/Filter/emoticons.php (line 24)

Text_Filter
   |
   --Text_Filter_emoticons
Variable Summary
 array $_params
Method Summary
 array|string getIcons ([string $icon = null])
 string getImage (string $icon, string $prefix, string $postfix)
 array getPatterns ()
Variables
array $_params = array('entities' => false) (line 31)

Filter parameters.


Redefinition of:
Text_Filter::$_params
Filter parameters.
Methods
getIcons (line 91)

Returns a hash with all emoticons and names or the name of a single emoticon.

  • return: Patterns hash or icon name.
  • since: Horde 3.1.4
array|string getIcons ([string $icon = null])
  • string $icon: If set, return the name for that emoticon only.
getImage (line 72)

Returns the img tag for an emoticon.

string getImage (string $icon, string $prefix, string $postfix)
  • string $icon: The emoticon.
  • string $prefix: A html prefix.
  • string $postfix: A html postfix.
getPatterns (line 38)

Returns a hash with replace patterns.

  • return: Patterns hash.
array getPatterns ()

Redefinition of:
Text_Filter::getPatterns()
Returns a hash with replace patterns.

Inherited Methods

Inherited From Text_Filter

 Text_Filter::Text_Filter()
 Text_Filter::factory()
 Text_Filter::filter()
 Text_Filter::getPatterns()
 Text_Filter::postProcess()
 Text_Filter::preProcess()

Documentation generated on Sun, 30 Jan 2011 05:17:07 +0000 by phpDocumentor 1.4.3