Documentation du code de SPIP et de ses plugins

API de vérification

verifier.php

Fonctions de l'API de vérification

Tags
plugin

verifier

copyright

2018

author

Les Développements Durables

licence

GNU/GPL

Table of Contents

Functions

inc_verifier_dist()  : string
Fonction de base de l'API de vérification.
verifier_lister_disponibles()  : array<string|int, mixed>
Liste toutes les vérifications possibles
verifier_trier_par_titre()  : int
Fonction de callback pour uasort() Afin de trier selon le titre
verifier_charger_infos()  : array<string|int, mixed>
Charger les informations contenues dans le yaml d'une vérification

Functions

inc_verifier_dist()

Fonction de base de l'API de vérification.

inc_verifier_dist(mixed $valeur, string $type[, array<string|int, mixed> $options = null ][, array<string|int, mixed> &$valeur_normalisee = null ]) : string
Parameters
$valeur : mixed

La valeur a verifier.

$type : string

Le type de verification a appliquer.

$options : array<string|int, mixed> = null

Un eventuel tableau d'options suivant le type.

$valeur_normalisee : array<string|int, mixed> = null

Si des options de verification modifient la valeur entrante (normalisent), alors la valeur modifie sera stockee dans cette variable.

Return values
string —

Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.

verifier_lister_disponibles()

Liste toutes les vérifications possibles

verifier_lister_disponibles([string $repertoire = 'verifier' ]) : array<string|int, mixed>
Parameters
$repertoire : string = 'verifier'

Dans quel repertoire chercher les yaml.

Return values
array<string|int, mixed> —

Retourne un tableau listant les vérifications et leurs options

verifier_trier_par_titre()

Fonction de callback pour uasort() Afin de trier selon le titre

verifier_trier_par_titre(array<string|int, mixed> $array1, array<string|int, mixed> $array2) : int
Parameters
$array1 : array<string|int, mixed>

premier élèment

$array2 : array<string|int, mixed>

second élèment

Return values
int —

1,0,-1

verifier_charger_infos()

Charger les informations contenues dans le yaml d'une vérification

verifier_charger_infos(string $type_verif[, string $repertoire = 'verifier' ]) : array<string|int, mixed>
Parameters
$type_verif : string

Le type de la vérification

$repertoire : string = 'verifier'

Dans quel repertoire chercher les yaml.

Tags
note

Cette fonction nécessite le plugin Yaml ET un des plugins fournissant _T_ou_typo() : Bonux ou Saisies.

Return values
array<string|int, mixed> —

Un tableau contenant le YAML décodé


        
On this page

Search results