1. class
  2. Soosyze
  3. \
  4. Components
  5. \
  6. Http
  7. \
  8. UploadedFile

UploadedFile

class UploadedFile implements UploadedFileInterface (View source)

Objet de valeur représentant un fichier téléchargé via une requête HTTP.

Properties

protected string|null $file Nom du fichier ($_FILES['key']['tmp_name']).
protected string|null $name Chemin du fichier temporaire ($_FILES['key']['name']).
protected int|null $size Taille du fichier en octets ($_FILES['key']['size']).
protected string|null $type Type MIME du fichier ($_FILES['key']['type']).
protected int $error Code erreur ($_FILES['key']['error']).
protected int[] $errors Codes d'erreurs approprié dans le tableau de fichier.
protected StreamInterface $stream Représentation du fichier en flux de données.
protected bool $moved Si le fichier a été déplacé.

Methods

__construct(string|ressource|StreamInterface $file, string|null $name = null, int|null $size = null, string|null $type = null, int $error = UPLOAD_ERR_OK)

Construit un fichier.

static UploadedFileInterface
create(array $file)

Créer un fichier à partir d'un tableau de données.

StreamInterface
getStream()

Récupérer un flux représentant le fichier téléchargé.

moveTo(string $targetPath)

Déplacez le fichier téléchargé vers un nouvel emplacement.

int|null
getSize()

Récupérer la taille du fichier à partir de la clé "taille" du tableau $_FILES.

int
getError()

Récupérer l'erreur associée au fichier téléchargé à partir de la clé "error" du tableau $_FILES.

string|null
getClientFilename()

Récupérer le nom de fichier envoyé par le client à partir de la clé "name" du tableau $_FILES.

string|null
getClientMediaType()

Récupérer le type de média envoyé par le client à partir de la clé "type" du tableau $_FILES.

filterFile(string|ressource|StreamInterface $file)

Déclenche une exception si le fichier n'est pas valide.

string
filterName(string $name)

Déclenche une exception si le nom du fichier n'est pas valide.

int
filterSize(int $size)

Déclenche une exception si la taille du fichier n'est pas valide.

string
filterType(string $type)

Déclenche une exception si le type du fichier n'est pas valide.

int
filterError(int $error)

Déclence une exception si le type d'error n'est pas valide.

Details

at line 101
__construct(string|ressource|StreamInterface $file, string|null $name = null, int|null $size = null, string|null $type = null, int $error = UPLOAD_ERR_OK)

Construit un fichier.

Parameters

string|ressource|StreamInterface $file
string|null $name
int|null $size
string|null $type
int $error

at line 125
static UploadedFileInterface create(array $file)

Créer un fichier à partir d'un tableau de données.

Parameters

array $file Doit contenir la clé 'tmp_name' au minimum.

Return Value

UploadedFileInterface

Exceptions

InvalidArgumentException La clé tmp_name est requise.

at line 158
StreamInterface getStream()

Récupérer un flux représentant le fichier téléchargé.

Cette méthode DOIT renvoyer une instance StreamInterface, représentant le fichier téléchargé.

Return Value

StreamInterface Stream représentation du fichier téléchargé.

Exceptions

RuntimeException Dans les cas où aucun flux n'est disponible ou peut être créé.

at line 190
moveTo(string $targetPath)

Déplacez le fichier téléchargé vers un nouvel emplacement.

Cette méthode est garantie de travailler dans les environnements SAPI et non-SAPI.

Parameters

string $targetPath Chemin vers lequel déplacer le fichier téléchargé.

Exceptions

RuntimeException sur toute erreur lors de l'opération de déplacement, ou sur le deuxième ou suivant appel à la méthode.
InvalidArgumentException Si le $targetPath spécifié n'est pas valide.
InvalidArgumentException Une erreur est survenue.

See also

http://php.net/is_uploaded_file
http://php.net/move_uploaded_file

at line 220
int|null getSize()

Récupérer la taille du fichier à partir de la clé "taille" du tableau $_FILES.

Return Value

int|null Taille du fichier en octets ou null si inconnu.

at line 234
int getError()

Récupérer l'erreur associée au fichier téléchargé à partir de la clé "error" du tableau $_FILES.

La valeur de retour DOIT être l'une des constantes UPLOAD_ERR_XXX de PHP.

Return Value

int Une des constantes UPLOAD_ERR_XXX de PHP.

See also

http://php.net/manual/fr/features.file-upload.errors.php

at line 249
string|null getClientFilename()

Récupérer le nom de fichier envoyé par le client à partir de la clé "name" du tableau $_FILES.

Ne faites pas confiance à la valeur renvoyée par cette méthode. Un client pourrait envoyer un nom de fichier malveillant dans l'intention de corrompre ou de pirater votre application.

Return Value

string|null Nom de fichier envoyé par le client ou null si aucun. a été fourni.

at line 264
string|null getClientMediaType()

Récupérer le type de média envoyé par le client à partir de la clé "type" du tableau $_FILES.

Ne faites pas confiance à la valeur renvoyée par cette méthode. Un client pourrait envoyer un type de média malveillant avec l'intention de corrompre ou de pirater votre application.

Return Value

string|null Le type de média envoyé par le client ou null si aucun a été fourni.

at line 276
protected filterFile(string|ressource|StreamInterface $file)

Déclenche une exception si le fichier n'est pas valide.

Parameters

string|ressource|StreamInterface $file Le fichier.

Exceptions

InvalidArgumentException La ressource de fichier n'est pas lisible.

at line 297
protected string filterName(string $name)

Déclenche une exception si le nom du fichier n'est pas valide.

Parameters

string $name Nom du fichier

Return Value

string Nom du fichier filtré.

Exceptions

InvalidArgumentException Le nom du fichier doit être une chaine de caractère ou null.

at line 314
protected int filterSize(int $size)

Déclenche une exception si la taille du fichier n'est pas valide.

Parameters

int $size Taille du fichier.

Return Value

int Taille du fichier filtré.

Exceptions

InvalidArgumentException La taille du fichier doit-être un nombre entier ou null

at line 331
protected string filterType(string $type)

Déclenche une exception si le type du fichier n'est pas valide.

Parameters

string $type Type du fichier

Return Value

string Type du fichier filtré.

Exceptions

InvalidArgumentException Le type du fichier doit être une chaine de caractère ou null.

at line 348
protected int filterError(int $error)

Déclence une exception si le type d'error n'est pas valide.

Parameters

int $error Type d'erreur.

Return Value

int Type d'erreur filtré.

Exceptions

InvalidArgumentException Le type d'erreur n'est pas valide.