Pipelines
Table of Contents
Functions
- f_tidy() : string
- Indente un code HTML
- f_insert_head() : string
- Offre `#INSERT_HEAD` sur tous les squelettes (bourrin)
- f_admin() : string
- Insérer au besoin les boutons admins
- f_recuperer_fond() : array<string|int, mixed>
- Actions sur chaque inclusion
- f_queue() : string
- Gérer le lancement du cron si des tâches sont en attente
- f_jQuery_prive() : string
- Inserer jQuery et ses plugins pour l'espace privé
- affichage_final_prive_title_auto() : string
- Ajout automatique du title dans les pages du privé en squelette
- f_boite_infos() : mixed
- f_afficher_blocs_ecrire() : array<string|int, mixed>
- Utilisation du pipeline recuperer_fond dans le prive
- afficher_blocs_ecrire_preparer_marqueur() : string
- Vérifie la présence d'un marqueur dans le HTML et l'ajoute si nécessaire.
- f_queue_affiche_milieu() : string
- Afficher les taches en attente liees a un objet
- mise_a_jour_affiche_milieu() : string
- Afficher le message de mise à jour dans toutes les pages du privé pour les webmestres
- trouver_objet_exec() : array<string|int, mixed>|bool
- Trouver l'objet qui correspond à l'exec de l'espace privé passé en argument
Functions
f_tidy()
Indente un code HTML
f_tidy(string $texte) : string
Indente et valide un code HTML si la globale 'xhtml' est définie à true.
Cette fonction est appelée par le pipeline affichage_final
Parameters
- $texte : string
-
Contenu de la page envoyée au navigateur
Tags
Return values
string —Contenu de la page envoyée au navigateur
f_insert_head()
Offre `#INSERT_HEAD` sur tous les squelettes (bourrin)
f_insert_head(string $texte) : string
À activer dans mes_options via :
$GLOBALS['spip_pipeline']['affichage_final'] .= '|f_insert_head';
Ajoute le contenu du pipeline insert head dans la page HTML si cela n'a pas été fait.
Parameters
- $texte : string
-
Contenu de la page envoyée au navigateur
Tags
Return values
string —Contenu de la page envoyée au navigateur
f_admin()
Insérer au besoin les boutons admins
f_admin(string $texte) : string
Cette fonction est appelée par le pipeline affichage_final
Parameters
- $texte : string
-
Contenu de la page envoyée au navigateur
Tags
Return values
string —Contenu de la page envoyée au navigateur
f_recuperer_fond()
Actions sur chaque inclusion
f_recuperer_fond(array<string|int, mixed> $flux) : array<string|int, mixed>
Appelle f_afficher_blocs_ecrire() sur les inclusions dans l'espace privé. Ne change rien dans l'espace public.
Cette fonction est appelée par le pipeline recuperer_fond
Parameters
- $flux : array<string|int, mixed>
-
Description et contenu de l'inclusion
Tags
Return values
array<string|int, mixed> —$flux Description et contenu de l'inclusion
f_queue()
Gérer le lancement du cron si des tâches sont en attente
f_queue(string $texte) : string
Parameters
- $texte : string
-
Contenu de la page envoyée au navigateur
Tags
Return values
string —Contenu de la page envoyée au navigateur
f_jQuery_prive()
Inserer jQuery et ses plugins pour l'espace privé
f_jQuery_prive(string $texte) : string
La fonction ajoute les balises scripts dans le texte qui appelent les scripts jQuery ainsi que certains de ses plugins. La liste des js chargée peut être complété par le pipeline 'jquery_plugins'
Cette fonction est appelée par le pipeline header_prive
Parameters
- $texte : string
-
Contenu qui sera inséré dans le head HTML
Tags
Return values
string —Contenu complété des scripts javascripts, dont jQuery
affichage_final_prive_title_auto()
Ajout automatique du title dans les pages du privé en squelette
affichage_final_prive_title_auto(string $texte) : string
Appellé dans le pipeline affichage_final_prive
Parameters
- $texte : string
Return values
stringf_boite_infos()
f_boite_infos(mixed $flux) : mixed
Parameters
- $flux : mixed
f_afficher_blocs_ecrire()
Utilisation du pipeline recuperer_fond dans le prive
f_afficher_blocs_ecrire(array<string|int, mixed> $flux) : array<string|int, mixed>
Branchement automatise de affiche_gauche, affiche_droite, affiche_milieu pour assurer la compat avec les versions precedentes des exec en php Branche de affiche_objet
Les pipelines ne recevront plus exactement le meme contenu en entree, mais la compat multi vertions pourra etre assuree par une insertion au bon endroit quand le contenu de depart n'est pas vide
Parameters
- $flux : array<string|int, mixed>
-
Données du pipeline
Tags
Return values
array<string|int, mixed> —Données du pipeline
afficher_blocs_ecrire_preparer_marqueur()
Vérifie la présence d'un marqueur dans le HTML et l'ajoute si nécessaire.
afficher_blocs_ecrire_preparer_marqueur(string $texte, string $marqueur, string $inserer_avant[, string $ouvrir = '' ][, string $fermer = '' ]) : string
Fonction à appeler avant d'insérer des contenus via pipelines. Le marqueur peut optionnellement être encapsulé dans des balises. S'il est déjà présent et encapsulé, il ne faut PAS qu'il y ait d'espace blanc en trop.
Parameters
- $texte : string
-
Contenu HTML
- $marqueur : string
-
Marqueur cherché, tel que
<!--affiche_milieu--> - $inserer_avant : string
-
Expression régulière indiquant avant quel élément insérer le marqueur s'il est absent Exemple :
<div id=["\']wysiwyg - $ouvrir : string = ''
-
Balise ouvrante si le marqueur doit être encapsulé Exemple :
<div class="affiche_milieu"> - $fermer : string = ''
-
Balise fermante si le marqueur doit être encapsulé Exemple :
</div>
Return values
string —HTML avec le marqueur, ou inchangé si ajout impossible.
f_queue_affiche_milieu()
Afficher les taches en attente liees a un objet
f_queue_affiche_milieu(string $flux) : string
Parameters
- $flux : string
Tags
Return values
stringmise_a_jour_affiche_milieu()
Afficher le message de mise à jour dans toutes les pages du privé pour les webmestres
mise_a_jour_affiche_milieu(string $flux) : string
Parameters
- $flux : string
Tags
Return values
stringtrouver_objet_exec()
Trouver l'objet qui correspond à l'exec de l'espace privé passé en argument
trouver_objet_exec(string|null $exec) : array<string|int, mixed>|bool
renvoie false si pas d'objet en cours, ou un tableau associatif contenant les informations table_objet_sql,table,type,id_table_objet,edition
Parameters
- $exec : string|null
-
nom de la page testee