SPIP Code

Documentation du code de SPIP et de ses plugins

Compagnon

API Documentation

Table of Contents

Functions

action_compagnon_dist()  : void
Action compagnon : indique qu'un auteur a validé un message d'aide
compagnon_upgrade()  : void
Installation et mises à jour du plugin
compagnon_create()  : void
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{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}
Définition des messages de compagnon par défaut en fonction
compagnon_affiche_milieu()  : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}
Ajoute les aides du compagnon sur le pipeline affiche milieu
compagnon_affiche_gauche()  : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}
Ajoute les aides du compagnon sur le pipeline affiche gauche
compagnon_affiche_droite()  : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}
Ajoute les aides du compagnon sur le pipeline affiche droite
compagnonage()  : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}
Ajoute l'aide du compagnon dans un pipeline
formulaires_reinitialiser_compagnon_charger()  : array<string, string>
Chargement du formulaire de réinitialisation des messages du compagnon
formulaires_reinitialiser_compagnon_traiter()  : array<string, string>
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() : void
Tags
global

array $GLOBALS ['visiteur_session']

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)

compagnon_create()

Déclare la configuration du compagnon

compagnon_create() : void

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

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

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{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} $flux) : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}

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

Parameters
$flux : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}

Données du pipeline

Tags
pipeline

compagnon_messages

Return values
array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} —

Données du pipeline

compagnon_affiche_milieu()

Ajoute les aides du compagnon sur le pipeline affiche milieu

compagnon_affiche_milieu(array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} $flux) : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}
Parameters
$flux : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} —

Données du pipeline

compagnon_affiche_gauche()

Ajoute les aides du compagnon sur le pipeline affiche gauche

compagnon_affiche_gauche(array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} $flux) : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}
Parameters
$flux : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}

Données du pipeline

Tags
pipeline

affiche_gauche

Return values
array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} —

Données du pipeline

compagnon_affiche_droite()

Ajoute les aides du compagnon sur le pipeline affiche droite

compagnon_affiche_droite(array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} $flux) : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}
Parameters
$flux : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}

Données du pipeline

Tags
pipeline

affiche_droite

Return values
array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} —

Données du pipeline

compagnonage()

Ajoute l'aide du compagnon dans un pipeline

compagnonage(array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} $flux, string $pipeline) : array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}

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{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array}

Flux d'informations transmises au pipeline

$pipeline : string

Nom du pipeline d'origine

Tags
pipeline_appel

compagnon_messages

Return values
array{args: array{exec: string, pipeline: string, deja_vus: array, id_rubrique: int}, data: array} —

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, string>
Return values
array<string, string> —

Environnement du formulaire

formulaires_reinitialiser_compagnon_traiter()

Traitement du formulaire de réinitialisation des messages du compagnon

formulaires_reinitialiser_compagnon_traiter() : array<string, string>
Return values
array<string, string> —

Retours du traitement


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results