SPIP Code

Documentation du code de SPIP et de ses plugins

Porte plume

API Documentation

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

action_porte_plume_previsu_dist()  : mixed
Action affichant la prévisualisation de porte plume
barre_outils_edition()  : Barre_outils
Définition de la barre 'edition' pour markitup
barre_outils_edition_icones()  : array<string|int, mixed>
Définitions des liens entre css et icones
barre_outils_forum()  : Barre_outils
Définition de la barre 'forum' pour markitup
barre_outils_vide()  : Barre_outils
Définition de la barre 'vide' pour markitup
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.
porte_plume_ieconfig_metas()  : array<string|int, mixed>
Ajoute les metas sauvegardables du porte plume pour le plugin IEConfig
porte_plume_autoriser()  : mixed
Fonction du pipeline autoriser. N'a rien à faire
autoriser_porteplume_previsualiser_dist()  : bool
Autoriser l'action de previsu
autoriser_modelesphp_previsualiser_dist()  : bool
Autoriser a previsualuer le contenu des modeles contenant du PHP dans le porte plume par défaut c'est bloqué, autorisation à ouvrir au cas par cas sur les sites qui en ont vraiment besoin
autoriser_porteplume_afficher_public_dist()  : bool
Autoriser le porte plume dans l'espace public ?
autoriser_porteplume_afficher_prive_dist()  : bool
Autoriser le porte plume dans l'espace prive ?
porte_plume_insert_head_public()  : string
Ajout des scripts du porte-plume dans le head des pages publiques
porte_plume_insert_head_prive()  : string
Ajout des scripts du porte-plume dans le head des pages privées
porte_plume_inserer_head()  : string
Ajout des scripts du porte-plume au texte (un head) transmis
porte_plume_insert_head_prive_css()  : string
Ajout des CSS du porte-plume au head privé
porte_plume_insert_head_css()  : string
Ajout des CSS du porte-plume au head public
porte_plume_configurer_liste_metas()  : array<string|int, mixed>
Valeur par défaut des configurations
porte_plume_affiche_milieu()  : array<string|int, mixed>
Ajoute le formulaire de configuration du porte-plume sur la page des configurations avancées.
filtre_pp_charset()  : string
Retourner le charset SQL

Functions

action_porte_plume_previsu_dist()

Action affichant la prévisualisation de porte plume

action_porte_plume_previsu_dist() : mixed

Pas besoin de sécuriser outre mesure ici, on ne réalise donc qu'un recuperer_fond

On passe par cette action pour éviter les redirection et la perte du $_POST de $forcer_lang=true; cf : ecrire/public.php ligne 80

barre_outils_edition_icones()

Définitions des liens entre css et icones

barre_outils_edition_icones() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Couples identifiant de bouton => nom de l'image (ou tableau nom, position haut, position bas)

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
pipeline_appel

porte_plume_lien_classe_vers_icone

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
see
champs_traitements()

dans public/references.php

global

table_des_traitements

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|string

porte_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
pipeline_appel

porte_plume_barre_pre_charger Charge des nouveaux boutons au besoin

pipeline_appel

porte_plume_barre_charger Affiche ou cache certains boutons

Return values
string —

Déclaration json

porte_plume_ieconfig_metas()

Ajoute les metas sauvegardables du porte plume pour le plugin IEConfig

porte_plume_ieconfig_metas(array<string|int, mixed> $table) : array<string|int, mixed>
Parameters
$table : array<string|int, mixed>

Déclaration des sauvegardes

Tags
pipeline

ieconfig_metas

Return values
array<string|int, mixed> —

Déclaration des sauvegardes complétées

porte_plume_autoriser()

Fonction du pipeline autoriser. N'a rien à faire

porte_plume_autoriser() : mixed
Tags
pipeline

autoriser

autoriser_porteplume_previsualiser_dist()

Autoriser l'action de previsu

autoriser_porteplume_previsualiser_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

La fermer aux non identifiés si pas de porte plume dans le public

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_modelesphp_previsualiser_dist()

Autoriser a previsualuer le contenu des modeles contenant du PHP dans le porte plume par défaut c'est bloqué, autorisation à ouvrir au cas par cas sur les sites qui en ont vraiment besoin

autoriser_modelesphp_previsualiser_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_porteplume_afficher_public_dist()

Autoriser le porte plume dans l'espace public ?

autoriser_porteplume_afficher_public_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_porteplume_afficher_prive_dist()

Autoriser le porte plume dans l'espace prive ?

autoriser_porteplume_afficher_prive_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

porte_plume_insert_head_public()

Ajout des scripts du porte-plume dans le head des pages publiques

porte_plume_insert_head_public(string $flux) : string

Uniquement si l'on est autorisé à l'afficher le porte plume dans l'espace public !

Parameters
$flux : string

Contenu du head

Tags
pipeline

insert_head

Return values
string —

Contenu du head

porte_plume_insert_head_prive()

Ajout des scripts du porte-plume dans le head des pages privées

porte_plume_insert_head_prive(string $flux) : string
Parameters
$flux : string

Contenu du head

Tags
pipeline

header_prive

Return values
string —

Contenu du head

porte_plume_inserer_head()

Ajout des scripts du porte-plume au texte (un head) transmis

porte_plume_inserer_head(string $flux, string $lang[, bool $prive = false ]) : string
Parameters
$flux : string

Contenu du head

$lang : string

Langue en cours d'utilisation

$prive : bool = false

Est-ce pour l'espace privé ?

Return values
string —

Contenu du head complété

porte_plume_insert_head_prive_css()

Ajout des CSS du porte-plume au head privé

porte_plume_insert_head_prive_css(string $flux) : string
Parameters
$flux : string

Contenu du head

Tags
pipeline

header_prive_css

Return values
string —

Contenu du head complété

porte_plume_insert_head_css()

Ajout des CSS du porte-plume au head public

porte_plume_insert_head_css([string $flux = '' ][, bool $prive = false ]) : string

Appelé aussi depuis le privé avec $prive à true.

Parameters
$flux : string = ''

Contenu du head

$prive : bool = false

Est-ce pour l'espace privé ?

Tags
pipeline

insert_head_css

Return values
string —

Contenu du head complété

porte_plume_configurer_liste_metas()

Valeur par défaut des configurations

porte_plume_configurer_liste_metas(array<string|int, mixed> $metas) : array<string|int, mixed>
Parameters
$metas : array<string|int, mixed>

Tableaux des metas et valeurs par défaut

Tags
pipeline

configurer_liste_metas

Return values
array<string|int, mixed> —

Tableaux des metas et valeurs par défaut

porte_plume_affiche_milieu()

Ajoute le formulaire de configuration du porte-plume sur la page des configurations avancées.

porte_plume_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed> —

Données du pipeline

filtre_pp_charset()

Retourner le charset SQL

filtre_pp_charset() : string

Retourne le charset SQL si on le connait, en priorité sinon, on utilise le charset de l'affichage HTML.

Cependant, on peut forcer un charset donné avec une constante : define('PORTE_PLUME_PREVIEW_CHARSET','utf-8');

Return values
string —

Nom du charset (ex: 'utf-8')


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results