Documentation du code de SPIP et de ses plugins

Compagnon

Documentation

Packages

SPIP

Table of Contents

action_compagnon_dist()  : mixed
Action compagnon : indique qu'un auteur a validé un message d'aide
compagnon_upgrade()  : void
Installation et mises à jour du plugin
compagnon_create()  : mixed
Déclare la configuration du compagnon
compagnon_vider_tables()  : void
Désinstallation du plugin
filtre_ok_aleatoire_dist()  : string
Retourne un court texte de compréhension aléatoirement parmi une liste.
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
formulaires_reinitialiser_compagnon_charger()  : array<string|int, mixed>
Chargement du formulaire de réinitialisation des messages du compagnon
formulaires_reinitialiser_compagnon_traiter()  : array<string|int, mixed>
Traitement du formulaire de réinitialisation des messages du compagnon

Functions

action_compagnon_dist()

Action compagnon : indique qu'un auteur a validé un message d'aide

action_compagnon_dist() : mixed
Tags
global

array $GLOBALS ['visiteur_session']

Return values
mixed

compagnon_upgrade()

Installation et mises à jour du plugin

compagnon_upgrade(string $nom_meta_base_version, string $version_cible) : void

Active par défaut le compagnon s'il n'y a aucune rubrique dans le site.

Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données dans ce plugin (déclaré dans paquet.xml)

Return values
void

compagnon_create()

Déclare la configuration du compagnon

compagnon_create() : mixed

Si aucune rubrique n'est présente, active le compagnon, sinon non.

Return values
mixed

compagnon_vider_tables()

Désinstallation du plugin

compagnon_vider_tables(string $nom_meta_base_version) : void

Efface les informations du compagnon

Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

Return values
void

filtre_ok_aleatoire_dist()

Retourne un court texte de compréhension aléatoirement parmi une liste.

filtre_ok_aleatoire_dist() : string
Tags
example

[(#VAL|ok_aleatoire)]

Return values
string

Le texte traduit.

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

formulaires_reinitialiser_compagnon_charger()

Chargement du formulaire de réinitialisation des messages du compagnon

formulaires_reinitialiser_compagnon_charger() : array<string|int, mixed>
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_reinitialiser_compagnon_traiter()

Traitement du formulaire de réinitialisation des messages du compagnon

formulaires_reinitialiser_compagnon_traiter() : array<string|int, mixed>
Return values
array<string|int, mixed>

Retours du traitement

Search results