Class MyTextSanitizer

Class to "clean up" text for various uses

Singleton

Direct known subclasses

Package: kernel\core
Copyright: (c) 2000-2016 XOOPS Project - www.xoops.org
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Author: Goghs Cheng
Located at lass/module.textsanitizer.php

Methods summary
`public`	# `__construct( )` Constructor of this class Constructor of this class Gets allowed html tags from admin config settings should not be allowed since nl2br will be used when storing data.
`public array`	# `loadConfig( string $name = null )` Enter description here... Enter description here... Parameters `$name` Returns array
`public unknown`	# `mergeConfig( array $config_default, array $config_custom )` Enter description here... Enter description here... Parameters `$config_default` `$config_custom` Returns unknown
`public static object`	# `getInstance( )` Access the only instance of this class Access the only instance of this class Returns object
`public array`	# `getSmileys( boolean $isAll = true )` Get the smileys Get the smileys Parameters `$isAll` TRUE for all smileys, FALSE for smileys with display = 1 Returns array
`public string`	# `smiley( string $message )` Replace emoticons in the message with smiley images Replace emoticons in the message with smiley images Parameters `$message` Returns string
`public string`	# `makeClickableCallback01( $match )` Parameters `$match` Returns string
`public string`	# `makeClickableCallback02( $match )` Parameters `$match` Returns string
`public string`	# `makeClickableCallback03( $match )` Parameters `$match` Returns string
`public string`	# `makeClickableCallback04( $match )` Parameters `$match` Returns string
`public string`	# `makeClickable( string & $text )` Make links in the text clickable Make links in the text clickable Parameters `$text` Returns string
`public mixed\|string`	# `truncate( mixed $text )` MyTextSanitizer::truncate() MyTextSanitizer::truncate() Parameters `$text` Returns mixed\|string
`public string &`	# `xoopsCodeDecode( string & $text, boolean\|integer $allowimage = 1 )` Replace XoopsCodes with their equivalent HTML formatting Replace XoopsCodes with their equivalent HTML formatting Parameters `$text` `$allowimage` Allow images in the text? On FALSE, uses links to images. Returns string
`public string`	# `quoteConv( string $text )` Convert quote tags Convert quote tags Parameters `$text` Returns string
`public mixed`	# `filterXss( $text )` A quick solution for filtering XSS scripts A quick solution for filtering XSS scripts Parameters `$text` Returns mixed
`public string`	# `nl2Br( string $text )` Convert linebreaks to tags Convert linebreaks to tags Parameters `$text` Returns string
`public string`	# `addSlashes( string $text )` Add slashes to the text if magic_quotes_gpc is turned off. Add slashes to the text if magic_quotes_gpc is turned off. Parameters `$text` Returns string
`public string`	# `stripSlashesGPC( string $text )` if magic_quotes_gpc is on, stirip back slashes if magic_quotes_gpc is on, stirip back slashes Parameters `$text` Returns string
`public string`	# `htmlSpecialChars( string $text, integer $quote_style = ENT_QUOTES, string $charset = null, boolean $double_encode = true )` Convert special characters to HTML entities Convert special characters to HTML entities Parameters `$text` string being converted `$quote_style` `$charset` character set used in conversion `$double_encode` Returns string
`public string`	# `undoHtmlSpecialChars( string $text )` Reverses `MyTextSanitizer::htmlSpecialChars()` Reverses `MyTextSanitizer::htmlSpecialChars()` Parameters `$text` Returns string
`public string &`	# `displayTarea( string $text, boolean\|integer $html = 0, boolean\|integer $smiley = 1, boolean\|integer $xcode = 1, boolean\|integer $image = 1, boolean\|integer $br = 1 )` Filters textarea form data in DB for display Filters textarea form data in DB for display Parameters `$text` `$html` allow html? `$smiley` allow smileys? `$xcode` allow xoopscode? `$image` allow inline images? `$br` convert linebreaks? Returns string
`public string &`	# `previewTarea( string $text, boolean\|integer $html = 0, boolean\|integer $smiley = 1, boolean\|integer $xcode = 1, boolean\|integer $image = 1, boolean\|integer $br = 1 )` Filters textarea form data submitted for preview Filters textarea form data submitted for preview Parameters `$text` `$html` allow html? `$smiley` allow smileys? `$xcode` allow xoopscode? `$image` allow inline images? `$br` convert linebreaks? Returns string
`public string &`	# `censorString( string & $text )` Replaces banned words in a string with their replacements Replaces banned words in a string with their replacements Deprecated Parameters `$text` Returns string
`public mixed`	# `codePreConv( mixed $text, mixed $xcode = 1 )` MyTextSanitizer::codePreConv() MyTextSanitizer::codePreConv() Parameters `$text` `$xcode` Returns mixed
`public string`	# `codeConvCallback( $match )` Parameters `$match` Returns string
`public mixed`	# `codeConv( mixed $text, mixed $xcode = 1 )` MyTextSanitizer::codeConv() MyTextSanitizer::codeConv() Parameters `$text` `$xcode` Returns mixed
`public boolean`	# `executeExtensions( )` MyTextSanitizer::executeExtensions() MyTextSanitizer::executeExtensions() Returns boolean
`public boolean\|null`	# `loadExtension( mixed $name )` MyTextSanitizer::loadExtension() MyTextSanitizer::loadExtension() Parameters `$name` Returns boolean\|null
`public mixed`	# `executeExtension( mixed $name )` MyTextSanitizer::executeExtension() MyTextSanitizer::executeExtension() Parameters `$name` Returns mixed
`public string`	# `textFilter( string $text, boolean $force = false )` Filter out possible malicious text kses project at SF could be a good solution to check Filter out possible malicious text kses project at SF could be a good solution to check Parameters `$text` text to filter `$force` force filtering Returns string filtered text
`public mixed\|string`	# `codeSanitizer( mixed $str, mixed $image = 1 )` MyTextSanitizer::codeSanitizer() MyTextSanitizer::codeSanitizer() Parameters `$str` `$image` Returns mixed\|string
`public mixed\|string`	# `sanitizeForDisplay( mixed $text, integer $allowhtml = 0, integer $smiley = 1, mixed $bbcode = 1 )` MyTextSanitizer::sanitizeForDisplay() MyTextSanitizer::sanitizeForDisplay() Parameters `$text` `$allowhtml` `$smiley` `$bbcode` Returns mixed\|string
`public mixed\|string`	# `sanitizeForPreview( mixed $text, integer $allowhtml = 0, integer $smiley = 1, mixed $bbcode = 1 )` MyTextSanitizer::sanitizeForPreview() MyTextSanitizer::sanitizeForPreview() Parameters `$text` `$allowhtml` `$smiley` `$bbcode` Returns mixed\|string
`public string`	# `makeTboxData4Save( mixed $text )` MyTextSanitizer::makeTboxData4Save() MyTextSanitizer::makeTboxData4Save() Parameters `$text` Returns string
`public mixed\|string`	# `makeTboxData4Show( mixed $text, mixed $smiley = 0 )` MyTextSanitizer::makeTboxData4Show() MyTextSanitizer::makeTboxData4Show() Parameters `$text` `$smiley` Returns mixed\|string
`public string`	# `makeTboxData4Edit( mixed $text )` MyTextSanitizer::makeTboxData4Edit() MyTextSanitizer::makeTboxData4Edit() Parameters `$text` Returns string
`public mixed\|string`	# `makeTboxData4Preview( mixed $text, mixed $smiley = 0 )` MyTextSanitizer::makeTboxData4Preview() MyTextSanitizer::makeTboxData4Preview() Parameters `$text` `$smiley` Returns mixed\|string
`public string`	# `makeTboxData4PreviewInForm( mixed $text )` MyTextSanitizer::makeTboxData4PreviewInForm() MyTextSanitizer::makeTboxData4PreviewInForm() Parameters `$text` Returns string
`public string`	# `makeTareaData4Save( mixed $text )` MyTextSanitizer::makeTareaData4Save() MyTextSanitizer::makeTareaData4Save() Parameters `$text` Returns string
`public mixed\|string &`	# `makeTareaData4Show( mixed & $text, integer $html = 1, integer $smiley = 1, mixed $xcode = 1 )` MyTextSanitizer::makeTareaData4Show() MyTextSanitizer::makeTareaData4Show() Parameters `$text` `$html` `$smiley` `$xcode` Returns mixed\|string
`public string`	# `makeTareaData4Edit( mixed $text )` MyTextSanitizer::makeTareaData4Edit() MyTextSanitizer::makeTareaData4Edit() Parameters `$text` Returns string
`public mixed\|string &`	# `makeTareaData4Preview( mixed & $text, integer $html = 1, integer $smiley = 1, mixed $xcode = 1 )` MyTextSanitizer::makeTareaData4Preview() MyTextSanitizer::makeTareaData4Preview() Parameters `$text` `$html` `$smiley` `$xcode` Returns mixed\|string
`public string`	# `makeTareaData4PreviewInForm( mixed $text )` MyTextSanitizer::makeTareaData4PreviewInForm() MyTextSanitizer::makeTareaData4PreviewInForm() Parameters `$text` Returns string
`public string`	# `makeTareaData4InsideQuotes( mixed $text )` MyTextSanitizer::makeTareaData4InsideQuotes() MyTextSanitizer::makeTareaData4InsideQuotes() Parameters `$text` Returns string
`public string`	# `oopsStripSlashesGPC( mixed $text )` MyTextSanitizer::oopsStripSlashesGPC() MyTextSanitizer::oopsStripSlashesGPC() Parameters `$text` Returns string
`public mixed\|string`	# `oopsStripSlashesRT( mixed $text )` MyTextSanitizer::oopsStripSlashesRT() MyTextSanitizer::oopsStripSlashesRT() Parameters `$text` Returns mixed\|string
`public string`	# `oopsAddSlashes( mixed $text )` MyTextSanitizer::oopsAddSlashes() MyTextSanitizer::oopsAddSlashes() Parameters `$text` Returns string
`public string`	# `oopsHtmlSpecialChars( mixed $text )` MyTextSanitizer::oopsHtmlSpecialChars() MyTextSanitizer::oopsHtmlSpecialChars() Parameters `$text` Returns string
`public string`	# `oopsNl2Br( mixed $text )` MyTextSanitizer::oopsNl2Br() MyTextSanitizer::oopsNl2Br() Parameters `$text` Returns string

Properties summary
`public array`	`$smileys`	# `array()`
`public`	`$censorConf`	#
`public holding`	`$text` reference to text reference to text	# `''`
`public array`	`$patterns`	# `array()`
`public array`	`$replacements`	# `array()`
`public array`	`$callbackPatterns`	# `array()`
`public array`	`$callbacks`	# `array()`
`public`	`$path_basic`	#
`public`	`$path_plugin`	#
`public`	`$config`	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class MyTextSanitizer

Direct known subclasses

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns