Class TextHelper

strprotect()

strprotect(string $var, boolean $html_protect = self::HTML_PROTECT, integer $addslashes = self::ADDSLASHES_FORCE) : string

Protects an input variable. Never trust user input!

Parameters

string	$var	Variable to protect.
boolean	$html_protect	HTML_PROTECT if you don't accept the HTML code (it will be transformed by the corresponding HTML entities and won't be considerer by the web browsers).
integer	$addslashes	If you want to escape the quotes in the string, use ADDSLASHES_FORCE, if you don't want, use the ADDSLASHES_NONE constant.

Returns

string —

The protected string.

static

• Inherited from \TextHelper

Tags

None found

wordwrap_html()

wordwrap_html(string $str, integer $lenght, string $cut_char = '<br />', boolean $cut = true) : string

Inserts a carriage return every $lenght characters. It's equivalent to wordwrap PHP function but it can deal with the HTML entities.

An entity is coded on several characters and the wordwrap function counts several characters for an entity whereas it represents only one character.

Parameters

string	$str	The string to wrap.
integer	$lenght	The number of characters you want in a line.
string	$cut_char	The character to insert every $lenght characters. The default value is ' ', the HTML carriage return tag.
boolean	$cut	True if you accept that a word would be broken apart, false if you want to cut only on a blank character.

Returns

string —

The wrapped HTML string.

static

• Inherited from \TextHelper

Tags

None found

substr_html()

substr_html(string $str, integer $start, integer $end = '') : string

Cuts a string containing some HTML code which contains some HTML entities. The substr PHP function considers a HTML entity as several characters.

This function allows you to consider them as only one character.

Parameters

string	$str	The string you want to cut.
integer	$start	If start is non-negative, the returned string will start at the start 'th position in string , counting from zero. For instance, in the string 'abcdef', the character at position 0 is 'a', the character at position 2 is 'c', and so forth. If start is negative, the returned string will start at the start 'th character from the end of string . If string is less than or equal to start characters long, FALSE will be returned.
integer	$end	If length is given and is positive, the string returned will contain at most length characters beginning from start (depending on the length of string ).

Returns

string —

The sub string.

static

• Inherited from \TextHelper

Tags

None found

cut_string()

cut_string(string $string, integer $length) : string

Cut string to the desired length, ending with the last full word.

Parameters

string	$string	A PHP string to convert to cut
integer	$length	The desired length

Returns

string —

The substring

static

• Inherited from \TextHelper

Tags

None found

to_js_string()

to_js_string(string $string, string $add_quotes = true) : string

Exports a variable to be used in a javascript script.

Parameters

string	$string	A PHP string to convert to a JS one
string	$add_quotes	If true, returned string will be bounded by single quotes

Returns

string —

The js equivalent string

static

• Inherited from \TextHelper

Tags

None found

to_json_string()

to_json_string(string $string, string $add_quotes = true) : string

Exports a variable to be used in a json javascript script.

Parameters

string	$string	A PHP string to convert to a json one
string	$add_quotes	If true, returned string will be bounded by double quotes

Returns

string —

The json equivalent string

static

• Inherited from \TextHelper

Tags

None found

htmlspecialchars()

htmlspecialchars( $string,  $flags = null,  $encoding = 'UTF-8',  $double_encode = true) 

Parameters

	$string
	$flags
	$encoding
	$double_encode

static

• Inherited from \TextHelper

Tags

None found

htmlspecialchars_decode()

htmlspecialchars_decode( $string,  $flags = null) 

Parameters

	$string
	$flags

static

• Inherited from \TextHelper

Tags

None found

html_entity_decode()

html_entity_decode( $string,  $flags = null,  $encoding = 'UTF-8') 

Parameters

	$string
	$flags
	$encoding

static

• Inherited from \TextHelper

Tags

None found

strtolower()

strtolower( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

strtoupper()

strtoupper( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

lcfirst()

lcfirst( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

ucfirst()

ucfirst( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

strlen()

strlen( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

strpos()

strpos( $string,  $substring,  $offset = '') 

Parameters

	$string
	$substring
	$offset

static

• Inherited from \TextHelper

Tags

None found

stripos()

stripos( $string,  $substring,  $offset = '') 

Parameters

	$string
	$substring
	$offset

static

• Inherited from \TextHelper

Tags

None found

substr()

substr( $string,  $start,  $length = '') 

Parameters

	$string
	$start
	$length

static

• Inherited from \TextHelper

Tags

None found

mb_substr()

mb_substr( $string,  $start,  $length = '') 

Parameters

	$string
	$start
	$length

static

• Inherited from \TextHelper

Tags

None found

strrchr()

strrchr( $string,  $needle) 

Parameters

	$string
	$needle

static

• Inherited from \TextHelper

Tags

None found

strripos()

strripos( $string,  $needle,  $offset = '') 

Parameters

	$string
	$needle
	$offset

static

• Inherited from \TextHelper

Tags

None found

strrpos()

strrpos( $string,  $needle,  $offset = '') 

Parameters

	$string
	$needle
	$offset

static

• Inherited from \TextHelper

Tags

None found

strstr()

strstr( $string,  $needle,  $before_needle = '') 

Parameters

	$string
	$needle
	$before_needle

static

• Inherited from \TextHelper

Tags

None found

substr_count()

substr_count( $string,  $needle,  $encoding = '') 

Parameters

	$string
	$needle
	$encoding

static

• Inherited from \TextHelper

Tags

None found

convert_case()

convert_case( $string,  $mode,  $encoding = '') 

Parameters

	$string
	$mode
	$encoding

static

• Inherited from \TextHelper

Tags

None found

serialize()

serialize( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

serialize_base64()

serialize_base64( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

unserialize()

unserialize( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

mb_unserialize()

mb_unserialize( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found

check_nbr_links()

check_nbr_links(string $contents, integer $max_nbr, boolean $has_html_links = false) : boolean

Checks if a string contains less than a defined number of links (used to prevent SPAM).

Parameters

string	$contents	String in which you want to count the number of links
integer	$max_nbr	Maximum number of links accepted.
boolean	$has_html_links	true if the content is in HTML

Returns

boolean —

true if there are no too much links, false otherwise.

static

• Inherited from \TextHelper

Tags

None found

utf8_wordwrap()

utf8_wordwrap(string $string, integer $width = 75, string $break = "\n", string $cut = true) : string

Wraps a UTF-8 string to a given number of characters

Parameters

string	$string	the input string
integer	$width	the column width
string	$break	the line is broken using the optional break parameter
string	$cut	not used for the moment

Returns

string —

the given string wrapped at the specified column

static

• Inherited from \TextHelper

Tags

None found

is_base64()

is_base64( $string) 

Parameters

$string

static

• Inherited from \TextHelper

Tags

None found