AideIndexEvent
extends PipelineEvent
in package
implements
PipelineEventFactoryInterface
FinalYes
Événement du pipeline `aide_index` : index des rubriques et entrées de l’aide en ligne.
Tags
Attributes
- #[AsPipelineEvent]
- 'aide_index'
Table of Contents
Interfaces
- PipelineEventFactoryInterface
Constants
- PIPELINE_NAME = 'aide_index'
Methods
- __construct() : mixed
- appendToIndex() : void
- Ajoute une entrée dans un groupe d’index sans dupliquer une entrée déjà présente pour ce groupe.
- fromLegacyPayload() : static
- getIndex() : array<string, array<string|int, string>>
- Retourne l’index d’aide courant (groupes et entrées sous forme de listes de chaînes).
- setIndex() : void
- Remplace entièrement l’index exposé aux listeners suivants du même pipeline.
Constants
PIPELINE_NAME
public
mixed
PIPELINE_NAME
= 'aide_index'
Methods
__construct()
public
__construct([array<string, array<string|int, string>> $index = [] ]) : mixed
Parameters
- $index : array<string, array<string|int, string>> = []
-
Chaque clé est un groupe ; la valeur est la liste des sous-entrées (slugs).
appendToIndex()
Ajoute une entrée dans un groupe d’index sans dupliquer une entrée déjà présente pour ce groupe.
public
appendToIndex(string $group, string $entry) : void
Crée le groupe s’il n’existait pas.
Parameters
- $group : string
- $entry : string
fromLegacyPayload()
public
static fromLegacyPayload(mixed $subject[, array<int|string, mixed> $arguments = null ]) : static
Parameters
- $subject : mixed
- $arguments : array<int|string, mixed> = null
-
Ignorés (le pipeline legacy ne transporte pas d’arguments séparés).
Return values
staticgetIndex()
Retourne l’index d’aide courant (groupes et entrées sous forme de listes de chaînes).
public
getIndex() : array<string, array<string|int, string>>
Return values
array<string, array<string|int, string>>setIndex()
Remplace entièrement l’index exposé aux listeners suivants du même pipeline.
public
setIndex(array<string, array<string|int, string>> $index) : void
Parameters
- $index : array<string, array<string|int, string>>