porte_plume_fonctions.php
Fonctions utiles pour le Porte Plume
Tags
Table of Contents
Classes
- Barre_outils
- Objet contenant les différents paramètres definissant une barre d'outils Markitup et permettant d'agir dessus
Functions
- barre_outils_css_icones() : string
- Crée le code CSS pour les images des icones des barres d'outils
- barre_outils_initialiser() : Barre_Outils|bool
- Retourne une instance de Barre_outils crée à partir du type de barre demandé
- barre_outils_liste() : array<string|int, mixed>|bool
- Retourne la liste des barres d'outils connues
- traitements_previsu() : string
- Filtre appliquant les traitements SPIP d'un champ
- traitements_previsu_php_modeles_eval() : false|string
- Evaluer le PHP des modèles dans la previsu
- porte_plume_creer_json_markitup() : string
- Retourne la définition de la barre markitup désignée.
Functions
barre_outils_css_icones()
Crée le code CSS pour les images des icones des barres d'outils
barre_outils_css_icones() : string
S'appuie sur la description des jeux de barres disponibles et cherche une fonction barre_outils_($barre)_icones pour chaque barre et l'exécute si existe, attendant alors en retour un tableau de couples : nom de l'outil => nom de l'image
Tags
Return values
string —Déclaration CSS des icones
barre_outils_initialiser()
Retourne une instance de Barre_outils crée à partir du type de barre demandé
barre_outils_initialiser(string $set) : Barre_Outils|bool
Une fonction barre_outils_{type}_dist() retournant la barre doit donc exister.
Parameters
- $set : string
-
Type de barre (ex: 'edition')
Return values
Barre_Outils|bool —La barre d'outil si la fonction a été trouvée, false sinon
barre_outils_liste()
Retourne la liste des barres d'outils connues
barre_outils_liste() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —Tableau des noms de barres d'outils trouvées False si on ne trouve aucune barre.
traitements_previsu()
Filtre appliquant les traitements SPIP d'un champ
traitements_previsu(string $texte[, string $nom_champ = '' ][, string $type_objet = '' ][, string $connect = null ]) : string
Applique les filtres prévus sur un champ (et eventuellement un type d'objet) sur un texte donné. Sécurise aussi le texte en appliquant safehtml().
Ce mécanisme est à préférer au traditionnel #TEXTE*|propre
traitements_previsu() consulte la globale $table_des_traitements et applique le traitement adequat. Si aucun traitement n'est trouvé, alors propre() est appliqué.
Parameters
- $texte : string
-
Texte source
- $nom_champ : string = ''
-
Nom du champ (nom de la balise, en majuscules)
- $type_objet : string = ''
-
L'objet a qui appartient le champ (en minuscules)
- $connect : string = null
-
Nom du connecteur de base de données
Tags
Return values
string —Texte traité avec les filtres déclarés pour le champ.
traitements_previsu_php_modeles_eval()
Evaluer le PHP des modèles dans la previsu
traitements_previsu_php_modeles_eval(mixed $php) : false|string
Parameters
- $php : mixed
Return values
false|stringporte_plume_creer_json_markitup()
Retourne la définition de la barre markitup désignée.
porte_plume_creer_json_markitup() : string
(cette déclaration est au format json)
Deux pipelines 'porte_plume_pre_charger' et 'porte_plume_charger' permettent de récuperer l'objet de classe Barre_outil avant son export en json pour modifier des elements.
Tags
Return values
string —Déclaration json