Documentation du code de SPIP et de ses plugins

Boussole

boussole_pipelines.php

Ce fichier contient les cas d'utilisation des pipelines.

Table of Contents

Functions

boussole_affiche_milieu()  : array<string|int, mixed>
Affichage, dans la fiche d'un objet site, d'un bloc identifiant la boussole à laquelle appartient le site édité.
boussole_affiche_gauche()  : array<string|int, mixed>
Affiche dans la page d'accueil des sites référencés un raccourci pour importer l'ensemble des sites d'une boussole déjà installée.
boussole_post_edition()  : array<string|int, mixed>
Permet de déclencher la mise à jour de la boussole si un site de la base appartenant à cette boussole est refusé ou réhabilité si il était déjà refusé.
boussole_liste_ezcollection()  : array<string|int, mixed>
Déclare la collection boussoles à l'API d'ezrest.

Functions

boussole_affiche_milieu()

Affichage, dans la fiche d'un objet site, d'un bloc identifiant la boussole à laquelle appartient le site édité.

boussole_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Flux fourni en entrée au pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed>

Flux éventuellement complété

boussole_affiche_gauche()

Affiche dans la page d'accueil des sites référencés un raccourci pour importer l'ensemble des sites d'une boussole déjà installée.

boussole_affiche_gauche(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Flux fourni en entrée au pipeline

Tags
pipeline

affiche_gauche

Return values
array<string|int, mixed>

Flux éventuellement complété

boussole_post_edition()

Permet de déclencher la mise à jour de la boussole si un site de la base appartenant à cette boussole est refusé ou réhabilité si il était déjà refusé.

boussole_post_edition(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Flux fourni au pipeline

Tags
pipeline

post_edition

Return values
array<string|int, mixed>

Flux d'entrée sans modification.

boussole_liste_ezcollection()

Déclare la collection boussoles à l'API d'ezrest.

boussole_liste_ezcollection(array<string|int, mixed> $collections) : array<string|int, mixed>
Parameters
$collections : array<string|int, mixed>

Configuration des collections déjà déclarées.

Tags
pipeline

liste_ezcollection

Return values
array<string|int, mixed>

Collections complétées.


        
On this page

Search results