Static Public Member Functions
static	strlen ($string)
	Returns the length of the given string. More...

static	strpos ($haystack, $needle, $offset=0)
	Returns the numeric position of the first occurrence of needle in the haystack string. More...

static	strrpos ($haystack, $needle, $offset=0)
	Returns the numeric position of the last occurrence of needle in the haystack string. More...

static	substr ($string, $start, $length=null)
	Returns the portion of string specified by the start and length parameters. More...

static	strtolower ($string)
	Returns string with all alphabetic characters converted to lowercase. More...

static	strtoupper ($string)
	Returns string with all alphabetic characters converted to uppercase. More...

static	ucfirst ($string)
	Returns string with first letter uppercase. More...

static	substr_count ($string, $searched)
	Returns the number of times the needle substring occurs in the haystack string. More...

static	cut_with_separator ($string, $max_part_length=40, $separator= ' ')
	Adds a seperator every $max_part_length characters. More...

static	str_shorten ($string, $length_limit, $middle_separator= '', $ending_if_no_middle_separator= '...', $ideal_length_with_clean_cut_if_possible=null)
	Raccourcit une chaine de caractère en insérant au milieu ou à la fin un séparateur. More...

static	str_shorten_words ($string, $length_limit=100, $separator=" ", $force_shorten_if_special_content=false, $add_separator_instead_of_cutting=true)
	On rajoute des espaces à l'intérieur des mots trop longs => à utiliser pour éviter de casser une mise en page. More...

static	convert_accents ($string, $convert_umlaut=false, $strip_umlaut=true)
	convert_accents() More...

static	convert_encoding ($string, $new_encoding, $original_encoding=null)
	Converts the character encoding of string $string to $new_encoding from optionally $original_encoding. More...

static	htmlentities ($string, $flags=ENT_COMPAT, $charset=GENERAL_ENCODING, $suppr_endline=false, $encode_only_isolated_amperstands=false, $decode_html_entities_first=false)
	Convert all applicable characters to HTML entities Cette fonction sert si on veut afficher du contenu brut dans du HTML ou du XML : elle transforme les caractères spéciaux en entités HTML, et traite les incohérences qui pourraient créer des invalidités du contenu XHTML ou XML Pour traiter du contenu de fichier XML, utiliser avec $encode_only_isolated_amperstands = true ce qui ne modifie pas le texte hormis corriger les & isolés en &. More...

static	str_htmlentities ($string, $suppr_endline=false, $encode_only_isolated_amperstands=false)
	Méthode de compatibilité avec anciennes versions de PEEL utilisant str_htmlentities au lieu de htmlentities. More...

static	textEncode ($string, $suppr_endline=false, $encode_only_isolated_amperstands=false)
	Méthode de compatibilité avec anciennes versions de PEEL utilisant textEncode au lieu de htmlentities. More...

static	str_form_value ($value, $flags=ENT_COMPAT)
	Encode une chaine de caractères pour affichage dans un value="". More...

static	htmlspecialchars_decode ($string, $style=ENT_COMPAT)
	This function is String::htmlspecialchars_decode with php4 compatibility. More...

static	html_entity_decode ($string, $quote_style=ENT_COMPAT, $charset=GENERAL_ENCODING)
	String::html_entity_decode() More...

static	html_entity_decode_if_needed ($string)
	String::html_entity_decode_if_needed() More...

static	strip_tags ($string, $allowed_tags=null)
	String::strip_tags() More...

static	nl2br_if_needed ($string)
	Fonction de compatibilité avec de vieilles versions de PEEL ou du contenu qui vient d'ailleurs. More...

static	detect_utf8_characters ($string)
	Détecte si au moins un caractère est manifestement de l'UTF8. More...

static	utf8_encode ($string)
	Si vous avez des utilisateurs sous windows qui saisissent du contenu dans une interface qui l'insère dans une base en ISO-88591 vous risquez d'avoir des surprises. More...

static	getCleanHTML ($text, $max_width=null, $allow_form=false, $allow_object=false, $allow_class=false, $additional_config=null, $safe=true, $additional_elements=null, $max_caracters_length=50000, $max_octets_length=59000, $max_word_and_url_length=100)
	Fonction qui nettoie le HTML. More...

static	fopen_utf8 ($filename, $mode, $force_filename_in_iso_8859=false, $try_filename_in_iso_8859_if_file_not_found=true)
	Ouvre un fichier. More...

static	file_get_contents_utf8 ($filename, $force_filename_in_iso_8859=false, $try_filename_in_iso_8859_if_file_not_found=true)
	Renvoie le contenu d'un fichier. More...

static	feof ($handle)
	Tests for end-of-file on a file pointer In contrary of the default feof function, it returns true if $handle === false, and if timeout in feof It wan be safely used with while (!String::feof($file)) { ... More...

static	rawurlencode ($string, $avoid_slash=true)
	Returns string compatible with Apache without the AllowEncodedSlashes directive ON => avoids systematic 404 error when %2F in URL (when it is present outside of GET) More...

static	rawurldecode ($string, $avoid_slash=false)
	Returns rawurldecode. More...

Detailed Description

Definition at line 29 of file String.php.

Member Function Documentation

static convert_accents	(	$string,
		$convert_umlaut = `false`,
		$strip_umlaut = `true`
	)

static

convert_accents()

Parameters

string	$string
boolean	$convert_umlaut
boolean	$strip_umlaut

Returns

Definition at line 341 of file String.php.

static convert_encoding	(	$string,
		$new_encoding,
		$original_encoding = `null`
	)

static

Converts the character encoding of string $string to $new_encoding from optionally $original_encoding.

Examples of encodings : UTF-16, UTF-8, JIS, ISO-8859-1, ISO-8859-15 If the mbstring is not defined, it return the original $string

Parameters

string	$string
string	$new_encoding
string	$original_encoding

Returns

Definition at line 375 of file String.php.

static cut_with_separator	(	$string,
		$max_part_length = `40`,
		$separator = `' '`
	)

static

Adds a seperator every $max_part_length characters.

Parameters

string	$string	The input string.
integer	$max_part_length
string	$separator

Returns

Definition at line 211 of file String.php.

static detect_utf8_characters ( $string )

static

Détecte si au moins un caractère est manifestement de l'UTF8.

Parameters

mixed $string

Returns

Definition at line 580 of file String.php.

static feof ( $handle )

static

Tests for end-of-file on a file pointer In contrary of the default feof function, it returns true if $handle === false, and if timeout in feof It wan be safely used with while (!String::feof($file)) { ...

}

Parameters

mixed $handle

Returns

Definition at line 866 of file String.php.

static file_get_contents_utf8	(	$filename,
		$force_filename_in_iso_8859 = `false`,
		$try_filename_in_iso_8859_if_file_not_found = `true`
	)

static

Renvoie le contenu d'un fichier.

De manière générale, tout fichier manipulé par PEEL est censé avoir un nom encodé en UTF8, pour gérer toute langue internationale, ce que ne peut pas faire ISO. Néanmoins en cas d'import de fichiers par FTP manuel, ou d'URL donnée avec lien vers un autre site, les fichiers risquent d'être mis en ISO. Il est préférable de mettre le mode de compatibilité $try_filename_in_iso_8859_if_file_not_found = true

Parameters

string	$filename
boolean	$force_filename_in_iso_8859
boolean	$try_filename_in_iso_8859_if_file_not_found

Returns

Definition at line 836 of file String.php.

static fopen_utf8	(	$filename,
		$mode,
		$force_filename_in_iso_8859 = `false`,
		$try_filename_in_iso_8859_if_file_not_found = `true`
	)

static

Ouvre un fichier.

C'est une fonction de compatibilité avec du contenu qui n'est pas en UTF8 sans BOM comme il devrait être De manière générale, tout fichier manipulé par PEEL est censé avoir un nom encodé en UTF8, pour gérer toute langue internationale, ce que ne peut pas faire ISO. Néanmoins en cas d'import de fichiers par FTP manuel, ou d'URL donnée avec lien vers un autre site, les fichiers risquent d'être mis en ISO. Il est préférable de mettre le mode de compatibilité $try_filename_in_iso_8859_if_file_not_found = true

Parameters

string	$filename
string	$mode
boolean	$force_filename_in_iso_8859
boolean	$try_filename_in_iso_8859_if_file_not_found

Returns

Definition at line 793 of file String.php.

static getCleanHTML	(	$text,
		$max_width = `null`,
		$allow_form = `false`,
		$allow_object = `false`,
		$allow_class = `false`,
		$additional_config = `null`,
		$safe = `true`,
		$additional_elements = `null`,
		$max_caracters_length = `50000`,
		$max_octets_length = `59000`,
		$max_word_and_url_length = `100`
	)

static

Fonction qui nettoie le HTML.

Parameters

string	$text
integer	$max_width
boolean	$allow_form
boolean	$allow_object
boolean	$allow_class
mixed	$additional_config
boolean	$safe
string	$additional_elements
integer	$max_caracters_length	On coupe le texte si le nombre de caractères dépasse la valeur autorisée ads_max_caracters_length de 10%, avant de le passer dans getCleanHTML qui va regénérer les balises de cloture manquantes - En cas de langue avec beaucoup de caractères spéciaux, cette valeur doit être fortement inférieure à la taille du champ en base de données
integer	$max_octets_length	On coupe sans ménagement le texte si la taille en octets dépasse la valeur autorisée ads_max_octets_length de 10%, avant de le passer dans getCleanHTML qui va regénérer les balises de cloture manquantes - ads_max_caracters_length doit être inférieur à la taille du champs en base de données en laissant la place pour les balises de cloture (champ TEXT = 65 536 octets)
integer	$max_word_and_url_length

Returns

Definition at line 651 of file String.php.

static html_entity_decode	(	$string,
		$quote_style = `ENT_COMPAT`,
		$charset = `GENERAL_ENCODING`
	)

static

String::html_entity_decode()

Parameters

string	$string
mixed	$quote_style
mixed	$charset

Returns

Definition at line 517 of file String.php.

static html_entity_decode_if_needed ( $string )

static

String::html_entity_decode_if_needed()

Parameters

string $string

Returns

Definition at line 533 of file String.php.

static htmlentities	(	$string,
		$flags = `ENT_COMPAT`,
		$charset = `GENERAL_ENCODING`,
		$suppr_endline = `false`,
		$encode_only_isolated_amperstands = `false`,
		$decode_html_entities_first = `false`
	)

static

Convert all applicable characters to HTML entities Cette fonction sert si on veut afficher du contenu brut dans du HTML ou du XML : elle transforme les caractères spéciaux en entités HTML, et traite les incohérences qui pourraient créer des invalidités du contenu XHTML ou XML Pour traiter du contenu de fichier XML, utiliser avec $encode_only_isolated_amperstands = true ce qui ne modifie pas le texte hormis corriger les & isolés en &.

Parameters

string	$string
string	$flags	the optional second flags parameter lets you define what will be done with 'single' and "double" quotes
string	$charset	defines character set used in conversion
boolean	$suppr_endline
boolean	$encode_only_isolated_amperstands

Returns

Definition at line 411 of file String.php.

static htmlspecialchars_decode	(	$string,
		$style = `ENT_COMPAT`
	)

static

This function is String::htmlspecialchars_decode with php4 compatibility.

Parameters

mixed	$string
mixed	$style

Returns

Definition at line 500 of file String.php.

static nl2br_if_needed ( $string )

static

Fonction de compatibilité avec de vieilles versions de PEEL ou du contenu qui vient d'ailleurs.

Parameters

mixed $string

Returns

Definition at line 559 of file String.php.

static rawurldecode	(	$string,
		$avoid_slash = `false`
	)

static

Returns rawurldecode.

Parameters

string	$string	The input string.
boolean	$avoid_slash

Returns

Definition at line 909 of file String.php.

static rawurlencode	(	$string,
		$avoid_slash = `true`
	)

static

Returns string compatible with Apache without the AllowEncodedSlashes directive ON => avoids systematic 404 error when %2F in URL (when it is present outside of GET)

Parameters

string	$string	The input string.
boolean	$avoid_slash

Returns

Definition at line 893 of file String.php.

static str_form_value	(	$value,
		$flags = `ENT_COMPAT`
	)

static

Encode une chaine de caractères pour affichage dans un value="".

Parameters

string	$value
mixed	$flags

Returns

Definition at line 480 of file String.php.

static str_htmlentities	(	$string,
		$suppr_endline = `false`,
		$encode_only_isolated_amperstands = `false`
	)

static

Méthode de compatibilité avec anciennes versions de PEEL utilisant str_htmlentities au lieu de htmlentities.

Parameters

mixed	$string
boolean	$suppr_endline
boolean	$encode_only_isolated_amperstands

Returns

Definition at line 455 of file String.php.

static str_shorten	(	$string,
		$length_limit,
		$middle_separator = `''`,
		$ending_if_no_middle_separator = `'...'`,
		$ideal_length_with_clean_cut_if_possible = `null`
	)

static

Raccourcit une chaine de caractère en insérant au milieu ou à la fin un séparateur.

Parameters

string	$string
integer	$length_limit
string	$middle_separator
string	$ending_if_no_middle_separator
mixed	$ideal_length_with_clean_cut_if_possible

Returns

Definition at line 233 of file String.php.

static str_shorten_words	(	$string,
		$length_limit = `100`,
		$separator = `" "`,
		$force_shorten_if_special_content = `false`,
		$add_separator_instead_of_cutting = `true`
	)

static

On rajoute des espaces à l'intérieur des mots trop longs => à utiliser pour éviter de casser une mise en page.

Parameters

string	$string
integer	$length_limit
string	$separator
boolean	$force_shorten_if_special_content

Returns

Definition at line 305 of file String.php.

static strip_tags	(	$string,
		$allowed_tags = `null`
	)

static

String::strip_tags()

Parameters

string $string

Returns

Definition at line 548 of file String.php.

static strlen ( $string )

static

Returns the length of the given string.

Parameters

string $string

Returns

Definition at line 36 of file String.php.

static strpos	(	$haystack,
		$needle,
		$offset = `0`
	)

static

Returns the numeric position of the first occurrence of needle in the haystack string.

Unlike the strrpos() before PHP 5, this function can take a full string as the needle parameter and the entire string will be used.

Parameters

string	$haystack	The string to search in
string	$needle	If needle is not a string, it is converted to an integer and applied as the ordinal value of a character.
integer	$offset	The optional offset parameter allows you to specify which character in haystack to start searching. The position returned is still relative to the beginning of haystack.

Returns

Definition at line 54 of file String.php.

static strrpos	(	$haystack,
		$needle,
		$offset = `0`
	)

static

Returns the numeric position of the last occurrence of needle in the haystack string.

Note that the needle in this case can only be a single character in PHP 4. If a string is passed as the needle, then only the first character of that string will be used.

Parameters

string	$haystack	The string to search in
string	$needle	If needle is not a string, it is converted to an integer and applied as the ordinal value of a character.
integer	$offset	May be specified to begin searching an arbitrary number of characters into the string. Negative values will stop searching at an arbitrary point prior to the end of the string.

Returns

Definition at line 76 of file String.php.

static strtolower ( $string )

static

Returns string with all alphabetic characters converted to lowercase.

Parameters

string $string The input string.

Returns

Definition at line 135 of file String.php.

static strtoupper ( $string )

static

Returns string with all alphabetic characters converted to uppercase.

Parameters

string $string The input string.

Returns

Definition at line 154 of file String.php.

static substr	(	$string,
		$start,
		$length = `null`
	)

static

Returns the portion of string specified by the start and length parameters.

Parameters

string	$string
integer	$start
integer	$length

Returns

Definition at line 112 of file String.php.

static substr_count	(	$string,
		$searched
	)

static

Returns the number of times the needle substring occurs in the haystack string.

Please note that needle is case sensitive. WARNING : This functions has only 2 arguments, as the mb_substr_count has less arguments than the non-multibyte function substr_count

Parameters

string	$string	The input string.
integer	$searched

Returns

Definition at line 194 of file String.php.

static textEncode	(	$string,
		$suppr_endline = `false`,
		$encode_only_isolated_amperstands = `false`
	)

static

Méthode de compatibilité avec anciennes versions de PEEL utilisant textEncode au lieu de htmlentities.

Parameters

mixed	$string
boolean	$suppr_endline
boolean	$encode_only_isolated_amperstands

Returns

Definition at line 468 of file String.php.

static ucfirst ( $string )

static

Returns string with first letter uppercase.

Parameters

string $string The input string.

Returns

Definition at line 173 of file String.php.

static utf8_encode ( $string )

static

Si vous avez des utilisateurs sous windows qui saisissent du contenu dans une interface qui l'insère dans une base en ISO-88591 vous risquez d'avoir des surprises.

Cette fonction permet de "nettoyer" l'encodage windows cp1552 en iso-88591 propre*

Parameters

mixed $string

Returns

Definition at line 602 of file String.php.

The documentation for this class was generated from the following file:

lib/class/String.php

Static Public Member Functions

Detailed Description

Member Function Documentation