SPIP Code

Documentation du code de SPIP et de ses plugins

TextWheel pour SPIP

Texte

Table of Contents

_AUTOBR_IGNORER  = \_AUTOBR ? '<!-- ig br -->' : ''
_RACCOURCI_BALISE  = ',</?[a-z!][^<>]*[' . \preg_quote(\_RACCOURCI_PROTEGER) . '][^<>]*>,imsS'
_RACCOURCI_PROTECTEUR  = "\x01\x02\x03\x04"
_RACCOURCI_PROTEGER  = '{}_-'
_RACCOURCI_TH_SPAN  = '\\s*(:?{{[^{}]+}}\\s*)?|<'
_TYPO_BALISE  = ',</?[a-z!][^<>]*[' . \preg_quote(\_TYPO_PROTEGER) . '][^<>]*>,imsS'
_TYPO_PROTECTEUR  = "\x01\x02\x03\x04\x05\x06\x07\x08"
_TYPO_PROTEGER  = "!':;?~%-"
echappe_js()  : string
Échapper et affichier joliement les `<script` .
paragrapher()  : string
Paragrapher seulement
interdire_scripts()  : string
Empêcher l'exécution de code PHP et JS
typo()  : string
Applique la typographie générale
corriger_typo()  : string
Corrige la typographie
traiter_tableau()  : string
Traitement des raccourcis de tableaux
traiter_listes()  : string
Traitement des listes
personnaliser_raccourcis()  : string
mais d'abord, une callback de reconfiguration des raccourcis a partir de globales (est-ce old-style ? on conserve quand meme par souci de compat ascendante)
traiter_raccourcis()  : string
Nettoie un texte, traite les raccourcis autre qu'URL, la typo, etc.
propre()  : string
Transforme les raccourcis SPIP, liens et modèles d'un texte en code HTML
safe_ecrire_traiter_echap_html_dist()  : mixed
safe_public_traiter_echap_html_dist()  : mixed
safe_ecrire_traiter_echap_script_dist()  : mixed
safe_public_traiter_echap_script_dist()  : mixed

Constants

_AUTOBR_IGNORER

public mixed _AUTOBR_IGNORER = \_AUTOBR ? '<!-- ig br -->' : ''

_RACCOURCI_BALISE

public mixed _RACCOURCI_BALISE = ',</?[a-z!][^<>]*[' . \preg_quote(\_RACCOURCI_PROTEGER) . '][^<>]*>,imsS'

_RACCOURCI_PROTECTEUR

public mixed _RACCOURCI_PROTECTEUR = "\x01\x02\x03\x04"

_RACCOURCI_PROTEGER

public mixed _RACCOURCI_PROTEGER = '{}_-'

_RACCOURCI_TH_SPAN

public mixed _RACCOURCI_TH_SPAN = '\\s*(:?{{[^{}]+}}\\s*)?|<'

_TYPO_BALISE

public mixed _TYPO_BALISE = ',</?[a-z!][^<>]*[' . \preg_quote(\_TYPO_PROTEGER) . '][^<>]*>,imsS'

_TYPO_PROTECTEUR

public mixed _TYPO_PROTECTEUR = "\x01\x02\x03\x04\x05\x06\x07\x08"

_TYPO_PROTEGER

public mixed _TYPO_PROTEGER = "!':;?~%-"

Functions

echappe_js()

Échapper et affichier joliement les `<script` .

echappe_js(string $t) : string

..

Parameters
$t : string
Return values
string —

paragrapher()

Paragrapher seulement

paragrapher(string $t[, null $toujours_paragrapher = null ]) : string

Fermer les paragraphes ; Essaie de préserver des paragraphes indiqués à la main dans le texte (par ex: on ne modifie pas un <p align='center'>)

Parameters
$t : string

Le texte

$toujours_paragrapher : null = null

true pour forcer les <p> même pour un seul paragraphe

Return values
string —

Texte paragraphé

interdire_scripts()

Empêcher l'exécution de code PHP et JS

interdire_scripts(string $arg[, int $mode_filtre = null ]) : string

Sécurité : empêcher l'exécution de code PHP, en le transformant en joli code dans l'espace privé. Cette fonction est aussi appelée par propre et typo.

