Documentation du code de SPIP et de ses plugins

Compagnon

Pipelines

Table of Contents

Functions

compagnon_compagnon_messages()  : array<string|int, mixed>
Définition des messages de compagnon par défaut en fonction
compagnon_affiche_milieu()  : array<string|int, mixed>
Ajoute les aides du compagnon sur le pipeline affiche milieu
compagnon_affiche_gauche()  : array<string|int, mixed>
Ajoute les aides du compagnon sur le pipeline affiche gauche
compagnon_affiche_droite()  : array<string|int, mixed>
Ajoute les aides du compagnon sur le pipeline affiche droite
compagnonage()  : array<string|int, mixed>
Ajoute l'aide du compagnon dans un pipeline

Functions

compagnon_compagnon_messages()

Définition des messages de compagnon par défaut en fonction

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

Retourne une liste de messages d'aides en fonction du pipeline demandé

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

Données du pipeline

Tags
pipeline

compagnon_messages

Return values
array<string|int, mixed>

$flux Données du pipeline

compagnon_affiche_milieu()

Ajoute les aides du compagnon sur le pipeline affiche milieu

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

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed>

Données du pipeline

compagnon_affiche_gauche()

Ajoute les aides du compagnon sur le pipeline affiche gauche

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

Données du pipeline

Tags
pipeline

affiche_gauche

Return values
array<string|int, mixed>

Données du pipeline

compagnon_affiche_droite()

Ajoute les aides du compagnon sur le pipeline affiche droite

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

Données du pipeline

Tags
pipeline

affiche_droite

Return values
array<string|int, mixed>

Données du pipeline

compagnonage()

Ajoute l'aide du compagnon dans un pipeline

compagnonage(array<string|int, mixed> $flux, string $pipeline) : array<string|int, mixed>

Les aides sont ajoutées

  • si la config le permet
  • si l'aide n'a pas déjà été validée par le visiteur
Parameters
$flux : array<string|int, mixed>

Flux d'informations transmises au pipeline

$pipeline : string

Nom du pipeline d'origine

Tags
pipeline_appel

compagnon_messages

Return values
array<string|int, mixed>

$flux Le flux éventuellement complété de l'aide du compagnon


        
On this page

Search results