Commit a73e273c authored by Guillaume Perréal's avatar Guillaume Perréal
Browse files

CS.

Showing with 115 additions and 54 deletions
+115 -54
...@@ -18,7 +18,7 @@ use Symfony\Component\Console\Output\OutputInterface; ...@@ -18,7 +18,7 @@ use Symfony\Component\Console\Output\OutputInterface;
class CheckCommand extends ContainerAwareCommand class CheckCommand extends ContainerAwareCommand
{ {
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
protected function configure() protected function configure()
{ {
...@@ -28,7 +28,7 @@ class CheckCommand extends ContainerAwareCommand ...@@ -28,7 +28,7 @@ class CheckCommand extends ContainerAwareCommand
} }
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
......
...@@ -19,7 +19,7 @@ use Symfony\Component\Console\Output\OutputInterface; ...@@ -19,7 +19,7 @@ use Symfony\Component\Console\Output\OutputInterface;
class CollectGarbageCommand extends ContainerAwareCommand class CollectGarbageCommand extends ContainerAwareCommand
{ {
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
protected function configure() protected function configure()
{ {
...@@ -30,7 +30,7 @@ class CollectGarbageCommand extends ContainerAwareCommand ...@@ -30,7 +30,7 @@ class CollectGarbageCommand extends ContainerAwareCommand
} }
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
......
...@@ -20,7 +20,7 @@ use Symfony\Component\Console\Output\OutputInterface; ...@@ -20,7 +20,7 @@ use Symfony\Component\Console\Output\OutputInterface;
class CreateCommand extends ContainerAwareCommand class CreateCommand extends ContainerAwareCommand
{ {
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
protected function configure() protected function configure()
{ {
...@@ -34,7 +34,7 @@ class CreateCommand extends ContainerAwareCommand ...@@ -34,7 +34,7 @@ class CreateCommand extends ContainerAwareCommand
} }
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
......
...@@ -19,7 +19,7 @@ use Symfony\Component\Console\Output\OutputInterface; ...@@ -19,7 +19,7 @@ use Symfony\Component\Console\Output\OutputInterface;
class ReadCommand extends ContainerAwareCommand class ReadCommand extends ContainerAwareCommand
{ {
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
protected function configure() protected function configure()
{ {
...@@ -33,7 +33,7 @@ class ReadCommand extends ContainerAwareCommand ...@@ -33,7 +33,7 @@ class ReadCommand extends ContainerAwareCommand
} }
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)
{ {
......
...@@ -84,6 +84,7 @@ class UploadController extends Controller ...@@ -84,6 +84,7 @@ class UploadController extends Controller
/** /**
* @Route("", name="file_upload_create") * @Route("", name="file_upload_create")
* @Method("POST") * @Method("POST")
*
* @param Request $request * @param Request $request
* *
* @return JsonResponse * @return JsonResponse
...@@ -130,7 +131,8 @@ class UploadController extends Controller ...@@ -130,7 +131,8 @@ class UploadController extends Controller
/** /**
* @Route("/{id}/content", name="file_upload_put_content") * @Route("/{id}/content", name="file_upload_put_content")
* @Method("PUT") * @Method("PUT")
* @param Request $request *
* @param Request $request
* @param UploadedFile $file * @param UploadedFile $file
* *
* @return JsonResponse|Response * @return JsonResponse|Response
...@@ -173,9 +175,9 @@ class UploadController extends Controller ...@@ -173,9 +175,9 @@ class UploadController extends Controller
throw new BadRequestHttpException('Invalid Content-Range'); throw new BadRequestHttpException('Invalid Content-Range');
} }
$start = (int)$matches[1]; $start = (int) $matches[1];
$end = (int)$matches[2]; $end = (int) $matches[2];
$total = (int)$matches[3]; $total = (int) $matches[3];
if ($start < 0 || $start >= $end || $end >= $total) { if ($start < 0 || $start >= $end || $end >= $total) {
throw new HttpException(Response::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE); throw new HttpException(Response::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE);
...@@ -217,7 +219,8 @@ class UploadController extends Controller ...@@ -217,7 +219,8 @@ class UploadController extends Controller
/** /**
* @Route("/{id}/content", name="file_upload_get_content") * @Route("/{id}/content", name="file_upload_get_content")
* @Method("GET") * @Method("GET")
* @param Request $request *
* @param Request $request
* @param UploadedFile $file * @param UploadedFile $file
* *
* @return UploadedFileResponse * @return UploadedFileResponse
...@@ -239,7 +242,8 @@ class UploadController extends Controller ...@@ -239,7 +242,8 @@ class UploadController extends Controller
/** /**
* @Route("/{id}", name="file_upload_delete") * @Route("/{id}", name="file_upload_delete")
* @Method("DELETE") * @Method("DELETE")
* @param Request $request *
* @param Request $request
* @param UploadedFile $file * @param UploadedFile $file
* *
* @return JsonResponse * @return JsonResponse
......
...@@ -18,6 +18,7 @@ use Symfony\Component\HttpFoundation\Request; ...@@ -18,6 +18,7 @@ use Symfony\Component\HttpFoundation\Request;
/** /**
* UploadedFile controller. * UploadedFile controller.
*
* @Route("/files") * @Route("/files")
* @Security("is_granted('ROLE_FILES_ADMIN')") * @Security("is_granted('ROLE_FILES_ADMIN')")
*/ */
...@@ -25,6 +26,7 @@ class UploadedFileController extends Controller ...@@ -25,6 +26,7 @@ class UploadedFileController extends Controller
{ {
/** /**
* Lists all UploadedFile entities. * Lists all UploadedFile entities.
*
* @Route("/", name="files") * @Route("/", name="files")
* @Method("GET") * @Method("GET")
* @Template() * @Template()
...@@ -54,6 +56,7 @@ class UploadedFileController extends Controller ...@@ -54,6 +56,7 @@ class UploadedFileController extends Controller
/** /**
* Finds and displays a UploadedFile entity. * Finds and displays a UploadedFile entity.
*
* @Route("/{id}", name="files_show") * @Route("/{id}", name="files_show")
* @Method("GET") * @Method("GET")
* @Template() * @Template()
......
...@@ -11,7 +11,7 @@ use Symfony\Component\Config\Definition\ConfigurationInterface; ...@@ -11,7 +11,7 @@ use Symfony\Component\Config\Definition\ConfigurationInterface;
/** /**
* This is the class that validates and merges configuration from your app/config files. * This is the class that validates and merges configuration from your app/config files.
* To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class} * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}.
*/ */
class Configuration implements ConfigurationInterface class Configuration implements ConfigurationInterface
{ {
...@@ -30,7 +30,7 @@ class Configuration implements ConfigurationInterface ...@@ -30,7 +30,7 @@ class Configuration implements ConfigurationInterface
->ifString() ->ifString()
->then( ->then(
function ($v) { function ($v) {
$int = (int)$v; $int = (int) $v;
if (strpos($v, 'K')) { if (strpos($v, 'K')) {
return 1000 * $int; return 1000 * $int;
} }
......
...@@ -13,7 +13,7 @@ use Symfony\Component\DependencyInjection\Loader; ...@@ -13,7 +13,7 @@ use Symfony\Component\DependencyInjection\Loader;
use Symfony\Component\HttpKernel\DependencyInjection\Extension; use Symfony\Component\HttpKernel\DependencyInjection\Extension;
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
class IrsteaFileUploadExtension extends Extension implements PrependExtensionInterface class IrsteaFileUploadExtension extends Extension implements PrependExtensionInterface
{ {
......
...@@ -24,8 +24,7 @@ use Symfony\Component\EventDispatcher\EventDispatcher; ...@@ -24,8 +24,7 @@ use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventDispatcherInterface; use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/** /**
* Class UploadedFileRepository * Class UploadedFileRepository.
* @package Irstea\FileUploadBundle\Entity\Repository
*/ */
class UploadedFileRepository extends EntityRepository implements FileManagerInterface class UploadedFileRepository extends EntityRepository implements FileManagerInterface
{ {
...@@ -143,8 +142,6 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte ...@@ -143,8 +142,6 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
/** /**
* @param string $uuid * @param string $uuid
*
* @return null
*/ */
public function get($uuid) public function get($uuid)
{ {
...@@ -152,7 +149,7 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte ...@@ -152,7 +149,7 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
return null; return null;
} }
if (!is_string($uuid) || !Uuid::isValid($uuid)) { if (!is_string($uuid) || !Uuid::isValid($uuid)) {
throw new InvalidArgumentException(sprintf('Identifiant invalide: %s', (string)$uuid)); throw new InvalidArgumentException(sprintf('Identifiant invalide: %s', (string) $uuid));
} }
return $this->findOneById($uuid); return $this->findOneById($uuid);
......
...@@ -27,7 +27,8 @@ use Rhumsaa\Uuid\Uuid; ...@@ -27,7 +27,8 @@ use Rhumsaa\Uuid\Uuid;
class UploadedFile implements UploadedFileInterface class UploadedFile implements UploadedFileInterface
{ {
/** /**
* Taille de bloc utilisé pour les copies * Taille de bloc utilisé pour les copies.
*
* @var int * @var int
*/ */
public static $copyBlockSize = 8192; public static $copyBlockSize = 8192;
...@@ -37,18 +38,21 @@ class UploadedFile implements UploadedFileInterface ...@@ -37,18 +38,21 @@ class UploadedFile implements UploadedFileInterface
/** /**
* @ORM\Id * @ORM\Id
* @ORM\Column(type="guid") * @ORM\Column(type="guid")
*
* @var string * @var string
*/ */
private $id; private $id;
/** /**
* @ORM\Column(type="string", length=1024) * @ORM\Column(type="string", length=1024)
*
* @var string * @var string
*/ */
private $displayName; private $displayName;
/** /**
* @ORM\Column(type="string", length=1024) * @ORM\Column(type="string", length=1024)
*
* @var string * @var string
*/ */
private $path; private $path;
...@@ -60,54 +64,63 @@ class UploadedFile implements UploadedFileInterface ...@@ -60,54 +64,63 @@ class UploadedFile implements UploadedFileInterface
/** /**
* @ORM\Column(type="string", length=255, nullable=true) * @ORM\Column(type="string", length=255, nullable=true)
*
* @var string * @var string
*/ */
private $mimeType; private $mimeType;
/** /**
* @ORM\Column(type="integer", nullable=true) * @ORM\Column(type="integer", nullable=true)
*
* @var int * @var int
*/ */
private $size; private $size;
/** /**
* @ORM\Column(type="string", length=64, nullable=true) * @ORM\Column(type="string", length=64, nullable=true)
*
* @var string * @var string
*/ */
private $checksum; private $checksum;
/** /**
* @ORM\Column(type="string", length=10) * @ORM\Column(type="string", length=10)
*
* @var string * @var string
*/ */
private $etat = self::ETAT_EN_COURS; private $etat = self::ETAT_EN_COURS;
/** /**
* @ORM\Column(type="datetime") * @ORM\Column(type="datetime")
*
* @var DateTime * @var DateTime
*/ */
private $createdAt; private $createdAt;
/** /**
* @ORM\Column(type="string", nullable=true) * @ORM\Column(type="string", nullable=true)
*
* @var string * @var string
*/ */
private $createdBy; private $createdBy;
/** /**
* @ORM\Column(type="string", nullable=true) * @ORM\Column(type="string", nullable=true)
*
* @var string * @var string
*/ */
private $createdFrom; private $createdFrom;
/** /**
* @ORM\Column(type="json_array", nullable=true) * @ORM\Column(type="json_array", nullable=true)
*
* @var array * @var array
*/ */
private $metadata; private $metadata;
/** /**
* @ORM\Column(type="string", length=256, nullable=true) * @ORM\Column(type="string", length=256, nullable=true)
*
* @var string * @var string
*/ */
private $description; private $description;
...@@ -269,7 +282,7 @@ class UploadedFile implements UploadedFileInterface ...@@ -269,7 +282,7 @@ class UploadedFile implements UploadedFileInterface
], ],
true true
)) { )) {
throw new InvalidArgumentException(sprintf("Etat invalide: '%s'", (string)$etat)); throw new InvalidArgumentException(sprintf("Etat invalide: '%s'", (string) $etat));
} }
// Déplace le fichier hors de l'orphelinat quand on passe d'orphelin à nouveau // Déplace le fichier hors de l'orphelinat quand on passe d'orphelin à nouveau
...@@ -339,6 +352,7 @@ class UploadedFile implements UploadedFileInterface ...@@ -339,6 +352,7 @@ class UploadedFile implements UploadedFileInterface
* @param Filesystem $filesystem * @param Filesystem $filesystem
* *
* @return self * @return self
*
* @internal * @internal
*/ */
public function setFilesystem(Filesystem $filesystem) public function setFilesystem(Filesystem $filesystem)
...@@ -484,13 +498,13 @@ class UploadedFile implements UploadedFileInterface ...@@ -484,13 +498,13 @@ class UploadedFile implements UploadedFileInterface
} }
/** Wrapper de stream_copy_to_stream /** Wrapper de stream_copy_to_stream
*
* @param resource $source * @param resource $source
* @param resource $dest * @param resource $dest
* @param int $maxlen * @param int $maxlen
* @param int $offset * @param int $offset
* *
* @return int * @return int
*
* @internal * @internal
*/ */
protected function stream_copy_to_stream($source, $dest, $maxlen = -1, $offset = 0) protected function stream_copy_to_stream($source, $dest, $maxlen = -1, $offset = 0)
...@@ -499,10 +513,10 @@ class UploadedFile implements UploadedFileInterface ...@@ -499,10 +513,10 @@ class UploadedFile implements UploadedFileInterface
} }
/** Wrapper de feof /** Wrapper de feof
*
* @param resource $filehandle * @param resource $filehandle
* *
* @return bool * @return bool
*
* @internal * @internal
*/ */
protected function feof($filehandle) protected function feof($filehandle)
...@@ -511,11 +525,11 @@ class UploadedFile implements UploadedFileInterface ...@@ -511,11 +525,11 @@ class UploadedFile implements UploadedFileInterface
} }
/** Wrapper de fread /** Wrapper de fread
*
* @param resource $filehandle * @param resource $filehandle
* @param int $maxlen * @param int $maxlen
* *
* @return int|bool * @return int|bool
*
* @internal * @internal
*/ */
protected function fread($filehandle, $maxlen = -1) protected function fread($filehandle, $maxlen = -1)
...@@ -524,11 +538,11 @@ class UploadedFile implements UploadedFileInterface ...@@ -524,11 +538,11 @@ class UploadedFile implements UploadedFileInterface
} }
/** Wrapper de fwrite /** Wrapper de fwrite
*
* @param resource $filehandle * @param resource $filehandle
* @param int $maxlen * @param int $maxlen
* *
* @return int|bool * @return int|bool
*
* @internal * @internal
*/ */
protected function fwrite($filehandle, $maxlen = -1) protected function fwrite($filehandle, $maxlen = -1)
...@@ -537,10 +551,10 @@ class UploadedFile implements UploadedFileInterface ...@@ -537,10 +551,10 @@ class UploadedFile implements UploadedFileInterface
} }
/** Vérifie si un chemin est "safe". /** Vérifie si un chemin est "safe".
*
* @param string $path * @param string $path
* *
* @return bool * @return bool
*
* @internal * @internal
*/ */
public static function isSafePath($path) public static function isSafePath($path)
...@@ -684,6 +698,7 @@ class UploadedFile implements UploadedFileInterface ...@@ -684,6 +698,7 @@ class UploadedFile implements UploadedFileInterface
/** /**
* Met à jour le chemin réel du fichier. * Met à jour le chemin réel du fichier.
*
* @ORM\PostLoad * @ORM\PostLoad
* @ORM\PostPersist * @ORM\PostPersist
* @ORM\PostUpdate * @ORM\PostUpdate
......
...@@ -21,9 +21,9 @@ class RejectedFileException extends RuntimeException implements Exception ...@@ -21,9 +21,9 @@ class RejectedFileException extends RuntimeException implements Exception
/** /**
* @param UploadedFileInterface $uploadedFile * @param UploadedFileInterface $uploadedFile
* @param string $message * @param string $message
* @param int $code * @param int $code
* @param \Exception $previous * @param \Exception $previous
* *
* @internal param UploadedFileInterface $file * @internal param UploadedFileInterface $file
*/ */
......
...@@ -127,7 +127,7 @@ class FileUploadType extends AbstractType ...@@ -127,7 +127,7 @@ class FileUploadType extends AbstractType
* @todo Implémenter min_file_size, max_file_size && accept_file_types. * @todo Implémenter min_file_size, max_file_size && accept_file_types.
* *
* @param OptionsResolver $options * @param OptionsResolver $options
* @param mixed $constraints * @param mixed $constraints
* *
* @return array|mixed * @return array|mixed
*/ */
......
...@@ -77,10 +77,11 @@ class UploadedFileResponse extends Response ...@@ -77,10 +77,11 @@ class UploadedFileResponse extends Response
/** /**
* Sets the file to stream. * Sets the file to stream.
* *
* @param UploadedFileInterface $file The file to stream * @param UploadedFileInterface $file The file to stream
* @param string $contentDisposition * @param string $contentDisposition
* *
* @throws FileException * @throws FileException
*
* @return UploadedFileResponse * @return UploadedFileResponse
*/ */
public function setFile(UploadedFileInterface $file, $contentDisposition = null) public function setFile(UploadedFileInterface $file, $contentDisposition = null)
...@@ -100,6 +101,7 @@ class UploadedFileResponse extends Response ...@@ -100,6 +101,7 @@ class UploadedFileResponse extends Response
/** /**
* Gets the file. * Gets the file.
*
* @return UploadedFileInterface The file to stream * @return UploadedFileInterface The file to stream
*/ */
public function getFile() public function getFile()
...@@ -164,13 +166,13 @@ class UploadedFileResponse extends Response ...@@ -164,13 +166,13 @@ class UploadedFileResponse extends Response
[$start, $end] = explode('-', substr($range, 6), 2) + [0]; [$start, $end] = explode('-', substr($range, 6), 2) + [0];
$end = ('' === $end) ? $fileSize - 1 : (int)$end; $end = ('' === $end) ? $fileSize - 1 : (int) $end;
if ('' === $start) { if ('' === $start) {
$start = $fileSize - $end; $start = $fileSize - $end;
$end = $fileSize - 1; $end = $fileSize - 1;
} else { } else {
$start = (int)$start; $start = (int) $start;
} }
if ($start <= $end) { if ($start <= $end) {
...@@ -213,6 +215,7 @@ class UploadedFileResponse extends Response ...@@ -213,6 +215,7 @@ class UploadedFileResponse extends Response
/** /**
* {@inheritdoc} * {@inheritdoc}
*
* @throws LogicException when the content is not null * @throws LogicException when the content is not null
*/ */
public function setContent($content) public function setContent($content)
...@@ -224,6 +227,7 @@ class UploadedFileResponse extends Response ...@@ -224,6 +227,7 @@ class UploadedFileResponse extends Response
/** /**
* {@inheritdoc} * {@inheritdoc}
*
* @return false * @return false
*/ */
public function getContent() public function getContent()
......
...@@ -9,7 +9,7 @@ namespace Irstea\FileUploadBundle; ...@@ -9,7 +9,7 @@ namespace Irstea\FileUploadBundle;
use Symfony\Component\HttpKernel\Bundle\Bundle; use Symfony\Component\HttpKernel\Bundle\Bundle;
/** /**
* {@inheritDoc} * {@inheritdoc}
*/ */
class IrsteaFileUploadBundle extends Bundle class IrsteaFileUploadBundle extends Bundle
{ {
......
...@@ -35,7 +35,7 @@ class CreationDataListener ...@@ -35,7 +35,7 @@ class CreationDataListener
/** /**
* @param UploadedFileInterface $file * @param UploadedFileInterface $file
* @param LifecycleEventArgs $event * @param LifecycleEventArgs $event
*/ */
public function prePersist(UploadedFileInterface $file, LifecycleEventArgs $event) public function prePersist(UploadedFileInterface $file, LifecycleEventArgs $event)
{ {
......
...@@ -35,7 +35,6 @@ class UploadedFileListener ...@@ -35,7 +35,6 @@ class UploadedFileListener
} }
/** Passe le filesystem à l'entité. /** Passe le filesystem à l'entité.
*
* @param UploadedFileInterface $file * @param UploadedFileInterface $file
* @param LifecycleEventArgs $event * @param LifecycleEventArgs $event
*/ */
...@@ -45,7 +44,6 @@ class UploadedFileListener ...@@ -45,7 +44,6 @@ class UploadedFileListener
} }
/** Renomme le fichier disque lorsque l'on change l'attribut 'path'. /** Renomme le fichier disque lorsque l'on change l'attribut 'path'.
*
* @param UploadedFileInterface $file * @param UploadedFileInterface $file
* @param LifecycleEventArgs $event * @param LifecycleEventArgs $event
*/ */
...@@ -61,7 +59,6 @@ class UploadedFileListener ...@@ -61,7 +59,6 @@ class UploadedFileListener
} }
/** Enregistre le chemin du fichier à supprimer. /** Enregistre le chemin du fichier à supprimer.
*
* @param UploadedFileInterface $file * @param UploadedFileInterface $file
* @param LifecycleEventArgs $event * @param LifecycleEventArgs $event
*/ */
...@@ -71,7 +68,6 @@ class UploadedFileListener ...@@ -71,7 +68,6 @@ class UploadedFileListener
} }
/** Supprime le fichier correspondant à l'UploadedFileInterface supprimé. /** Supprime le fichier correspondant à l'UploadedFileInterface supprimé.
*
* @param UploadedFileInterface $file * @param UploadedFileInterface $file
* @param LifecycleEventArgs $event * @param LifecycleEventArgs $event
*/ */
......
...@@ -15,10 +15,10 @@ use Symfony\Component\Validator\Exception\InvalidArgumentException; ...@@ -15,10 +15,10 @@ use Symfony\Component\Validator\Exception\InvalidArgumentException;
interface FileManagerInterface interface FileManagerInterface
{ {
/** Retrouve un fichier uploadé par son identifiant. /** Retrouve un fichier uploadé par son identifiant.
*
* @param string $id identifiant du fichier * @param string $id identifiant du fichier
* *
* @return UploadedFileInterface|null le fichier retrouvé ou null si aucun fichier ne correspond * @return UploadedFileInterface|null le fichier retrouvé ou null si aucun fichier ne correspond
*
* @api * @api
*/ */
public function get($id); public function get($id);
...@@ -32,6 +32,7 @@ interface FileManagerInterface ...@@ -32,6 +32,7 @@ interface FileManagerInterface
* @param int $lastModified timestamp de la date de dernière modification * @param int $lastModified timestamp de la date de dernière modification
* *
* @return UploadedFileInterface le fichier créé * @return UploadedFileInterface le fichier créé
*
* @api * @api
*/ */
public function create($name, $size, $mimeType, $lastModified = null); public function create($name, $size, $mimeType, $lastModified = null);
...@@ -43,7 +44,9 @@ interface FileManagerInterface ...@@ -43,7 +44,9 @@ interface FileManagerInterface
* @param UploadedFileInterface $original * @param UploadedFileInterface $original
* *
* @throws InvalidArgumentException le fichier original est invalide * @throws InvalidArgumentException le fichier original est invalide
*
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function duplicate(UploadedFileInterface $original); public function duplicate(UploadedFileInterface $original);
...@@ -69,13 +72,16 @@ interface FileManagerInterface ...@@ -69,13 +72,16 @@ interface FileManagerInterface
/** Retourne une liste de fichiers invalides à supprimer. /** Retourne une liste de fichiers invalides à supprimer.
* Ce sont des fichiers partiels ou orphelin qui n'ont pas été modifiés depuis plus d'une heure. * Ce sont des fichiers partiels ou orphelin qui n'ont pas été modifiés depuis plus d'une heure.
*
* @return UploadedFileInterface[] * @return UploadedFileInterface[]
*
* @internal * @internal
*/ */
public function findGarbage(); public function findGarbage();
/** Retourne la liste des fichiers à valider. /** Retourne la liste des fichiers à valider.
* @return UploadedFileInterface[] * @return UploadedFileInterface[]
*
* @internal * @internal
*/ */
public function findFilesToValidate(); public function findFilesToValidate();
......
...@@ -19,36 +19,42 @@ interface UploadedFileInterface ...@@ -19,36 +19,42 @@ interface UploadedFileInterface
/** Fichier orphelin. /** Fichier orphelin.
* Fichier qui n'a pas encore été associé à un objet métier. * Fichier qui n'a pas encore été associé à un objet métier.
*
* @var string * @var string
*/ */
public const ETAT_ORPHELIN = 'orphelin'; public const ETAT_ORPHELIN = 'orphelin';
/** Fichier normal. /** Fichier normal.
* Fichier associé à un objet métier. * Fichier associé à un objet métier.
*
* @var string * @var string
*/ */
public const ETAT_NORMAL = 'normal'; public const ETAT_NORMAL = 'normal';
/** Fichier corrompu. /** Fichier corrompu.
* Fichier dont le contenu disque ne correspond pas à la somme de contrôle enregistreé en base de données. * Fichier dont le contenu disque ne correspond pas à la somme de contrôle enregistreé en base de données.
*
* @var string * @var string
*/ */
public const ETAT_CORROMPU = 'corrompu'; public const ETAT_CORROMPU = 'corrompu';
/** Fichier manquant. /** Fichier manquant.
* Fichier existant en base de données mais introuvable sur disque. * Fichier existant en base de données mais introuvable sur disque.
*
* @var string * @var string
*/ */
public const ETAT_MANQUANT = 'manquant'; public const ETAT_MANQUANT = 'manquant';
/** Fichier rejeté. /** Fichier rejeté.
* Fichier uploadé mais rejeté par un listener (par exemple l'antivirus). * Fichier uploadé mais rejeté par un listener (par exemple l'antivirus).
*
* @var string * @var string
*/ */
public const ETAT_REJETE = 'rejete'; public const ETAT_REJETE = 'rejete';
/** Retourne l'identifiant du fichier. /** Retourne l'identifiant du fichier.
* @return string * @return string
*
* @api * @api
*/ */
public function getId(); public function getId();
...@@ -59,12 +65,14 @@ interface UploadedFileInterface ...@@ -59,12 +65,14 @@ interface UploadedFileInterface
* @param string $displayName * @param string $displayName
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function setDisplayName($displayName); public function setDisplayName($displayName);
/** Retourne le nom original du fichier (c-à-d sur le poste de l'utilisateur ayant fait l'upload.) /** Retourne le nom original du fichier (c-à-d sur le poste de l'utilisateur ayant fait l'upload.)
* @return string * @return string
*
* @api * @api
*/ */
public function getDisplayName(); public function getDisplayName();
...@@ -73,18 +81,21 @@ interface UploadedFileInterface ...@@ -73,18 +81,21 @@ interface UploadedFileInterface
* @param string $description * @param string $description
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function setDescription($description = null); public function setDescription($description = null);
/** Retourne la description du fichier. /** Retourne la description du fichier.
* @return string * @return string
*
* @api * @api
*/ */
public function getDescription(); public function getDescription();
/** Retourne le chemin du fichier dans le filesystem. /** Retourne le chemin du fichier dans le filesystem.
* @return string * @return string
*
* @api * @api
*/ */
public function getPath(); public function getPath();
...@@ -95,16 +106,18 @@ interface UploadedFileInterface ...@@ -95,16 +106,18 @@ interface UploadedFileInterface
* @param string $path * @param string $path
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function setPath($path); public function setPath($path);
/** Change le chemin du fichier sans changer le nom. /** Change le chemin du fichier sans changer le nom.
*
* @param string $newDir Nouveau répertoire * @param string $newDir Nouveau répertoire
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @uses \UploadedFileInterface::setPath * @uses \UploadedFileInterface::setPath
*
* @api * @api
*/ */
public function moveTo($newDir); public function moveTo($newDir);
...@@ -115,12 +128,14 @@ interface UploadedFileInterface ...@@ -115,12 +128,14 @@ interface UploadedFileInterface
* @param string $mimeType * @param string $mimeType
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function setMimeType($mimeType); public function setMimeType($mimeType);
/** Retourne le type MIME enregistré. /** Retourne le type MIME enregistré.
* @return string * @return string
*
* @api * @api
*/ */
public function getMimeType(); public function getMimeType();
...@@ -131,12 +146,14 @@ interface UploadedFileInterface ...@@ -131,12 +146,14 @@ interface UploadedFileInterface
* @param int $size * @param int $size
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function setSize($size); public function setSize($size);
/** Retourne la taille enregistrée, en octets. /** Retourne la taille enregistrée, en octets.
* @return int * @return int
*
* @api * @api
*/ */
public function getSize(); public function getSize();
...@@ -147,93 +164,101 @@ interface UploadedFileInterface ...@@ -147,93 +164,101 @@ interface UploadedFileInterface
* @param string $checksum * @param string $checksum
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function setChecksum($checksum); public function setChecksum($checksum);
/** Retourne la somme de contrôle enregistrée. /** Retourne la somme de contrôle enregistrée.
* @return string * @return string
*
* @api * @api
*/ */
public function getChecksum(); public function getChecksum();
/** Modifie l'état courant du fichier. /** Modifie l'état courant du fichier.
*
* @param string $etat * @param string $etat
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function setEtat($etat); public function setEtat($etat);
/** Retourne l'état courant du fichier. /** Retourne l'état courant du fichier.
* @return string * @return string
*
* @api * @api
*/ */
public function getEtat(); public function getEtat();
/** Définit la date de création du fichier. /** Définit la date de création du fichier.
*
* @param DateTime $time * @param DateTime $time
* *
* @return self * @return self
*
* @api * @api
*/ */
public function setCreatedAt(\DateTime $time); public function setCreatedAt(\DateTime $time);
/** Définit le nom de l'utilisateur ayant uploadé le fichier. /** Définit le nom de l'utilisateur ayant uploadé le fichier.
*
* @param string $username * @param string $username
* *
* @return self * @return self
*
* @api * @api
*/ */
public function setCreatedBy($username); public function setCreatedBy($username);
/** Retourne l'adresse IP du client ayant uploadé le fichier. /** Retourne l'adresse IP du client ayant uploadé le fichier.
*
* @param string $ipAddress * @param string $ipAddress
* *
* @return self * @return self
*
* @api * @api
*/ */
public function setCreatedFrom($ipAddress); public function setCreatedFrom($ipAddress);
/** Retourne la date de création du fichier. /** Retourne la date de création du fichier.
* @return DateTime * @return DateTime
*
* @api * @api
*/ */
public function getCreatedAt(); public function getCreatedAt();
/** Retourne le nom de l'utilisateur ayant uploadé le fichier. /** Retourne le nom de l'utilisateur ayant uploadé le fichier.
* @return string * @return string
*
* @api * @api
*/ */
public function getCreatedBy(); public function getCreatedBy();
/** Retourne l'adresse IP du client ayant uploadé le fichier. /** Retourne l'adresse IP du client ayant uploadé le fichier.
* @return string * @return string
*
* @api * @api
*/ */
public function getCreatedFrom(); public function getCreatedFrom();
/** Remplace les métadonnées du fichier. /** Remplace les métadonnées du fichier.
*
* @param array $metadata les nouvelles métadonnées * @param array $metadata les nouvelles métadonnées
* *
* @return UploadedFileInterface * @return UploadedFileInterface
*
* @api * @api
*/ */
public function setMetadata(array $metadata); public function setMetadata(array $metadata);
/** Retourne les métadonnées du fichier. /** Retourne les métadonnées du fichier.
* @return array * @return array
*
* @api * @api
*/ */
public function getMetadata(); public function getMetadata();
/** Retourne une représentation texte du fichier. /** Retourne une représentation texte du fichier.
* @return string * @return string
*
* @api * @api
*/ */
public function __toString(); public function __toString();
...@@ -241,37 +266,42 @@ interface UploadedFileInterface ...@@ -241,37 +266,42 @@ interface UploadedFileInterface
/** Vérifie la validité du fichier. /** Vérifie la validité du fichier.
* Cela consiste à vérifier que le fichier existe dans le filesystem, et que la taille et la somme de contrôle * Cela consiste à vérifier que le fichier existe dans le filesystem, et que la taille et la somme de contrôle
* correspondent. En cas d'erreur, l'état du fichier est modifié en conséquence. * correspondent. En cas d'erreur, l'état du fichier est modifié en conséquence.
*
* @uses \UploadedFileInterface::setEtat * @uses \UploadedFileInterface::setEtat
*
* @api * @api
*/ */
public function validate(); public function validate();
/** Détermine si le fichier est dans un état "valide". /** Détermine si le fichier est dans un état "valide".
* @return bool * @return bool
*
* @api * @api
*/ */
public function isValid(); public function isValid();
/** Détermine si le fichier est orphelin. /** Détermine si le fichier est orphelin.
* @return bool * @return bool
*
* @api * @api
*/ */
public function isOrphelin(); public function isOrphelin();
/** Retourne la date de dernière modification dans le filesystem. /** Retourne la date de dernière modification dans le filesystem.
* @return DateTime * @return DateTime
*
* @api * @api
*/ */
public function getLastModified(); public function getLastModified();
/** Retourne le contenu du fichier. /** Retourne le contenu du fichier.
* @return string une chaîne * @return string une chaîne
*
* @api * @api
*/ */
public function getContent(); public function getContent();
/** Remplace le contenu du fichier. /** Remplace le contenu du fichier.
*
* @param string $content * @param string $content
* *
* @api * @api
...@@ -279,38 +309,43 @@ interface UploadedFileInterface ...@@ -279,38 +309,43 @@ interface UploadedFileInterface
public function setContent($content); public function setContent($content);
/** Ecrit dans le fichier depuis un descripteur de fichier. /** Ecrit dans le fichier depuis un descripteur de fichier.
*
* @param resource $source flux d'entrée à lire * @param resource $source flux d'entrée à lire
* @param int $maxlen nombre maximum d'octets à lire * @param int $maxlen nombre maximum d'octets à lire
* @param int $writeOffset offset depuis le début du fichier * @param int $writeOffset offset depuis le début du fichier
* *
* @return int nombre d'octets écrits * @return int nombre d'octets écrits
*
* @api * @api
*/ */
public function copyFrom($source, $maxlen = -1, $writeOffset = 0); public function copyFrom($source, $maxlen = -1, $writeOffset = 0);
/** Envoie le contenu du fichier dans un descripteur de fichier. /** Envoie le contenu du fichier dans un descripteur de fichier.
*
* @param resource $dest flux de sortie * @param resource $dest flux de sortie
* @param int $maxlen nombre maximum d'octets à lire * @param int $maxlen nombre maximum d'octets à lire
* @param int $readOffset offset depuis le début du fichier * @param int $readOffset offset depuis le début du fichier
* *
* @return int nombre d'octets lus * @return int nombre d'octets lus
*
* @api * @api
*/ */
public function copyTo($dest, $maxlen = PHP_INT_MAX, $readOffset = 0); public function copyTo($dest, $maxlen = PHP_INT_MAX, $readOffset = 0);
/** Retourne un nom de fichier local pour ce fichier. /** Retourne un nom de fichier local pour ce fichier.
* Ce peut-être un fichier temporaire qui sera supprimé à la fin de la requête. * Ce peut-être un fichier temporaire qui sera supprimé à la fin de la requête.
*
* @return string * @return string
*
* @api * @api
*/ */
public function getLocalPath(); public function getLocalPath();
/** Retourne une représentation "tableau" des attributs du fichier uploadé. /** Retourne une représentation "tableau" des attributs du fichier uploadé.
* Utilisé comme sérialisation du pauvre. * Utilisé comme sérialisation du pauvre.
*
* @todo Utiliser un vrai serializer. * @todo Utiliser un vrai serializer.
*
* @return array * @return array
*
* @internal * @internal
*/ */
public function toArray(); public function toArray();
...@@ -321,6 +356,7 @@ interface UploadedFileInterface ...@@ -321,6 +356,7 @@ interface UploadedFileInterface
* @param UploadedFileInterface $other * @param UploadedFileInterface $other
* *
* @return bool true si les deux fichiers ont le même contenu * @return bool true si les deux fichiers ont le même contenu
*
* @api * @api
*/ */
public function hasSameContent(UploadedFileInterface $other); public function hasSameContent(UploadedFileInterface $other);
......
...@@ -16,7 +16,7 @@ interface FileUrlGeneratorInterface ...@@ -16,7 +16,7 @@ interface FileUrlGeneratorInterface
/** /**
* Génère une URL sécurisée pour un fichier. * Génère une URL sécurisée pour un fichier.
* *
* @param string $idFile identifiant du fichier pour lequel générer l'URL * @param string $idFile identifiant du fichier pour lequel générer l'URL
* @param bool|int|string $referenceType type d'URL à générer * @param bool|int|string $referenceType type d'URL à générer
* *
* @return string L'url générée * @return string L'url générée
......
...@@ -7,10 +7,10 @@ ...@@ -7,10 +7,10 @@
namespace Irstea\FileUploadBundle\Tests\Form\DataTranformer; namespace Irstea\FileUploadBundle\Tests\Form\DataTranformer;
use Irstea\FileUploadBundle\Form\DataTranformer\UploadedFileTransformer; use Irstea\FileUploadBundle\Form\DataTranformer\UploadedFileTransformer;
use Irstea\FileUploadBundle\Model\FileManagerInterface;
use Irstea\FileUploadBundle\Model\UploadedFileInterface; use Irstea\FileUploadBundle\Model\UploadedFileInterface;
use PHPUnit_Framework_MockObject_MockObject; use PHPUnit_Framework_MockObject_MockObject;
use PHPUnit_Framework_TestCase; use PHPUnit_Framework_TestCase;
use Irstea\FileUploadBundle\Model\FileManagerInterface;
/** /**
* Generated by PHPUnit_SkeletonGenerator on 2015-01-27 at 11:36:06. * Generated by PHPUnit_SkeletonGenerator on 2015-01-27 at 11:36:06.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment