Documentation du code de SPIP et de ses plugins

SPIP

texte_mini.php

Table of Contents

Functions

definir_puce()  : string
Retourne une image d'une puce
spip_balisage_code()  : string
Preparer le markup html pour les extraits de code en ligne ou en bloc
code_echappement()  : string
Echapper les elements perilleux en les passant en base64
traiter_echap_html_dist()  : mixed
traiter_echap_pre_dist()  : mixed
traiter_echap_code_dist()  : mixed
traiter_echap_cadre_dist()  : mixed
traiter_echap_frame_dist()  : mixed
traiter_echap_script_dist()  : mixed
echappe_html()  : string|array<string|int, string>
pour $source voir commentaire infra (echappe_retour)
echappe_retour()  : array<string|int, mixed>|mixed|string|array<string|int, string>
Traitement final des echappements Rq: $source sert a faire des echappements "a soi" qui ne sont pas nettoyes par propre() : exemple dans multi et dans typo()
echappe_retour_modeles()  : mixed
couper()  : string
Coupe un texte à une certaine longueur.
protege_js_modeles()  : mixed
echapper_faux_tags()  : mixed
echapper_html_suspect()  : string
Si le html contenu dans un texte ne passe pas sans transformation a travers safehtml on l'echappe si safehtml ne renvoie pas la meme chose on echappe les < en &lt; pour montrer le contenu brut
safehtml()  : string
Sécurise un texte HTML
is_html_safe()  : bool
Detecter si un texte est "safe" ie non modifie significativement par safehtml()
supprime_img()  : string
Supprime les modèles d'image d'un texte

Functions

definir_puce()

Retourne une image d'une puce

definir_puce() : string

Le nom de l'image est déterminé par la globale 'puce' ou 'puce_prive' ou les mêmes suffixées de '_rtl' pour ce type de langues.

Tags
note

On initialise la puce pour éviter find_in_path() à chaque rencontre de \n- Mais attention elle depend de la direction et de X_fonctions.php, ainsi que de l'espace choisi (public/prive)

Return values
string

Code HTML de la puce

spip_balisage_code()

Preparer le markup html pour les extraits de code en ligne ou en bloc

spip_balisage_code(string $corps[, bool $bloc = false ][, string $attributs = '' ][, string $langage = '' ]) : string
Parameters
$corps : string
$bloc : bool = false
$attributs : string = ''
$langage : string = ''
Return values
string

code_echappement()

Echapper les elements perilleux en les passant en base64

code_echappement(string $rempl[, string $source = '' ][, bool $no_transform = false ][, string|null $mode = null ]) : string

Creer un bloc base64 correspondant a $rempl ; au besoin en marquant une $source differente ; le script detecte automagiquement si ce qu'on echappe est un div ou un span

Parameters
$rempl : string
$source : string = ''
$no_transform : bool = false
$mode : string|null = null
Tags
used-by
traiter_math()
Return values
string

traiter_echap_html_dist()

traiter_echap_html_dist(mixed $regs[, mixed $options = [] ]) : mixed
Parameters
$regs : mixed
$options : mixed = []

traiter_echap_pre_dist()

traiter_echap_pre_dist(mixed $regs[, mixed $options = [] ]) : mixed
Parameters
$regs : mixed
$options : mixed = []

traiter_echap_code_dist()

traiter_echap_code_dist(mixed $regs[, mixed $options = [] ]) : mixed
Parameters
$regs : mixed
$options : mixed = []

traiter_echap_cadre_dist()

traiter_echap_cadre_dist(mixed $regs[, mixed $options = [] ]) : mixed
Parameters
$regs : mixed
$options : mixed = []

traiter_echap_frame_dist()

traiter_echap_frame_dist(mixed $regs[, mixed $options = [] ]) : mixed
Parameters
$regs : mixed
$options : mixed = []

traiter_echap_script_dist()

traiter_echap_script_dist(mixed $regs[, mixed $options = [] ]) : mixed
Parameters
$regs : mixed
$options : mixed = []

echappe_html()

pour $source voir commentaire infra (echappe_retour)

echappe_html(string $letexte[, string $source = '' ][, bool $no_transform = false ][, array<string|int, mixed>|null $html_tags = null ][, string $callback_prefix = '' ][, array<string|int, mixed> $callback_options = [] ]) : string|array<string|int, string>
Parameters
$letexte : string
$source : string = ''
$no_transform : bool = false

