Barre_outils
in package
Objet contenant les différents paramètres definissant une barre d'outils Markitup et permettant d'agir dessus
Tags
Table of Contents
Properties
- $afterInsert : string
- Option de markitup : Code JS à exécuter après une insertion
- $beforeInsert : string
- Option de markitup : Code JS à exécuter avant une insertion
- $functions : string
- Fonctions JS supplémentaires à écrire après la déclaration JSON des outils. Ces fonctions peuvent servir aux boutons.
- $id : string
- Identifiant HTML de la barre
- $lang : string
- Langue
- $markupSet : array<string|int, mixed>
- Description des outils/boutons et leurs sous boutons éventuels
- $nameSpace : string
- Nom de la barre d'outil
- $onCtrlEnter : array<string|int, mixed>
- Option de markitup : que faire sur l'appuie de Control+Entrée ?
- $onEnter : array<string|int, mixed>
- Option de markitup : que faire sur l'appuie de Entrée ?
- $onShiftEnter : array<string|int, mixed>
- Option de markitup : que faire sur l'appuie de Shift+Entrée ?
- $onTab : array<string|int, mixed>
- Option de markitup : que faire sur l'appuie d'une tabulation ?
- $previewAutoRefresh : bool
- Option de markitup : rafraîchir la prévisu ?
- $previewParserPath : bool
- Option de markitup : nom de la fonction de prévisu
- $_liste_params_autorises : array<string|int, mixed>
- Liste des paramètres valides pour une description d'outils (markupSet)
Methods
- __construct() : void
- Constructeur
- affecter() : array<string|int, mixed>|bool
- Permet d'affecter des paramètres à un élément de la barre
- affecter_a_tous() : bool
- Permet d'affecter des paramètres à tous les éléments de la barre ou à une liste d'identifiants d'éléments indiqués.
- afficher() : bool|array<string|int, mixed>
- Affiche le ou les boutons demandés
- afficherTout() : bool
- Affiche tous les boutons
- ajouterApres() : array<string|int, mixed>|bool
- Ajoute un bouton ou quelque chose, après un autre déjà présent
- ajouterAvant() : array<string|int, mixed>|bool
- Ajoute un bouton ou quelque chose, avant un autre déjà présent
- ajouterFonction() : void
- Ajoute une fonction JS qui pourra être utilisée par les boutons
- ajouterPlusieursApres() : array<string|int, mixed>|bool
- Ajoute plusieurs boutons, après un autre déjà présent
- ajouterPlusieursAvant() : array<string|int, mixed>|bool
- Ajoute plusieurs boutons, avant un autre déjà présent
- cacher() : bool|array<string|int, mixed>
- Cache le ou les boutons demandés
- cacherTout() : bool
- Cache tous les boutons
- creer_json() : string
- Crée la sortie json pour le javascript des paramètres de la barre
- echapper_appels_fonctions() : mixed
- enlever_elements_non_affiches() : void
- Supprimer les éléments non affichés (display:false) Et les séparateurs (li vides) selon la configuration
- enlever_parametres_inutiles() : mixed
- Supprime les éléments vides (uniquement à la racine de l'objet) et uniquement si chaîne ou tableau.
- enlever_separateurs() : void
- Enlève les séparateurs pour améliorer l'accessibilité au détriment du stylage possible de ces séparateurs.
- get() : bool|array<string|int, mixed>
- Retourne les parametres du bouton demande
- set() : bool|array<string|int, mixed>
- Affecte les valeurs des paramètres indiqués au bouton demandé et retourne l'ensemble des paramètres du bouton (sinon false)
- verif_params() : array<string|int, mixed>
- Vérifie que les paramètres d'une clé existent et retourne un tableau des paramètres valides
Properties
$afterInsert
Option de markitup : Code JS à exécuter après une insertion
public
string
$afterInsert
= ''
$beforeInsert
Option de markitup : Code JS à exécuter avant une insertion
public
string
$beforeInsert
= ''
$functions
Fonctions JS supplémentaires à écrire après la déclaration JSON des outils. Ces fonctions peuvent servir aux boutons.
public
string
$functions
= ''
$id
Identifiant HTML de la barre
public
string
$id
= ''
Tags
$lang
Langue
public
string
$lang
= ''
Tags
$markupSet
Description des outils/boutons et leurs sous boutons éventuels
public
array<string|int, mixed>
$markupSet
= []
$nameSpace
Nom de la barre d'outil
public
string
$nameSpace
= ''
$onCtrlEnter
Option de markitup : que faire sur l'appuie de Control+Entrée ?
public
array<string|int, mixed>
$onCtrlEnter
= []
$onEnter
Option de markitup : que faire sur l'appuie de Entrée ?
public
array<string|int, mixed>
$onEnter
= []
$onShiftEnter
Option de markitup : que faire sur l'appuie de Shift+Entrée ?
public
array<string|int, mixed>
$onShiftEnter
= []
Tags
$onTab
Option de markitup : que faire sur l'appuie d'une tabulation ?
public
array<string|int, mixed>
$onTab
= []
$previewAutoRefresh
Option de markitup : rafraîchir la prévisu ?
public
bool
$previewAutoRefresh
= \false
Tags
$previewParserPath
Option de markitup : nom de la fonction de prévisu
public
bool
$previewParserPath
= ''
Tags
$_liste_params_autorises
Liste des paramètres valides pour une description d'outils (markupSet)
private
array<string|int, mixed>
$_liste_params_autorises
= [
'replaceWith',
'openWith',
'closeWith',
'openBlockWith',
// sur multiline, avant les lignes selectionnees
'closeBlockWith',
// sur multiline, apres les lignes selectionnees
'placeHolder',
// remplace par ce texte lorsqu'il n'y a pas de selection
'beforeInsert',
// avant l'insertion
'afterInsert',
// apres l'insertion
'beforeMultiInsert',
'afterMultiInsert',
'dropMenu',
// appelle un sous menu
'name',
// nom affiche au survol
'key',
// raccourcis clavier
'className',
// classe css utilisee
'lang',
// langues dont le bouton doit apparaitre - array
'lang_not',
// langues dont le bouton ne doit pas apparaitre - array
'selectionType',
// '','word','line' : type de selection (normale, aux mots les plus proches, a la ligne la plus proche)
'multiline',
// open/close sur chaque ligne (mais replace est applique sur l'ensemble de la selection)
'forceMultiline',
// pour faire comme si on faisait systematiquement un control+shift
// (et replace est applique sur chaque ligne de la selection)
'separator',
'call',
'keepDefault',
// cacher ou afficher facilement des boutons
'display',
// donner un identifiant unique au bouton (pour le php)
'id',
]
Methods
__construct()
Constructeur
public
__construct([array<string|int, mixed> $params = [] ]) : void
Initialise la barre avec les paramètres transmis en n'adressant que les paramètres effectivement valides
Parameters
- $params : array<string|int, mixed> = []
-
Paramètres de la barre d'outil
affecter()
Permet d'affecter des paramètres à un élément de la barre
public
affecter(array<string|int, mixed> &$tableau, string $identifiant[, array<string|int, mixed> $params = [] ][, string $lieu = 'dedans' ][, bool $plusieurs = false ]) : array<string|int, mixed>|bool
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
Parameters
- $tableau : array<string|int, mixed>
-
Tableau ou chercher les elements (sert pour la recursion)
- $identifiant : string
-
Identifiant du bouton a afficher
- $params : array<string|int, mixed> = []
-
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)
- $lieu : string = 'dedans'
-
Lieu d'affectation des paramètres (dedans, avant, apres)
- $plusieurs : bool = false
-
Définit si $params est une forme simple (tableau cle/valeur) ou comporte plusieurs boutons (tableau de tableaux cle/valeur).
Return values
array<string|int, mixed>|bool —Paramètres de l'élément modifié ou paramètres ajoutés False si l'identifiant cherché n'est pas trouvé
affecter_a_tous()
Permet d'affecter des paramètres à tous les éléments de la barre ou à une liste d'identifiants d'éléments indiqués.
public
affecter_a_tous(array<string|int, mixed> &$tableau[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $ids = [] ]) : bool
Parameters
- $tableau : array<string|int, mixed>
-
Tableau où chercher les éléments
- $params : array<string|int, mixed> = []
-
Paramètres à affecter aux éléments
- $ids : array<string|int, mixed> = []
-
Tableau d'identifiants particuliers à qui on affecte les paramètres. Si vide, tous les identifiants seront modifiés
Return values
bool —false si aucun paramètre à affecter, true sinon.
afficher()
Affiche le ou les boutons demandés
public
afficher(string|array<string|int, mixed> $identifiant) : bool|array<string|int, mixed>
Parameters
- $identifiant : string|array<string|int, mixed>
-
Identifiant du ou des boutons
Return values
bool|array<string|int, mixed> —false si l'identifiant n'a pas été trouvé true si plusieurs identifiants, array sinon : description de l'identifiant cherché.
afficherTout()
Affiche tous les boutons
public
afficherTout() : bool
Return values
bool —false si aucun paramètre à affecter, true sinon.
ajouterApres()
Ajoute un bouton ou quelque chose, après un autre déjà présent
public
ajouterApres(string $identifiant, array<string|int, mixed> $params) : array<string|int, mixed>|bool
Parameters
- $identifiant : string
-
Identifiant du bouton où l'on doit se situer
- $params : array<string|int, mixed>
-
Paramètres de l'ajout. Description d'un bouton (tableau clé/valeurs).
Return values
array<string|int, mixed>|bool —Paramètres ajoutés après False si l'identifiant cherché n'est pas trouvé
ajouterAvant()
Ajoute un bouton ou quelque chose, avant un autre déjà présent
public
ajouterAvant(string $identifiant, array<string|int, mixed> $params) : array<string|int, mixed>|bool
Parameters
- $identifiant : string
-
Identifiant du bouton où l'on doit se situer
- $params : array<string|int, mixed>
-
Paramètres de l'ajout. Description d'un bouton (tableau clé/valeurs).
Return values
array<string|int, mixed>|bool —Paramètres ajoutés avant False si l'identifiant cherché n'est pas trouvé
ajouterFonction()
Ajoute une fonction JS qui pourra être utilisée par les boutons
public
ajouterFonction(string $fonction) : void
Parameters
- $fonction : string
-
Code de la fonction JS
ajouterPlusieursApres()
Ajoute plusieurs boutons, après un autre déjà présent
public
ajouterPlusieursApres(string $identifiant, array<string|int, mixed> $tableau_params) : array<string|int, mixed>|bool
Parameters
- $identifiant : string
-
Identifiant du bouton où l'on doit se situer
- $tableau_params : array<string|int, mixed>
-
Paramètres de l'ajout. Description de plusieurs boutons (tableau de tableaux clé/valeurs).
Return values
array<string|int, mixed>|bool —Paramètres ajoutés après False si l'identifiant cherché n'est pas trouvé
ajouterPlusieursAvant()
Ajoute plusieurs boutons, avant un autre déjà présent
public
ajouterPlusieursAvant(string $identifiant, array<string|int, mixed> $tableau_params) : array<string|int, mixed>|bool
Parameters
- $identifiant : string
-
Identifiant du bouton où l'on doit se situer
- $tableau_params : array<string|int, mixed>
-
Paramètres de l'ajout. Description de plusieurs boutons (tableau de tableaux clé/valeurs).
Return values
array<string|int, mixed>|bool —Paramètres ajoutés avant False si l'identifiant cherché n'est pas trouvé
cacher()
Cache le ou les boutons demandés
public
cacher(string|array<string|int, mixed> $identifiant) : bool|array<string|int, mixed>
Parameters
- $identifiant : string|array<string|int, mixed>
-
Identifiant du ou des boutons
Return values
bool|array<string|int, mixed> —false si l'identifiant n'a pas été trouvé true si plusieurs identifiants, array sinon : description de l'identifiant cherché.
cacherTout()
Cache tous les boutons
public
cacherTout() : bool
Return values
bool —false si aucun paramètre à affecter, true sinon.
creer_json()
Crée la sortie json pour le javascript des paramètres de la barre
public
creer_json() : string
Return values
string —Déclaration json de la barre
echapper_appels_fonctions()
public
echapper_appels_fonctions(mixed &$tableau[, mixed &$rappels = [] ]) : mixed
Parameters
- $tableau : mixed
- $rappels : mixed = []
enlever_elements_non_affiches()
Supprimer les éléments non affichés (display:false) Et les séparateurs (li vides) selon la configuration
public
enlever_elements_non_affiches(array<string|int, mixed> &$tableau) : void
Parameters
- $tableau : array<string|int, mixed>
-
Tableau de description des outils
enlever_parametres_inutiles()
Supprime les éléments vides (uniquement à la racine de l'objet) et uniquement si chaîne ou tableau.
public
enlever_parametres_inutiles() : mixed
Supprime les paramètres privés Supprime les paramètres inutiles a markitup/json dans les paramètres markupSet (id, display, icone)
enlever_separateurs()
Enlève les séparateurs pour améliorer l'accessibilité au détriment du stylage possible de ces séparateurs.
public
enlever_separateurs(array<string|int, mixed> &$tableau) : void
Le bouton précédent le séparateur reçoit une classe CSS 'separateur_avant' Celui apres 'separateur_apres'
Parameters
- $tableau : array<string|int, mixed>
-
Tableau de description des outils
get()
Retourne les parametres du bouton demande
public
get(string|array<string|int, mixed> $identifiant) : bool|array<string|int, mixed>
Parameters
- $identifiant : string|array<string|int, mixed>
-
Identifiant du ou des boutons.
Return values
bool|array<string|int, mixed> —false si l'identifiant n'est pas trouvé array sinon : Description de l'identifiant cherché.
set()
Affecte les valeurs des paramètres indiqués au bouton demandé et retourne l'ensemble des paramètres du bouton (sinon false)
public
set(string|array<string|int, mixed> $identifiant[, array<string|int, mixed> $params = [] ]) : bool|array<string|int, mixed>
Parameters
- $identifiant : string|array<string|int, mixed>
-
Identifiant du ou des boutons.
- $params : array<string|int, mixed> = []
-
Paramètres de l'ajout (tableau paramètre=>valeur)
Return values
bool|array<string|int, mixed> —false si l'identifiant n'a pas été trouvé true si plusieurs identifiants, array sinon : description de l'identifiant cherché.
verif_params()
Vérifie que les paramètres d'une clé existent et retourne un tableau des paramètres valides
public
verif_params(string $nom[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
- $nom : string
-
Clé à vérifier (ex: 'markupSet')
- $params : array<string|int, mixed> = []
-
Paramètres de cette clé (description des boutons ou sous boutons)
Return values
array<string|int, mixed> —Paramètres, soustrait de ceux qui ne sont pas valides