Documentation du code de SPIP et de ses plugins

SPIP

pipeline.php

Table of Contents

Functions

minipipe()  : string|array<string|int, mixed>
Exécute une fonction (appellée par un pipeline) avec la donnée transmise.
pipeline()  : mixed|null
Appel d’un pipeline

Functions

minipipe()

Exécute une fonction (appellée par un pipeline) avec la donnée transmise.

minipipe(string $fonc, string|array<string|int, mixed> &$val) : string|array<string|int, mixed>

Un pipeline est lie a une action et une valeur chaque element du pipeline est autorise a modifier la valeur le pipeline execute les elements disponibles pour cette action, les uns apres les autres, et retourne la valeur finale

Cf. compose_filtres dans references.php, qui est la version compilee de cette fonctionnalite appel unitaire d'une fonction du pipeline utilisee dans le script pipeline precompile

on passe $val par reference pour limiter les allocations memoire

Parameters
$fonc : string

Nom de la fonction appelée par le pipeline

$val : string|array<string|int, mixed>

Les paramètres du pipeline, son environnement

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

$val Les paramètres du pipeline modifiés

pipeline()

Appel d’un pipeline

pipeline(string $action[, mixed $val = null ]) : mixed|null

Exécute le pipeline souhaité, éventuellement avec des données initiales. Chaque plugin qui a demandé à voir ce pipeline vera sa fonction spécifique appelée. Les fonctions (des plugins) appelées peuvent modifier à leur guise le contenu.

Deux types de retours. Si $val est un tableau de 2 éléments, avec une clé data on retourne uniquement ce contenu ($val['data']) sinon on retourne tout $val.

Parameters
$action : string

Nom du pipeline

$val : mixed = null

Données à l’entrée du pipeline

Tags
example

Appel du pipeline pre_insertion

$champs = pipeline('pre_insertion', array(
    'args' => array('table' => 'spip_articles'),
    'data' => $champs
));
Return values
mixed|null

Résultat


        
On this page

Search results