De la même manière, la fonction empêche l'exécution de JS mais selon le mode de protection passe en argument

Il ne faut pas désactiver globalement la fonction dans l'espace privé car elle protège aussi les balises des squelettes qui ne passent pas forcement par propre ou typo après si elles sont appelées en direct

Parameters
$arg : string

Code à protéger

$mode_filtre : int = null

Mode de protection -1 : protection dans l'espace privé et public 0 : protection dans l'espace public 1 : aucune protection utilise la valeur de la globale filtrer_javascript si non fourni

Return values
string —

Code protégé

typo()

Applique la typographie générale

typo(string $letexte[, bool $echapper = true ][, string|null $connect = null ][, array<string|int, mixed> $env = [] ]) : string

Effectue un traitement pour que les textes affichés suivent les règles de typographie. Fait une protection préalable des balises HTML et SPIP. Transforme les balises <multi>

Parameters
$letexte : string

Texte d'origine

$echapper : bool = true

Échapper ?

$connect : string|null = null

Nom du connecteur à la bdd

$env : array<string|int, mixed> = []

Environnement (pour les calculs de modèles)

Tags
filtre
uses
traiter_modeles()
uses
corriger_typo()
uses
echapper_faux_tags()
see
propre()
Return values
string —

$t Texte transformé

corriger_typo()

Corrige la typographie

corriger_typo(string $t[, string $lang = '' ]) : string

Applique les corrections typographiques adaptées à la langue indiquée.

Parameters
$t : string

Texte

$lang : string = ''

Langue

Tags
pipeline_appel

pre_typo

pipeline_appel

post_typo

uses
corriger_caracteres()
uses
corriger_caracteres()
Return values
string —

Texte

traiter_tableau()

Traitement des raccourcis de tableaux

traiter_tableau(string $bloc) : string
Parameters
$bloc : string
Return values
string —

traiter_listes()

Traitement des listes

traiter_listes(string $t) : string

On utilise la wheel correspondante

Parameters
$t : string
Return values
string —

personnaliser_raccourcis()

mais d'abord, une callback de reconfiguration des raccourcis a partir de globales (est-ce old-style ? on conserve quand meme par souci de compat ascendante)

personnaliser_raccourcis( &$ruleset) : string
Parameters
$ruleset :
Return values
string —

traiter_raccourcis()

Nettoie un texte, traite les raccourcis autre qu'URL, la typo, etc.

traiter_raccourcis(string $t[, bool $show_autobr = false ]) : string
Parameters
$t : string
$show_autobr : bool = false
Tags
pipeline_appel

pre_propre

pipeline_appel

post_propre

Return values
string —

propre()

Transforme les raccourcis SPIP, liens et modèles d'un texte en code HTML

propre(string $t[, string|null $connect = null ][, array<string|int, mixed> $env = [] ]) : string

Filtre à appliquer aux champs du type #TEXTE*

Parameters
$t : string

Texte avec des raccourcis SPIP

$connect : string|null = null

Nom du connecteur à la bdd

$env : array<string|int, mixed> = []

Environnement (pour les calculs de modèles)

Tags
filtre
uses
echappe_html()
uses
expanser_liens()
uses
traiter_raccourcis()
uses
echappe_retour_modeles()
see
typo()
Return values
string —

$t Texte transformé

safe_ecrire_traiter_echap_html_dist()

safe_ecrire_traiter_echap_html_dist(mixed $regs, mixed $options) : mixed
Parameters
$regs : mixed
$options : mixed
Return values
mixed —

safe_public_traiter_echap_html_dist()

safe_public_traiter_echap_html_dist(mixed $regs, mixed $options) : mixed
Parameters
$regs : mixed
$options : mixed
Return values
mixed —

safe_ecrire_traiter_echap_script_dist()

safe_ecrire_traiter_echap_script_dist(mixed $regs, mixed $options) : mixed
Parameters
$regs : mixed
$options : mixed
Return values
mixed —

safe_public_traiter_echap_script_dist()

safe_public_traiter_echap_script_dist(mixed $regs, mixed $options) : mixed
Parameters
$regs : mixed
$options : mixed
Return values
mixed —

Search results