\MyTextSanitizer

Class to "clean up" text for various uses

Singleton

Summary

Methods

Properties

Constants

__construct()
loadConfig()
mergeConfig()
getInstance()
getSmileys()
smiley()
makeClickableCallback01()
makeClickableCallback02()
makeClickableCallback03()
makeClickableCallback04()
makeClickable()
truncate()
apiCodeDecode()
quoteConv()
filterXss()
nl2Br()
addSlashes()
stripSlashesGPC()
htmlSpecialChars()
undoHtmlSpecialChars()
displayTarea()
previewTarea()
censorString()
codePreConv()
codeConvCallback()
codeConv()
executeExtensions()
loadExtension()
executeExtension()
textFilter()
codeSanitizer()
sanitizeForDisplay()
sanitizeForPreview()
makeTboxData4Save()
makeTboxData4Show()
makeTboxData4Edit()
makeTboxData4Preview()
makeTboxData4PreviewInForm()
makeTareaData4Save()
makeTareaData4Show()
makeTareaData4Edit()
makeTareaData4Preview()
makeTareaData4PreviewInForm()
makeTareaData4InsideQuotes()
oopsStripSlashesGPC()
oopsStripSlashesRT()
oopsAddSlashes()
oopsHtmlSpecialChars()
oopsNl2Br()

$smileys
$censorConf
$text
$patterns
$replacements
$callbackPatterns
$callbacks
$path_basic
$path_plugin
$config

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: class/module.textsanitizer.php
Package: kernel\core
Class hierarchy: \MyTextSanitizer

Properties

$smileys

$smileys : mixed||string|int

Type

mixed||string|int —

$censorConf

$censorConf :

Type

$text

$text : \holding

Type

\holding — reference to text

$patterns

$patterns :

Type

$replacements

$replacements :

Type

$callbackPatterns

$callbackPatterns :

Type

$callbacks

$callbacks :

Type

$path_basic

$path_basic :

Type

$path_plugin

$path_plugin :

Type

$config

$config :

Type

Methods

__construct()

__construct() :

Constructor of this class

Gets allowed html tags from admin config settings
should not be allowed since nl2br will be used when storing data.

Returns

loadConfig()

loadConfig(  name = null) : mixed||string|int

Enter description here.

Parameters

name

Returns

mixed||string|int —

mergeConfig()

mergeConfig(mixed||string|int  config_default, mixed||string|int  config_custom) : \unknown

Enter description here.

Parameters

mixed\|\|string\|int	config_default
mixed\|\|string\|int	config_custom

Returns

\unknown —

getInstance()

getInstance() :

Access the only instance of this class

Returns

—

static

Inherited from: \MyTextSanitizer

Tags

TODO	: To be improved

nl2Br()

nl2Br(  text) :

Convert linebreaks to <br> tags

Parameters

text

Returns

—

addSlashes()

addSlashes(  text) :

Add slashes to the text if magic_quotes_gpc is turned off.

Parameters

text

Returns

—

stripSlashesGPC()

stripSlashesGPC(  text) :

if magic_quotes_gpc is on, stirip back slashes

Parameters

text

Returns

—

htmlSpecialChars()

htmlSpecialChars(  text,   quote_style = ENT_QUOTES,   charset = null,   double_encode = true) :

Convert special characters to HTML entities

Parameters

	text	string being converted
	quote_style
	charset	character set used in conversion
	double_encode

Returns

—

undoHtmlSpecialChars()

undoHtmlSpecialChars(  text) :

Reverses {@link htmlSpecialChars()}

Parameters

text

Returns

—

displayTarea()

displayTarea(  text, bool|int  html, bool|int  smiley = 1, bool|int  xcode = 1, bool|int  image = 1, bool|int  br = 1) :

Filters textarea form data in DB for display

Parameters

	text
bool\|int	html	allow html?
bool\|int	smiley	allow smileys?
bool\|int	xcode	allow apicode?
bool\|int	image	allow inline images?
bool\|int	br	convert linebreaks?

Returns

—

previewTarea()

previewTarea(  text, bool|int  html, bool|int  smiley = 1, bool|int  xcode = 1, bool|int  image = 1, bool|int  br = 1) :

Filters textarea form data submitted for preview

Parameters

	text
bool\|int	html	allow html?
bool\|int	smiley	allow smileys?
bool\|int	xcode	allow apicode?
bool\|int	image	allow inline images?
bool\|int	br	convert linebreaks?

Returns

—

censorString()

censorString(  text) :

Replaces banned words in a string with their replacements

Parameters

text

Returns

—

codePreConv()

codePreConv(  text,   xcode = 1) :

