Classe \Barre_outils

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

Example

  • $barre = new Barre_Outil($description);

Source

Liste des propriétés

array _liste_params_autorises = array('replaceWith', 'openWith', 'closeWith', 'openBlockWith', 'closeBlockWith', 'placeHolder', 'beforeInsert', 'afterInsert', 'beforeMultiInsert', 'afterMultiInsert', 'dropMenu', 'name', 'key', 'className', 'lang', 'lang_not', 'selectionType', 'multiline', 'forceMultiline', 'separator', 'call', 'keepDefault', 'display', 'id')
string id = ''

Todo

  • À supprimer car non utilisé !
string lang = ''

Todo

  • À supprimer car non utilisé !
array onShiftEnter = array()

Exemples

  • 'replaceWith'=>"\n_ ")
boolean previewAutoRefresh = false

Todo

  • À supprimer car non utilisé !
boolean previewParserPath = ''

Todo

  • À supprimer car on le redéfini dans l'appel javascript !

Liste des méthodes

Initialise la barre avec les paramètres transmis en n'adressant que les paramètres effectivement valides

void __construct( array $params = array() )

Paramètres

  1. array $params = array()

    Paramètres de la barre d'outil

Retour

  • void

API

Proposer une amélioration

La fonction retourne les paramètres, de sorte qu'on peut s'en servir pour simplement récupérer ceux-ci.

Il est possible d'affecter des paramètres avant/après l'élément trouvé en definisant une valeur différente pour le $lieu : 'dedans','avant','apres' par defaut 'dedans' (modifie l'élément trouvé).

Lorsqu'on demande d'insérer avant ou après, la fonction retourne les paramètres inserés

array | boolean affecter( array & $tableau , string $identifiant , array $params = array() , string $lieu = 'dedans' , boolean $plusieurs = false )

Paramètres

  1. array & $tableau

    Tableau ou chercher les elements (sert pour la recursion)

  2. string $identifiant

    Identifiant du bouton a afficher

  3. array $params = array()

    Paramètres à affecter à la trouvaille (ou avant ou après). Peut être un tableau clé/valeur ou un tableau de tableaux clé/valeur (sauf pour $lieu = dedans)

  4. string $lieu = 'dedans'

    Lieu d'affectation des paramètres (dedans, avant, apres)

  5. boolean $plusieurs = false

    Définit si $params est une forme simple (tableau cle/valeur) ou comporte plusieurs boutons (tableau de tableaux cle/valeur).

Retour

  • array | boolean

    Paramètres de l'élément modifié ou paramètres ajoutés False si l'identifiant cherché n'est pas trouvé

Proposer une amélioration
boolean affecter_a_tous( array & $tableau , array $params = array() , array $ids = array() )

Paramètres

  1. array & $tableau

    Tableau où chercher les éléments

  2. array $params = array()

    Paramètres à affecter aux éléments

  3. array $ids = array()

    Tableau d'identifiants particuliers à qui on affecte les paramètres. Si vide, tous les identifiants seront modifiés

Retour

  • boolean

    false si aucun paramètre à affecter, true sinon.

Proposer une amélioration
boolean | array afficher( string | array $identifiant )

Paramètres

  1. string | array $identifiant

    Identifiant du ou des boutons

Retour

  • boolean | array

    false si l'identifiant n'a pas été trouvé true si plusieurs identifiants, array sinon : description de l'identifiant cherché.

API

Proposer une amélioration
boolean afficherTout( )

Retour

  • boolean

    false si aucun paramètre à affecter, true sinon.

API

Proposer une amélioration
array | boolean ajouterApres( string $identifiant , array $params )

Paramètres

  1. string $identifiant

    Identifiant du bouton où l'on doit se situer

  2. array $params

    Paramètres de l'ajout. Description d'un bouton (tableau clé/valeurs).

Retour

  • array | boolean

    Paramètres ajoutés après False si l'identifiant cherché n'est pas trouvé

API

Proposer une amélioration
array | boolean ajouterAvant( string $identifiant , array $params )

Paramètres

  1. string $identifiant

    Identifiant du bouton où l'on doit se situer

  2. array $params

    Paramètres de l'ajout. Description d'un bouton (tableau clé/valeurs).

Retour

  • array | boolean

    Paramètres ajoutés avant False si l'identifiant cherché n'est pas trouvé

API

Proposer une amélioration
void ajouterFonction( string $fonction )

Paramètres

  1. string $fonction

    Code de la fonction JS

Retour

  • void

API

Proposer une amélioration
array | boolean ajouterPlusieursApres( string $identifiant , array $tableau_params )

Paramètres

  1. string $identifiant

    Identifiant du bouton où l'on doit se situer

  2. array $tableau_params

    Paramètres de l'ajout. Description de plusieurs boutons (tableau de tableaux clé/valeurs).

Retour

  • array | boolean

    Paramètres ajoutés après False si l'identifiant cherché n'est pas trouvé

API

Proposer une amélioration
array | boolean ajouterPlusieursAvant( string $identifiant , array $tableau_params )

Paramètres

  1. string $identifiant

    Identifiant du bouton où l'on doit se situer

  2. array $tableau_params

    Paramètres de l'ajout. Description de plusieurs boutons (tableau de tableaux clé/valeurs).

Retour

  • array | boolean

    Paramètres ajoutés avant False si l'identifiant cherché n'est pas trouvé

API

Proposer une amélioration
boolean | array cacher( string | array $identifiant )

Paramètres

  1. string | array $identifiant

    Identifiant du ou des boutons

Retour

  • boolean | array

    false si l'identifiant n'a pas été trouvé true si plusieurs identifiants, array sinon : description de l'identifiant cherché.

API

Proposer une amélioration
boolean cacherTout( )

Retour

  • boolean

    false si aucun paramètre à affecter, true sinon.

API

Proposer une amélioration
void echapper_appels_fonctions( & $tableau , & $rappels = array() )

Paramètres

  1. & $tableau
  2. & $rappels = array()
Proposer une amélioration
void enlever_elements_non_affiches( array & $tableau )

Paramètres

  1. array & $tableau

    Tableau de description des outils

Retour

  • void
Proposer une amélioration

Supprime les paramètres privés Supprime les paramètres inutiles a markitup/json dans les paramètres markupSet (id, display, icone)

void enlever_parametres_inutiles( )
Proposer une amélioration

Le bouton précédent le séparateur reçoit une classe CSS 'separateur_avant' Celui apres 'separateur_apres'

void enlever_separateurs( array & $tableau )

Paramètres

  1. array & $tableau

    Tableau de description des outils

Retour

  • void
Proposer une amélioration
boolean | array get( string | array $identifiant )

Paramètres

  1. string | array $identifiant

    Identifiant du ou des boutons.

Retour

  • boolean | array

    false si l'identifiant n'est pas trouvé array sinon : Description de l'identifiant cherché.

API

Proposer une amélioration
boolean | array set( string | array $identifiant , array $params = array() )

Paramètres

  1. string | array $identifiant

    Identifiant du ou des boutons.

  2. array $params = array()

    Paramètres de l'ajout (tableau paramètre=>valeur)

Retour

  • boolean | array

    false si l'identifiant n'a pas été trouvé true si plusieurs identifiants, array sinon : description de l'identifiant cherché.

API

Proposer une amélioration
array verif_params( string $nom , array $params = array() )

Paramètres

  1. string $nom

    Clé à vérifier (ex: 'markupSet')

  2. array $params = array()

    Paramètres de cette clé (description des boutons ou sous boutons)

Retour

  • array

    Paramètres, soustrait de ceux qui ne sont pas valides

Proposer une amélioration