Documentation du code de SPIP et de ses plugins

SPIP

pipelines_ecrire.php

Fonctions déclarées dans des pipelines (espace privé)

Table of Contents

Functions

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_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
see
f_jQuery()
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
string

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
used-by
f_recuperer_fond()
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
pipeline

affiche_milieu

Return values
string

mise_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
pipeline

affiche_milieu

Return values
string

trouver_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

Return values
array<string|int, mixed>|bool

        
On this page

Search results