MyTextSanitizer::codePreConv()

Parameters

	text
	xcode

Returns

—

codeConvCallback()

codeConvCallback( match) :

Parameters

match

Returns

—

codeConv()

codeConv(  text,   xcode = 1) :

MyTextSanitizer::codeConv()

Parameters

	text
	xcode

Returns

—

executeExtensions()

executeExtensions() :

MyTextSanitizer::executeExtensions()

Returns

—

loadExtension()

loadExtension(  name) : bool|null

MyTextSanitizer::loadExtension()

Parameters

name

Returns

bool|null —

executeExtension()

executeExtension(  name) :

MyTextSanitizer::executeExtension()

Parameters

name

Returns

—

textFilter()

textFilter(  text,   force = false) :

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

—

filtered text

codeSanitizer()

codeSanitizer(  str,   image = 1) : mixed|string

MyTextSanitizer::codeSanitizer()

Parameters

	str
	image

Returns

mixed|string —

sanitizeForDisplay()

sanitizeForDisplay(  text,   allowhtml,   smiley = 1,   bbcode = 1) : mixed|string

MyTextSanitizer::sanitizeForDisplay()

Parameters

	text
	allowhtml
	smiley
	bbcode

Returns

mixed|string —

sanitizeForPreview()

sanitizeForPreview(  text,   allowhtml,   smiley = 1,   bbcode = 1) : mixed|string

MyTextSanitizer::sanitizeForPreview()

Parameters

	text
	allowhtml
	smiley
	bbcode

Returns

mixed|string —

makeTboxData4Save()

makeTboxData4Save(  text) :

MyTextSanitizer::makeTboxData4Save()

Parameters

text

Returns

—

makeTboxData4Show()

makeTboxData4Show(  text,   smiley) : mixed|string

MyTextSanitizer::makeTboxData4Show()

Parameters

	text
	smiley

Returns

mixed|string —

makeTboxData4Edit()

makeTboxData4Edit(  text) :

MyTextSanitizer::makeTboxData4Edit()

Parameters

text

Returns

—

makeTboxData4Preview()

makeTboxData4Preview(  text,   smiley) : mixed|string

MyTextSanitizer::makeTboxData4Preview()

Parameters

	text
	smiley

Returns

mixed|string —

makeTboxData4PreviewInForm()

makeTboxData4PreviewInForm(  text) :

MyTextSanitizer::makeTboxData4PreviewInForm()

Parameters

text

Returns

—

makeTareaData4Save()

makeTareaData4Save(  text) :

MyTextSanitizer::makeTareaData4Save()

Parameters

text

Returns

—

makeTareaData4Show()

makeTareaData4Show(  text,   html = 1,   smiley = 1,   xcode = 1) : mixed|string

MyTextSanitizer::makeTareaData4Show()

Parameters

	text
	html
	smiley
	xcode

Returns

mixed|string —

makeTareaData4Edit()

makeTareaData4Edit(  text) :

MyTextSanitizer::makeTareaData4Edit()

Parameters

text

Returns

—

makeTareaData4Preview()

makeTareaData4Preview(  text,   html = 1,   smiley = 1,   xcode = 1) : mixed|string

MyTextSanitizer::makeTareaData4Preview()

Parameters

	text
	html
	smiley
	xcode

Returns

mixed|string —

makeTareaData4PreviewInForm()

makeTareaData4PreviewInForm(  text) :

MyTextSanitizer::makeTareaData4PreviewInForm()

Parameters

text

Returns

—

makeTareaData4InsideQuotes()

makeTareaData4InsideQuotes(  text) :

MyTextSanitizer::makeTareaData4InsideQuotes()

Parameters

text

Returns

—

oopsStripSlashesGPC()

oopsStripSlashesGPC(  text) :

MyTextSanitizer::oopsStripSlashesGPC()

Parameters

text

Returns

—

oopsStripSlashesRT()

oopsStripSlashesRT(  text) : mixed|string

MyTextSanitizer::oopsStripSlashesRT()

Parameters

text

Returns

mixed|string —

oopsAddSlashes()

oopsAddSlashes(  text) :

MyTextSanitizer::oopsAddSlashes()

Parameters

text

Returns

—

oopsHtmlSpecialChars()

oopsHtmlSpecialChars(  text) :

MyTextSanitizer::oopsHtmlSpecialChars()

Parameters

text

Returns

—

oopsNl2Br()

oopsNl2Br(  text) :

MyTextSanitizer::oopsNl2Br()

Parameters

text

Returns

—

	text
bool\|int	allowimage	Allow images in the text? On FALSE, uses links to images.

static
staticvar	object