Documentation du code de SPIP et de ses plugins

API de vérification

fichiers.php

API de vérification : vérification de la validité d'un envoi de fichiers

Tags
plugin

verifier

copyright

2018

author

Les Développements Durables

licence

GNU/GPL

Table of Contents

Functions

verifier_fichiers_dist()  : string
Vérifier une saisie d'envoi de fichiers
verifier_fichier_mime()  : string
Vérifier le mime type d'une saisie d'envoi de fichiers
verifier_fichier_taille()  : string
Vérifier la taille d'une saisie d'envoi de fichiers
verifier_fichier_dimension_max()  : string
Vérifier la dimension d'une saisie d'envoi de fichiers

Functions

verifier_fichiers_dist()

Vérifier une saisie d'envoi de fichiers

verifier_fichiers_dist(array<string|int, mixed>|bool $valeur, array<string|int, mixed> $options, array<string|int, mixed>|string &$erreurs_par_fichier) : string
Parameters
$valeur : array<string|int, mixed>|bool

Le sous tableau de $_FILES à vérifier, $_FILES['logo'] par exemple Doit être un champ avec un ou plusieurs upload Si bool égal à true, cela signifie que le fichier avait déjà été vérifié, et qu'il est inutile de refaire la vérification.

$options : array<string|int, mixed>

Options à vérifier :

  • mime au choix 'pas_de_verification', 'image_web','tout_mime','specifique'
  • mime_specifique (si l'option 'mime_specifique' est choisi ci-dessus)
  • taille_max (en Kio)
  • dimension_max, tableau contenant les dimension max:
  • largeur (en px)
  • hauteur (en px)
  • autoriser_rotation : booléen à mettre à true (ou bien string égale à 'on') si on autorise une image qui tiendrait dans ces dimensions si on faisait une rotation de 90°
  • on peut remplacer ce tableau par des strings directement dans $options:
  • largeur_max
  • hauteur_max
  • autoriser_rotation
$erreurs_par_fichier : array<string|int, mixed>|string

Si on vérifier un upload multiple, un tableau, passé par référence, qui contient le détail des erreurs fichier de $_FILES['fichier'] par fichier Si on vérifie un upload unique, une chaîne qui contiendra l'erreur du fichier.

Return values
string

verifier_fichier_mime()

Vérifier le mime type d'une saisie d'envoi de fichiers

verifier_fichier_mime(array<string|int, mixed> $valeur, int $cle, array<string|int, mixed> $options) : string
Parameters
$valeur : array<string|int, mixed>

Le sous tableau de $_FILES à vérifier, $_FILES['logo'] par exemple Doit être un champ plusieurs uploads

$cle : int

La clé du tableau qu'on vérifie

$options : array<string|int, mixed>

Les options tels que passés à verifier_fichiers()

Return values
string

verifier_fichier_taille()

Vérifier la taille d'une saisie d'envoi de fichiers

verifier_fichier_taille(array<string|int, mixed> $valeur, int $cle, array<string|int, mixed> $options) : string

La taille est vérifiée en fonction du paramètre passé en option, sinon en fonction d'une constante:

  • _IMG_MAX_SIZE si jpg/png/gif
  • _DOC_MAX_SIZE si pas jpg/png/gif ou si _IMG_MAX_SIZE n'est pas définie
Parameters
$valeur : array<string|int, mixed>

Le sous tableau de $_FILES à vérifier, $_FILES['logo'] par exemple Doit être un champ plusieurs uploads

$cle : int

La clé du tableau qu'on vérifie

$options : array<string|int, mixed>

Les options tels que passés à verifier_fichiers()

Return values
string

verifier_fichier_dimension_max()

Vérifier la dimension d'une saisie d'envoi de fichiers

verifier_fichier_dimension_max(array<string|int, mixed> $valeur, int $cle, array<string|int, mixed> $options) : string

Les dimensions sont vérifiées en fonction du paramètre passé en option, sinon en fonction des constantes:

  • _IMG_MAX_WIDTH
  • _IMG_MAX_HEIGHT

On suppose que le type mime a été vérifié auparavent

Parameters
$valeur : array<string|int, mixed>

Le sous tableau de $_FILES à vérifier, $_FILES['logo'] par exemple Doit être un champ plusieurs uploads

$cle : int

La clé du tableau qu'on vérifie

$options : array<string|int, mixed>

Les options tels que passés à verifier_fichiers()

Return values
string

        
On this page

Search results