Documentation du code de SPIP et de ses plugins

N-Core

noisette_preview.php

Ce fichier contient la balise `#NOISETTE_PREVIEW` qui génère la prévisualisation d'une noisette.

Table of Contents

Functions

balise_NOISETTE_PREVIEW_dist()  : Champ
Compile la balise `#NOISETTE_PREVIEW` qui génère la prévisualisation de la noisette passée en argument en gérant le fait que le type de noisette soit actif et propose bien un fichier de prévisualisation.
calculer_preview_noisette()  : string
Calcule la prévisualisation de la noisette passée en argument.

Functions

balise_NOISETTE_PREVIEW_dist()

Compile la balise `#NOISETTE_PREVIEW` qui génère la prévisualisation de la noisette passée en argument en gérant le fait que le type de noisette soit actif et propose bien un fichier de prévisualisation.

balise_NOISETTE_PREVIEW_dist(Champ $p) : Champ

La signature de la balise est : #NOISETTE_PREVIEW{id_noisette, type_noisette_actif, plugins_necessites}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
uses
calculer_preview_noisette()
Return values
Champ

Pile complétée par le code à générer.

calculer_preview_noisette()

Calcule la prévisualisation de la noisette passée en argument.

calculer_preview_noisette(string $plugin, array<string|int, mixed> $noisette, string $type_noisette_actif, string $type_noisette_necessite) : string
Parameters
$plugin : string

Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.

$noisette : array<string|int, mixed>

Tableau associatif descriptif de la noisette : les deux identifiants et le type de noisette.

$type_noisette_actif : string

Indique si le type de noisette est actif ou pas (au moins un plugin nécessité est désactivé). Prend les valeurs oui ou non.

$type_noisette_necessite : string

Tableau sérialisé des plugins necessités par le type de noisette. Sert uniquement à afficher l'avertissement éventuel sur les plugins inactifs.

Tags
uses
type_noisette_localiser()
used-by
balise_NOISETTE_PREVIEW_dist()
Return values
string

Code HTML de prévisualisation de la noisette.


        
On this page

Search results