déprécié, cet argument ne doit plus être utilisé, utiliser directement Spip\Texte\Collecteur\HtmlTag::proteger_balisesHtml dans ce cas

$html_tags : array<string|int, mixed>|null = null

le passage d'une preg au format string est déprécié

$callback_prefix : string = ''
$callback_options : array<string|int, mixed> = []
Tags
used-by
entites_html()
used-by
post_autobr()
used-by
propre()
Return values
string|array<string|int, string>

echappe_retour()

Traitement final des echappements Rq: $source sert a faire des echappements "a soi" qui ne sont pas nettoyes par propre() : exemple dans multi et dans typo()

echappe_retour(string $letexte[, string $source = '' ][, string $filtre = '' ]) : array<string|int, mixed>|mixed|string|array<string|int, string>
Parameters
$letexte : string
$source : string = ''
$filtre : string = ''
Tags
used-by
entites_html()
used-by
post_autobr()
Return values
array<string|int, mixed>|mixed|string|array<string|int, string>

echappe_retour_modeles()

echappe_retour_modeles(mixed $letexte[, mixed $interdire_scripts = false ]) : mixed
Parameters
$letexte : mixed
$interdire_scripts : mixed = false
Tags
used-by
propre()

couper()

Coupe un texte à une certaine longueur.

couper(string $texte[, int $taille = 50 ][, string $suite = null ]) : string

Il essaie de ne pas couper les mots et enlève le formatage du texte. Si le texte original est plus long que l’extrait coupé, alors des points de suite sont ajoutés à l'extrait, tel que (…).

Parameters
$texte : string

texte à couper

$taille : int = 50

Taille de la coupe

$suite : string = null

Points de suite ajoutés.

Tags
note

Les points de suite ne sont pas ajoutés sur les extraits très courts.

filtre
link
https://www.spip.net/4275
Return values
string

texte coupé

protege_js_modeles()

protege_js_modeles(mixed $texte) : mixed
Parameters
$texte : mixed

echapper_faux_tags()

echapper_faux_tags(mixed $letexte) : mixed
Parameters
$letexte : mixed
Tags
used-by
typo()

echapper_html_suspect()

Si le html contenu dans un texte ne passe pas sans transformation a travers safehtml on l'echappe si safehtml ne renvoie pas la meme chose on echappe les < en &lt; pour montrer le contenu brut

echapper_html_suspect(string $texte[, array<string|int, mixed> $options = [] ][, string $connect = null ][, array<string|int, mixed> $env = [] ]) : string
Parameters
$texte : string
$options : array<string|int, mixed> = []

bool strict : etre strict ou non sur la detection string wrap_suspect : si le html est suspect, on wrap l'affichage avec la balise indiquee dans cette option via la fonction wrap() string texte_source_affiche : si le html est suspect, on utilise ce texte pour l'affichage final et pas le texte utilise pour la detection

$connect : string = null
$env : array<string|int, mixed> = []
Tags
use

wrap()

Return values
string

safehtml()

Sécurise un texte HTML

safehtml(string $t) : string

Échappe le code PHP et JS. Applique en plus safehtml si un plugin le définit dans inc/safehtml.php

Permet de protéger les textes issus d'une origine douteuse (forums, syndications...)

Parameters
$t : string

texte à sécuriser

Tags
filtre
link
https://www.spip.net/4310
Return values
string

texte sécurisé

is_html_safe()

Detecter si un texte est "safe" ie non modifie significativement par safehtml()

is_html_safe(string $texte) : bool
Parameters
$texte : string
Return values
bool

supprime_img()

Supprime les modèles d'image d'un texte

supprime_img(string $letexte[, string|null $message = null ]) : string

Fonction en cas de texte extrait d'un serveur distant: on ne sait pas (encore) rapatrier les documents joints Sert aussi à nettoyer un texte qu'on veut mettre dans un <a> etc.

Parameters
$letexte : string

texte à nettoyer

$message : string|null = null

Message de remplacement pour chaque image enlevée

Tags
todo

gérer les autres modèles ?

Return values
string

texte sans les modèles d'image


        
On this page

Search results