Fichier plugins-dist/porte_plume/porte_plume_fonctions.php

Fonctions utiles pour le Porte Plume

Plugin

  • Porte Plume pour SPIP

License

  • GPL

Source

Proposer une amélioration

Liste des fonctions

S'appuie sur la description des jeux de barres disponibles et cherche une fonction barreoutils($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

string barre_outils_css_icones( )

Retour

  • string

    Déclaration CSS des icones

Package

Proposer une amélioration

Une fonction barreoutils{type}_dist() retournant la barre doit donc exister.

\Barre_Outils | boolean barre_outils_initialiser( string $set )

Paramètres

  1. string $set

    Type de barre (ex: 'edition')

Retour

  • \Barre_Outils | boolean

    La barre d'outil si la fonction a été trouvée, false sinon

Package

Proposer une amélioration
array | boolean barre_outils_liste( )

Retour

  • array | boolean

    Tableau des noms de barres d'outils trouvées False si on ne trouve aucune barre.

Package

Proposer une amélioration

(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.

string porte_plume_creer_json_markitup( )

Retour

  • string

    Déclaration json

Package

Proposer une amélioration

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é.

string traitements_previsu( string $texte , string $nom_champ = '' , string $type_objet = '' , string $connect = null )

Paramètres

  1. string $texte

    Texte source

  2. string $nom_champ = ''

    Nom du champ (nom de la balise, en majuscules)

  3. string $type_objet = ''

    L'objet a qui appartient le champ (en minuscules)

  4. string $connect = null

    Nom du connecteur de base de données

Retour

  • string

    Texte traité avec les filtres déclarés pour le champ.

Variables globales

  • table_des_traitements
Proposer une amélioration

Liste des classes

NomDescription
Barre_outils

Objet contenant les différents paramètres definissant une barre d'outils Markitup et permettant d'agir dessus

Liste des marqueurs

Type Ligne Description
TODO 30 À supprimer car non utilisé !
TODO 45 À supprimer car non utilisé !
TODO 53 À supprimer car non utilisé !
TODO 61 À supprimer car on le redéfini dans l'appel javascript !

Liste des erreurs

GravitéLigneDescription
Erreur 646
  • No summary for method echapper_appels_fonctions()
  • Argument $rappels is missing from the Docblock of echapper_appels_fonctions
  • Argument $tableau is missing from the Docblock of echapper_appels_fonctions