UploadedFileInterface.php 8.17 KiB
<?php
/*
 * Copyright (C) 2015 IRSTEA
 * All rights reserved.
 * @package irstea/file-upload-bundle
 * @author Guillaume Perréal <guillaume.perreal@irstea.fr>*
 */
namespace Irstea\FileUploadBundle\Model;
use DateTime;
/** Un fichier uploadé.
interface UploadedFileInterface
    /** Fichier en cours d'upload.
     * @var string
    const ETAT_EN_COURS = 'en-cours';
    /** Fichier orphelin.
     * Fichier qui n'a pas encore été associé à un objet métier.
     * @var string
    const ETAT_ORPHELIN = 'orphelin';
    /** Fichier normal.
     * Fichier associé à un objet métier.
     * @var string
    const ETAT_NORMAL   = 'normal';
    /** Fichier corrompu.
     * Fichier dont le contenu disque ne correspond pas à la somme de contrôle enregistreé en base de données.
     * @var string
    const ETAT_CORROMPU = 'corrompu';
    /** Fichier manquant.
     * Fichier existant en base de données mais introuvable sur disque.
     * @var string
    const ETAT_MANQUANT = 'manquant';
    /** Fichier rejeté.
     * Fichier uploadé mais rejeté par un listener (par exemple l'antivirus).
     * @var string
    const ETAT_REJETE   = 'rejete';
    /** Retourne l'identifiant du fichier.
     * @return string
     * @api
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
*/ public function getId(); /** * Set originalFilename * * @param string $displayName * @return UploadedFileInterface * * @api */ public function setDisplayName($displayName); /** Retourne le nom original du fichier (c-à-d sur le poste de l'utilisateur ayant fait l'upload.) * * @return string * * @api */ public function getDisplayName(); /** * @param string $description * @return UploadedFileInterface * * @api */ public function setDescription($description = null); /** Retourne la description du fichier. * * @return string * * @api */ public function getDescription(); /** Retourne le chemin du fichier dans le filesystem. * * @return string * * @api */ public function getPath(); /** Remplace le chemin du fichier dans le filesystem. * * Cela devrait causer un déplacement/renommage du fichier. * * @param string $path * * @return UploadedFileInterface * * @api */ public function setPath($path); /** Change le chemin du fichier sans changer le nom. * * @param string $newDir Nouveau répertoire * * @return UploadedFileInterface * * @uses UploadedFileInterface::setPath * * @api */ public function moveTo($newDir); /**