OutputFilter

Extends \Joomla\Filter\OutputFilter

OutputFilter

since

1.7.0

Methods

_ampReplaceCallback

Callback method for replacing & with & in a string

_ampReplaceCallback(string $m) : string
static deprecated
since

1.7.0

deprecated

4.0 Use OutputFilter::ampReplaceCallback() instead

Arguments

$m

stringString to process

Response

stringReplaced string

ampReplace

Makes a string safe for XHTML output by escaping ampersands.

ampReplace(string $text) : string
static
since

1.0

Arguments

$text

stringText to process

Response

stringProcessed string.

ampReplaceCallback

Callback method for replacing & with & in a string

ampReplaceCallback(string $m) : string
static
since

3.5

Arguments

$m

stringString to process

Response

stringReplaced string

cleanText

Cleans text of all formatting and scripting code.

cleanText(string &$text) : string
static
since

1.0

Arguments

$text

stringText to clean

Response

stringCleaned text.

linkXHTMLSafe

This method processes a string and replaces all instances of & with & in links only.

linkXHTMLSafe(string $input) : string
static
since

1.7.0

Arguments

$input

stringString to process

Response

stringProcessed string

linkXhtmlSafe

Makes a string safe for XHTML output by escaping ampersands in links.

linkXhtmlSafe(string $input) : string
static
since

1.0

Arguments

$input

stringString to process

Response

stringProcessed string

objectHtmlSafe

Makes an object safe to display in forms.

objectHtmlSafe(object &$mixed, integer $quoteStyle = \ENT_QUOTES, mixed $excludeKeys = '') : void
static

Object parameters that are non-string, array, object or start with underscore will be converted

since

1.0

Arguments

$mixed

objectAn object to be parsed

$quoteStyle

integerThe optional quote style for the htmlspecialchars function

$excludeKeys

mixedAn optional string single field name or array of field names not to be parsed (eg, for a textarea)

stringJSSafe

This method processes a string and escapes it for use in JavaScript

stringJSSafe(string $string) : string
static

Arguments

$string

stringString to process

Response

stringProcessed text

stringURLSafe

This method processes a string and replaces all accented UTF-8 characters by unaccented ASCII-7 "equivalents", whitespaces are replaced by hyphens and the string is lowercase.

stringURLSafe(string $string, string $language = '') : string
static
since

1.7.0

Arguments

$string

stringString to process

$language

stringLanguage to transliterate to

Response

stringProcessed string

stringUrlSafe

Generates a URL safe version of the specified string with language transliteration.

stringUrlSafe(string $string, string $language = '') : string
static

This method processes a string and replaces all accented UTF-8 characters by unaccented ASCII-7 "equivalents"; whitespaces are replaced by hyphens and the string is lowercased.

since

1.0

Arguments

$string

stringString to process

$language

stringLanguage to transliterate to

Response

stringProcessed string

stringUrlUnicodeSlug

Generates a URL safe version of the specified string with unicode character replacement.

stringUrlUnicodeSlug(string $string) : string
static
since

1.0

Arguments

$string

stringString to process

Response

stringProcessed string

stripIframes

Strips <iframe> tags from a string.

stripIframes(string $string) : string
static
since

1.0

Arguments

$string

stringSting to be cleaned.

Response

stringCleaned string

stripImages

Strips <img> tags from a string.

stripImages(string $string) : string
static
since

1.0

Arguments

$string

stringSting to be cleaned.

Response

stringCleaned string