From 9860983507a7f539b8ef77ccad3deaaafa41cf2b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Guillaume=20Perr=C3=A9al?= <guillaume.perreal@irstea.fr>
Date: Tue, 1 Aug 2017 15:43:50 +0200
Subject: [PATCH] CS.
---
Command/CheckCommand.php | 9 +-
Command/CollectGarbageCommand.php | 13 ++-
Command/CreateCommand.php | 24 +++---
Command/ReadCommand.php | 14 ++--
Controller/UploadController.php | 38 ++++-----
Controller/UploadedFileController.php | 14 ++--
DependencyInjection/Configuration.php | 11 ++-
.../IrsteaFileUploadExtension.php | 6 +-
Entity/Repository/UploadedFileRepository.php | 26 +++---
Entity/UploadedFile.php | 64 ++++++++------
Event/FileUploadCompleteEvent.php | 10 +--
Exception/Exception.php | 7 +-
Exception/RejectedFileException.php | 15 ++--
FileUploadEvents.php | 7 +-
.../UploadedFileTransformer.php | 12 +--
Form/Type/FileUploadType.php | 25 ++----
Http/UploadedFileResponse.php | 47 +++++------
IrsteaFileUploadBundle.php | 4 +
Listener/CreationDataListener.php | 9 +-
Listener/UploadedFileListener.php | 17 ++--
Listener/VirusScannerListener.php | 18 ++--
Model/FileManagerInterface.php | 35 +++-----
Model/UploadedFileInterface.php | 84 +++++--------------
Service/FileUrlGenerator.php | 8 +-
Service/FileUrlGeneratorInterface.php | 11 +--
Tests/Entity/UploadedFileTest.php | 10 ++-
.../UploadedFileTransformerTest.php | 30 ++++---
Tests/Listener/UploadedFileListenerTest.php | 18 ++--
Tests/Listener/VirusScannerListenerTest.php | 9 +-
Tests/Utils/MimeTypeIconTest.php | 10 ++-
Twig/FileUploadExtension.php | 41 ++++-----
Utils/MimeTypeIcon.php | 8 +-
Validation/FileMimeType.php | 5 +-
Validation/FileMimeTypeValidator.php | 5 +-
Validation/FileSize.php | 8 +-
Validation/FileSizeValidator.php | 7 +-
36 files changed, 288 insertions(+), 391 deletions(-)
diff --git a/Command/CheckCommand.php b/Command/CheckCommand.php
index 46a0a2b9..d08190ca 100644
--- a/Command/CheckCommand.php
+++ b/Command/CheckCommand.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -11,13 +10,10 @@ use Irstea\FileUploadBundle\Model\FileManagerInterface;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
- * Description of GarbageCollectorCommand
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of GarbageCollectorCommand.
*/
class CheckCommand extends ContainerAwareCommand
{
@@ -39,6 +35,7 @@ class CheckCommand extends ContainerAwareCommand
if (count($files) == 0) {
$output->writeln('Aucun fichier à vérifier.');
+
return;
}
diff --git a/Command/CollectGarbageCommand.php b/Command/CollectGarbageCommand.php
index 976d9981..8031485f 100644
--- a/Command/CollectGarbageCommand.php
+++ b/Command/CollectGarbageCommand.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -15,9 +14,7 @@ use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
- * Description of GarbageCollectorCommand
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of GarbageCollectorCommand.
*/
class CollectGarbageCommand extends ContainerAwareCommand
{
@@ -25,7 +22,7 @@ class CollectGarbageCommand extends ContainerAwareCommand
{
$this
->setName('irstea:file-upload:collect-garbage')
- ->setDescription("Nettoie les fichiers orphelins et partiels.")
+ ->setDescription('Nettoie les fichiers orphelins et partiels.')
->addOption('dry-run', null, InputOption::VALUE_NONE, 'Affiche ce qui devrait être fait, sans le faire');
}
@@ -38,15 +35,17 @@ class CollectGarbageCommand extends ContainerAwareCommand
if (count($files) == 0) {
$output->writeln('Aucun fichier à supprimer.');
+
return;
}
if ($input->getOption('dry-run')) {
$output->writeln(sprintf('%d fichier(s) Ã supprimer.', count($files)));
+
return;
}
- $output->writeln("Suppression des fichiers");
+ $output->writeln('Suppression des fichiers');
$progress = new ProgressBar($output, count($files));
$progress->start();
diff --git a/Command/CreateCommand.php b/Command/CreateCommand.php
index b5dfbb14..12870c00 100644
--- a/Command/CreateCommand.php
+++ b/Command/CreateCommand.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -16,9 +15,7 @@ use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
- * Description of GarbageCollectorCommand
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of GarbageCollectorCommand.
*/
class CreateCommand extends ContainerAwareCommand
{
@@ -26,10 +23,10 @@ class CreateCommand extends ContainerAwareCommand
{
$this
->setName('irstea:file-upload:create')
- ->setDescription("Créer un fichier.")
- ->addOption('mime-type', 't', InputOption::VALUE_REQUIRED, "Force le type MIME.")
- ->addOption('display-name', 'd', InputOption::VALUE_REQUIRED, "Indique un nom de fichier.")
- ->addOption('metadata', 'm', InputOption::VALUE_REQUIRED, "Ajoute des métadata (format JSON).")
+ ->setDescription('Créer un fichier.')
+ ->addOption('mime-type', 't', InputOption::VALUE_REQUIRED, 'Force le type MIME.')
+ ->addOption('display-name', 'd', InputOption::VALUE_REQUIRED, 'Indique un nom de fichier.')
+ ->addOption('metadata', 'm', InputOption::VALUE_REQUIRED, 'Ajoute des métadata (format JSON).')
->addArgument('path', InputArgument::REQUIRED, "Nom du fichier à ajouter, - pour lire l'entrée standard");
}
@@ -42,14 +39,13 @@ class CreateCommand extends ContainerAwareCommand
$em->transactional(
function () use ($input, $output, $em, &$file, &$written) {
-
/* @var $manager FileManagerInterface */
$manager = $this->getContainer()->get('irstea_file_upload.file_manager');
- $path = $input->getArgument("path");
- if ("-" === $path) {
+ $path = $input->getArgument('path');
+ if ('-' === $path) {
$realPath = 'php://stdin';
- $displayName = "stdin";
+ $displayName = 'stdin';
$lastModified = time();
$size = 0;
} else {
@@ -88,7 +84,7 @@ class CreateCommand extends ContainerAwareCommand
);
if ($output->isVerbose()) {
- $output->writeln(sprintf("%s crée, %d octets lus.", $file->getId(), $written));
+ $output->writeln(sprintf('%s crée, %d octets lus.', $file->getId(), $written));
} else {
$output->writeln($file->getId());
}
diff --git a/Command/ReadCommand.php b/Command/ReadCommand.php
index 312728b6..aa835ca2 100644
--- a/Command/ReadCommand.php
+++ b/Command/ReadCommand.php
@@ -1,13 +1,11 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
namespace Irstea\FileUploadBundle\Command;
-use Doctrine\ORM\EntityManager;
use Irstea\FileUploadBundle\Model\FileManagerInterface;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputArgument;
@@ -16,9 +14,7 @@ use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
- * Description of GarbageCollectorCommand
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of GarbageCollectorCommand.
*/
class ReadCommand extends ContainerAwareCommand
{
@@ -29,8 +25,8 @@ class ReadCommand extends ContainerAwareCommand
->setDescription("Récupère le contenu d'un fichier.")
->addOption('append', 'a', InputOption::VALUE_NONE, "Ajoute au fichier de destination au lieu de l'écraser.")
->addOption('overwrite', 'y', InputOption::VALUE_NONE, "Ecrase le fichier de destination s'il existe.")
- ->addArgument('id', InputArgument::REQUIRED, "Identifiant du fichier à récupérer.")
- ->addArgument('filepath', InputArgument::OPTIONAL, "Chemin du fichier dans lequel écrire.");
+ ->addArgument('id', InputArgument::REQUIRED, 'Identifiant du fichier à récupérer.')
+ ->addArgument('filepath', InputArgument::OPTIONAL, 'Chemin du fichier dans lequel écrire.');
}
protected function execute(InputInterface $input, OutputInterface $output)
@@ -58,7 +54,7 @@ class ReadCommand extends ContainerAwareCommand
fclose($fh);
if ($output->isVerbose() && null !== $path) {
- $output->writeln(sprintf("%d octets écrits.", $written));
+ $output->writeln(sprintf('%d octets écrits.', $written));
}
}
}
diff --git a/Controller/UploadController.php b/Controller/UploadController.php
index 1f0f34cb..cb53aa90 100644
--- a/Controller/UploadController.php
+++ b/Controller/UploadController.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -32,16 +31,14 @@ use Symfony\Component\Templating\EngineInterface;
*/
class UploadController extends Controller
{
- const CSRF_INTENTION = "uploaded_file";
+ const CSRF_INTENTION = 'uploaded_file';
/**
- *
* @var FileManagerInterface
*/
protected $fileManager;
/**
- *
* @var UrlGeneratorInterface
*/
protected $urlGenerator;
@@ -61,9 +58,6 @@ class UploadController extends Controller
*/
protected $templating;
- /**
- *
- */
public function __construct(
FileManagerInterface $fileManager,
UrlGeneratorInterface $urlGenerator,
@@ -81,6 +75,7 @@ class UploadController extends Controller
/**
* @Route("", name="file_upload_create")
* @Method("POST")
+ *
* @param Request $request
*/
public function createAction(Request $request)
@@ -125,7 +120,8 @@ class UploadController extends Controller
/**
* @Route("/{id}/content", name="file_upload_put_content")
* @Method("PUT")
- * @param Request $request
+ *
+ * @param Request $request
* @param UploadedFile $file
*/
public function putContentAction(Request $request, UploadedFile $file)
@@ -151,21 +147,19 @@ class UploadController extends Controller
}
/**
- *
* @param Request $request
*
* @return array
*/
protected function handleRangeHeader(Request $request)
{
-
if (null === $range = $request->headers->get('Content-Range', null)) {
return [0, PHP_INT_MAX, true];
}
$matches = [];
if (!preg_match('@^bytes (\d+)-(\d+)/(\d+)$@', $range, $matches)) {
- throw new BadRequestHttpException("Invalid Content-Range");
+ throw new BadRequestHttpException('Invalid Content-Range');
}
$start = intval($matches[1]);
@@ -180,7 +174,6 @@ class UploadController extends Controller
}
/**
- *
* @param UploadedFileInterface $file
*
* @return Response
@@ -213,7 +206,8 @@ class UploadController extends Controller
/**
* @Route("/{id}/content", name="file_upload_get_content")
* @Method("GET")
- * @param Request $request
+ *
+ * @param Request $request
* @param UploadedFile $file
*/
public function getContentAction(Request $request, UploadedFile $file)
@@ -226,13 +220,15 @@ class UploadController extends Controller
$response = UploadedFileResponse::create($file, 200, [], false, ResponseHeaderBag::DISPOSITION_ATTACHMENT);
$response->isNotModified($request);
+
return $response;
}
/**
* @Route("/{id}", name="file_upload_delete")
* @Method("DELETE")
- * @param Request $request
+ *
+ * @param Request $request
* @param UploadedFile $file
*/
public function deleteAction(Request $request, UploadedFile $file)
@@ -249,7 +245,6 @@ class UploadController extends Controller
}
/**
- *
* @param Request $request
*
* @throws HttpException
@@ -262,11 +257,10 @@ class UploadController extends Controller
}
/**
- *
- * @param int $status
+ * @param int $status
* @param string $message
- * @param array $data
- * @param array $headers
+ * @param array $data
+ * @param array $headers
*
* @return JsonResponse
*/
@@ -276,11 +270,11 @@ class UploadController extends Controller
$data['message'] = $message;
$response = new JsonResponse($data, $status, $headers);
$response->setStatusCode($status, $message);
+
return $response;
}
/**
- *
* @param \Exception $ex
*
* @return JsonResponse
@@ -289,7 +283,7 @@ class UploadController extends Controller
{
return $this->createResponse(
$ex instanceof HttpException ? $ex->getStatusCode() : Response::HTTP_INTERNAL_SERVER_ERROR,
- preg_replace("/[\n\r]+/", " ", $ex->getMessage()),
+ preg_replace("/[\n\r]+/", ' ', $ex->getMessage()),
[
'exception' => [
'class' => get_class($ex),
diff --git a/Controller/UploadedFileController.php b/Controller/UploadedFileController.php
index 6f3a71fe..665500af 100644
--- a/Controller/UploadedFileController.php
+++ b/Controller/UploadedFileController.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle\Controller;
@@ -9,7 +13,6 @@ use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
-
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
@@ -33,11 +36,11 @@ class UploadedFileController extends Controller
$em = $this->getDoctrine()->getManager();
$queryBuilder = $em->getRepository('IrsteaFileUploadBundle:UploadedFile')
- ->createQueryBuilder("u")
- ->orderBy("u.createdAt", "DESC");
+ ->createQueryBuilder('u')
+ ->orderBy('u.createdAt', 'DESC');
$pager = new Pagerfanta(new DoctrineORMAdapter($queryBuilder));
- $pager->setCurrentPage($request->query->get("page", 1));
+ $pager->setCurrentPage($request->query->get('page', 1));
$uploadedFiles = $pager->getCurrentPageResults();
@@ -56,7 +59,6 @@ class UploadedFileController extends Controller
*/
public function showAction(UploadedFile $uploadedFile)
{
-
return [
'uploadedFile' => $uploadedFile,
];
@@ -64,7 +66,7 @@ class UploadedFileController extends Controller
/**
* @param string $message
- * @param array $parameters
+ * @param array $parameters
*/
public function notice($message, array $parameters = [])
{
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
index 92e0acd7..82810d3b 100644
--- a/DependencyInjection/Configuration.php
+++ b/DependencyInjection/Configuration.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle\DependencyInjection;
@@ -6,7 +10,7 @@ use Symfony\Component\Config\Definition\Builder\TreeBuilder;
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}
*/
@@ -28,12 +32,13 @@ class Configuration implements ConfigurationInterface
->then(
function ($v) {
$int = intval($v);
- if (strpos($v, "K")) {
+ if (strpos($v, 'K')) {
return 1000 * $int;
}
- if (strpos($v, "M")) {
+ if (strpos($v, 'M')) {
return 1000000 * $int;
}
+
return $int;
}
)
diff --git a/DependencyInjection/IrsteaFileUploadExtension.php b/DependencyInjection/IrsteaFileUploadExtension.php
index 48544d63..2fbce612 100644
--- a/DependencyInjection/IrsteaFileUploadExtension.php
+++ b/DependencyInjection/IrsteaFileUploadExtension.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle\DependencyInjection;
@@ -47,7 +51,7 @@ class IrsteaFileUploadExtension extends Extension implements PrependExtensionInt
"$pluginDir/js/jquery.fileupload-process.js",
"$pluginDir/js/jquery.fileupload-validate.js",
"$pluginDir/js/jquery.fileupload-ui.js",
- "@BazingaJsTranslationBundle/Resources/js/translator.js",
+ '@BazingaJsTranslationBundle/Resources/js/translator.js',
'js/translations/file_upload/*.js',
'js/translations/validators/*.js',
'@IrsteaFileUploadBundle/Resources/js/widget/file_upload.js',
diff --git a/Entity/Repository/UploadedFileRepository.php b/Entity/Repository/UploadedFileRepository.php
index 47f2fb97..4b4f58ce 100644
--- a/Entity/Repository/UploadedFileRepository.php
+++ b/Entity/Repository/UploadedFileRepository.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -24,9 +23,7 @@ use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
/**
- * Description of UploadedFileRepository
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of UploadedFileRepository.
*/
class UploadedFileRepository extends EntityRepository implements FileManagerInterface
{
@@ -43,7 +40,6 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
protected $eventDispatcher;
/**
- *
* @param Filesystem $filesystem
*/
public function setFilesystem(Filesystem $filesystem)
@@ -52,7 +48,6 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
}
/**
- *
* @param EventDispatcherInterface $eventDispatcher
*/
public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
@@ -89,16 +84,16 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
public function duplicate(UploadedFileInterface $original)
{
if (!$original->isValid()) {
- throw new InvalidArgumentException("Impossible de dupliquer le fichier " . $original->getId() . " car il est invalide !");
+ throw new InvalidArgumentException('Impossible de dupliquer le fichier ' . $original->getId() . ' car il est invalide !');
}
$new = new UploadedFile();
$metadata = $original->getMetadata();
- if (!isset($metadata["duplicateOf"])) {
- $metadata["duplicateOf"] = [$original->getId()];
+ if (!isset($metadata['duplicateOf'])) {
+ $metadata['duplicateOf'] = [$original->getId()];
} else {
- array_unshift($metadata["duplicateOf"], $original->getId());
+ array_unshift($metadata['duplicateOf'], $original->getId());
}
$new
@@ -111,7 +106,7 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
->setSize($original->getSize());
$stream = $this->filesystem->createStream($new->getPath());
- $stream->open(new StreamMode("cb"));
+ $stream->open(new StreamMode('cb'));
$original->copyTo($stream->cast(STREAM_CAST_AS_STREAM));
$stream->close();
@@ -134,8 +129,9 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
return null;
}
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);
}
@@ -168,10 +164,9 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
}
/**
- *
* @param string $level
* @param string $message
- * @param array $context
+ * @param array $context
*/
protected function log($level, $message, array $context = [])
{
@@ -191,6 +186,7 @@ class UploadedFileRepository extends EntityRepository implements FileManagerInte
$files,
function (UploadedFileInterface $file) use ($limit) {
$mtime = $file->getLastModified();
+
return $mtime === null || $mtime < $limit;
}
);
diff --git a/Entity/UploadedFile.php b/Entity/UploadedFile.php
index ddbf453e..d556bfe0 100644
--- a/Entity/UploadedFile.php
+++ b/Entity/UploadedFile.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -28,25 +27,28 @@ use Rhumsaa\Uuid\Uuid;
class UploadedFile implements UploadedFileInterface
{
// Taille de bloc utilisé pour les copies
- static public $copyBlockSize = 8192;
+ public static $copyBlockSize = 8192;
- const ORPHAN_PREFIX = "orphan/";
+ const ORPHAN_PREFIX = 'orphan/';
/**
* @ORM\Id
* @ORM\Column(type="guid")
+ *
* @var string
*/
private $id;
/**
* @ORM\Column(type="string", length=1024)
+ *
* @var string
*/
private $displayName;
/**
* @ORM\Column(type="string", length=1024)
+ *
* @var string
*/
private $path;
@@ -57,56 +59,64 @@ class UploadedFile implements UploadedFileInterface
private $actualPath;
/**
- *
* @ORM\Column(type="string", length=255, nullable=true)
+ *
* @var string
*/
private $mimeType = null;
/**
* @ORM\Column(type="integer", nullable=true)
+ *
* @var int
*/
private $size = null;
/**
* @ORM\Column(type="string", length=64, nullable=true)
+ *
* @var string
*/
private $checksum = null;
/**
* @ORM\Column(type="string", length=10)
+ *
* @var string
*/
private $etat = self::ETAT_EN_COURS;
/**
* @ORM\Column(type="datetime")
+ *
* @var DateTime
*/
private $createdAt;
/**
* @ORM\Column(type="string", nullable=true)
+ *
* @var string
*/
private $createdBy;
/**
* @ORM\Column(type="string", nullable=true)
+ *
* @var string
*/
private $createdFrom;
/**
* @ORM\Column(type="json_array", nullable=true)
+ *
* @var array
*/
private $metadata = null;
/**
* @ORM\Column(type="string", length=256, nullable=true)
+ *
* @var string
*/
private $description = null;
@@ -117,13 +127,11 @@ class UploadedFile implements UploadedFileInterface
private $filesystem;
/** Contient le nom de chemin local.
- *
* @var string
*/
private $localTempPath = null;
/** Crée un UploadedFile.
- *
* @internal
*/
public function __construct()
@@ -174,6 +182,7 @@ class UploadedFile implements UploadedFileInterface
if (!isset($this->actualPath)) {
$this->actualPath = $this->path;
}
+
return $this->actualPath;
}
@@ -268,7 +277,7 @@ class UploadedFile implements UploadedFileInterface
self::ETAT_REJETE,
]
)) {
- 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
@@ -320,17 +329,18 @@ class UploadedFile implements UploadedFileInterface
*/
public function __toString()
{
- $unit = "";
+ $unit = '';
$size = $this->size ?: 0;
if ($size >= 10240) {
$size /= 1024;
- $unit = "k";
+ $unit = 'k';
if ($size >= 10240) {
$size /= 1024;
- $unit = "m";
+ $unit = 'm';
}
}
- return sprintf("%s (%s, %d%so)", $this->displayName, $this->mimeType ?: '?/?', $size, $unit);
+
+ return sprintf('%s (%s, %d%so)', $this->displayName, $this->mimeType ?: '?/?', $size, $unit);
}
/**
@@ -343,6 +353,7 @@ class UploadedFile implements UploadedFileInterface
public function setFilesystem(Filesystem $filesystem)
{
$this->filesystem = $filesystem;
+
return $this;
}
@@ -360,11 +371,13 @@ class UploadedFile implements UploadedFileInterface
if (!$filesystem->has($path)) {
$this->setEtat(self::ETAT_MANQUANT);
+
return;
}
if ($filesystem->size($path) !== $this->size || $filesystem->checksum($path) !== $this->checksum) {
$this->setEtat(self::ETAT_CORROMPU);
+
return;
}
}
@@ -480,11 +493,10 @@ class UploadedFile implements UploadedFileInterface
}
/** Wrapper de stream_copy_to_stream
- *
* @param resource $source
* @param resource $dest
- * @param int $maxlen
- * @param int $offset
+ * @param int $maxlen
+ * @param int $offset
*
* @return int
*
@@ -496,10 +508,9 @@ class UploadedFile implements UploadedFileInterface
}
/** Wrapper de feof
- *
* @param resource $filehandle
*
- * @return boolean
+ * @return bool
*
* @internal
*/
@@ -509,11 +520,10 @@ class UploadedFile implements UploadedFileInterface
}
/** Wrapper de fread
- *
* @param resource $filehandle
- * @param int $maxlen
+ * @param int $maxlen
*
- * @return int|boolean
+ * @return int|bool
*
* @internal
*/
@@ -523,11 +533,10 @@ class UploadedFile implements UploadedFileInterface
}
/** Wrapper de fwrite
- *
* @param resource $filehandle
- * @param int $maxlen
+ * @param int $maxlen
*
- * @return int|boolean
+ * @return int|bool
*
* @internal
*/
@@ -537,10 +546,9 @@ class UploadedFile implements UploadedFileInterface
}
/** Vérifie si un chemin est "safe".
- *
* @param string $path
*
- * @return boolean
+ * @return bool
*
* @internal
*/
@@ -565,6 +573,7 @@ class UploadedFile implements UploadedFileInterface
$level++;
}
}
+
return true;
}
@@ -582,6 +591,7 @@ class UploadedFile implements UploadedFileInterface
public function setDescription($description = null)
{
$this->description = $description;
+
return $this;
}
@@ -624,6 +634,7 @@ class UploadedFile implements UploadedFileInterface
public function setCreatedAt(DateTime $createdAt)
{
$this->createdAt = $createdAt;
+
return $this;
}
@@ -633,6 +644,7 @@ class UploadedFile implements UploadedFileInterface
public function setCreatedBy($createdBy)
{
$this->createdBy = $createdBy;
+
return $this;
}
@@ -642,6 +654,7 @@ class UploadedFile implements UploadedFileInterface
public function setCreatedFrom($createdFrom)
{
$this->createdFrom = $createdFrom;
+
return $this;
}
@@ -662,6 +675,7 @@ class UploadedFile implements UploadedFileInterface
if (stream_is_local($handle)) {
$this->localTempPath = stream_get_meta_data($handle)['uri'];
fclose($handle);
+
return $this->localTempPath;
}
fclose($handle);
diff --git a/Event/FileUploadCompleteEvent.php b/Event/FileUploadCompleteEvent.php
index a35df5a3..a88860b5 100644
--- a/Event/FileUploadCompleteEvent.php
+++ b/Event/FileUploadCompleteEvent.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -11,20 +10,16 @@ use Irstea\FileUploadBundle\Model\UploadedFileInterface;
use Symfony\Component\EventDispatcher\Event;
/**
- * Description of FileUploadCompleteEvent
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of FileUploadCompleteEvent.
*/
class FileUploadCompleteEvent extends Event
{
/**
- *
* @var UploadedFileInterface
*/
private $uploadedFile;
/**
- *
* @param UploadedFileInterface $uploadedFile
*/
public function __construct(UploadedFileInterface $uploadedFile)
@@ -33,7 +28,6 @@ class FileUploadCompleteEvent extends Event
}
/**
- *
* @return UploadedFileInterface $uploadedFile
*/
public function getUploadedFile()
diff --git a/Exception/Exception.php b/Exception/Exception.php
index 1672f274..1709a8d1 100644
--- a/Exception/Exception.php
+++ b/Exception/Exception.php
@@ -1,16 +1,11 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
namespace Irstea\FileUploadBundle\Exception;
-/**
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
- */
interface Exception
{
//put your code here
diff --git a/Exception/RejectedFileException.php b/Exception/RejectedFileException.php
index afc1108a..ff44eacf 100644
--- a/Exception/RejectedFileException.php
+++ b/Exception/RejectedFileException.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -11,24 +10,20 @@ use Irstea\FileUploadBundle\Model\UploadedFileInterface;
use RuntimeException;
/**
- * Description of RejectedFileException
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of RejectedFileException.
*/
class RejectedFileException extends RuntimeException implements Exception
{
/**
- *
* @var UploadedFileInterface
*/
protected $uploadedFile;
/**
- *
* @param UploadedFileInterface $file
- * @param string $message
- * @param int $code
- * @param \Exception $previous
+ * @param string $message
+ * @param int $code
+ * @param \Exception $previous
*/
public function __construct(UploadedFileInterface $uploadedFile, $message, $code = 0, $previous = null)
{
diff --git a/FileUploadEvents.php b/FileUploadEvents.php
index 96c71a86..a63f3ade 100644
--- a/FileUploadEvents.php
+++ b/FileUploadEvents.php
@@ -1,16 +1,13 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
namespace Irstea\FileUploadBundle;
/**
- * Description of FileUploadEvents
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of FileUploadEvents.
*/
final class FileUploadEvents
{
diff --git a/Form/DataTranformer/UploadedFileTransformer.php b/Form/DataTranformer/UploadedFileTransformer.php
index e236d7cf..26524818 100644
--- a/Form/DataTranformer/UploadedFileTransformer.php
+++ b/Form/DataTranformer/UploadedFileTransformer.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -14,18 +13,16 @@ use Symfony\Component\Form\Exception\TransformationFailedException;
use Traversable;
/**
- * Description of UploadedFileTransformer
+ * Description of UploadedFileTransformer.
*/
class UploadedFileTransformer implements DataTransformerInterface
{
/**
- *
- * @var boolean
+ * @var bool
*/
private $multiple;
/**
- *
* @var FileManagerInterface
*/
private $fileManager;
@@ -59,6 +56,7 @@ class UploadedFileTransformer implements DataTransformerInterface
$result[] = $file;
}
}
+
return $result;
}
@@ -90,7 +88,6 @@ class UploadedFileTransformer implements DataTransformerInterface
}
/**
- *
* @param mixed $value
*
* @return mixed
@@ -109,7 +106,6 @@ class UploadedFileTransformer implements DataTransformerInterface
}
/**
- *
* @param mixed $value
*
* @return UploadedFileInterface
diff --git a/Form/Type/FileUploadType.php b/Form/Type/FileUploadType.php
index cdaf9ead..18ea24bf 100644
--- a/Form/Type/FileUploadType.php
+++ b/Form/Type/FileUploadType.php
@@ -1,11 +1,7 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
- *
- * @copyright 2015 Irstea
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
namespace Irstea\FileUploadBundle\Form\Type;
@@ -27,8 +23,7 @@ use Symfony\Component\Validator\Constraints\Count;
use Symfony\Component\Validator\Constraints\NotBlank;
/** Type de champ 'file_upload'.
- *
- * Options :
+ * Options :.
*
* * multiple (boolean) : fichier unique ou multiple ? false par défaut.
* * accept_file_types (string) : expression régulière de contrôle des types MIME acceptés. Aucune par défaut.
@@ -40,35 +35,30 @@ use Symfony\Component\Validator\Constraints\NotBlank;
* * recalculate_progress (boolean) : recalculer la progression en cas d'erreur ? true par défaut.
* * sequential_uploads (boolean) : force un upload séquentiel des fichiers ? false par défaut.
* * max_chunk_size (integer) : taille maximule des parties envoyées, en octets. 0 (envoyer le fichier en une seule requête) par défaut.
- *
*/
class FileUploadType extends AbstractType
{
use \Irstea\ThemeBundle\Form\AbstractJQueryWidgetTrait;
/** Routeur.
- *
* @var Router
*/
private $router;
/** Gestionnaire de fichiers.
- *
* @var FileManagerInterface
*/
private $fileManager;
/** Taille par défaut pour l'envoi par morceaux.
- *
* @var int
*/
private $defaultMaxChunkSize;
/**
- *
- * @param Router $router
+ * @param Router $router
* @param FileManagerInterface $fileManager
- * @param int $defaultMaxChunkSize
+ * @param int $defaultMaxChunkSize
*/
public function __construct(Router $router, FileManagerInterface $fileManager, $defaultMaxChunkSize)
{
@@ -136,8 +126,9 @@ class FileUploadType extends AbstractType
}
/** Ajoute des contraintes de validation correspondants aux paramètres du champ.
- *
* @todo Implémenter min_file_size, max_file_size && accept_file_types.
+ *
+ * @param mixed $constraints
*/
protected function addConstraints(OptionsResolver $options, $constraints)
{
@@ -180,7 +171,7 @@ class FileUploadType extends AbstractType
*/
public function getBlockPrefix()
{
- return "file_upload";
+ return 'file_upload';
}
/**
@@ -206,6 +197,6 @@ class FileUploadType extends AbstractType
*/
protected function getWidgetType()
{
- return "irsteaFileUpload";
+ return 'irsteaFileUpload';
}
}
diff --git a/Http/UploadedFileResponse.php b/Http/UploadedFileResponse.php
index 400045b9..df18db87 100644
--- a/Http/UploadedFileResponse.php
+++ b/Http/UploadedFileResponse.php
@@ -1,31 +1,25 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
namespace Irstea\FileUploadBundle\Http;
-use DateTime;
use Irstea\FileUploadBundle\Model\UploadedFileInterface;
use LogicException;
-use SplFileInfo;
use Symfony\Component\HttpFoundation\File\Exception\FileException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
- * Description of UploadedFileResponse
+ * Description of UploadedFileResponse.
*
* Très, très, fortement inspiré de Symfony\Component\HttpFoundation\UploadedFileResponse.
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
class UploadedFileResponse extends Response
{
/**
- *
* @var UploadedFileInterface
*/
protected $file;
@@ -36,7 +30,6 @@ class UploadedFileResponse extends Response
protected $offset = 0;
/**
- *
* @var int
*/
protected $maxlen;
@@ -44,11 +37,11 @@ class UploadedFileResponse extends Response
/**
* Constructor.
*
- * @param UploadedFileInterface $file The file to stream
- * @param int $status The response status code
- * @param array $headers An array of response headers
- * @param bool $public Files are public by default
- * @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
+ * @param UploadedFileInterface $file The file to stream
+ * @param int $status The response status code
+ * @param array $headers An array of response headers
+ * @param bool $public Files are public by default
+ * @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
*/
public function __construct(
UploadedFileInterface $file = null,
@@ -69,11 +62,11 @@ class UploadedFileResponse extends Response
}
/**
- * @param UploadedFileInterface $file The file to stream
- * @param int $status The response status code
- * @param array $headers An array of response headers
- * @param bool $public Files are public by default
- * @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
+ * @param UploadedFileInterface $file The file to stream
+ * @param int $status The response status code
+ * @param array $headers An array of response headers
+ * @param bool $public Files are public by default
+ * @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
*
* @return UploadedFileResponse The created response
*/
@@ -85,12 +78,12 @@ class UploadedFileResponse extends Response
/**
* Sets the file to stream.
*
- * @param UploadedFileInterface $file The file to stream
- * @param string $contentDisposition
- *
- * @return UploadedFileResponse
+ * @param UploadedFileInterface $file The file to stream
+ * @param string $contentDisposition
*
* @throws FileException
+ *
+ * @return UploadedFileResponse
*/
public function setFile(UploadedFileInterface $file, $contentDisposition = null)
{
@@ -120,8 +113,8 @@ class UploadedFileResponse extends Response
/**
* Sets the Content-Disposition header with the given filename.
*
- * @param string $disposition ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
- * @param string $filename Optionally use this filename instead of the real name of the file
+ * @param string $disposition ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
+ * @param string $filename Optionally use this filename instead of the real name of the file
* @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
*
* @return UploadedFileResponse
@@ -174,13 +167,13 @@ class UploadedFileResponse extends Response
list($start, $end) = explode('-', substr($range, 6), 2) + [0];
- $end = ('' === $end) ? $fileSize - 1 : (int)$end;
+ $end = ('' === $end) ? $fileSize - 1 : (int) $end;
if ('' === $start) {
$start = $fileSize - $end;
$end = $fileSize - 1;
} else {
- $start = (int)$start;
+ $start = (int) $start;
}
if ($start <= $end) {
diff --git a/IrsteaFileUploadBundle.php b/IrsteaFileUploadBundle.php
index 9c5d2356..ede2ba02 100644
--- a/IrsteaFileUploadBundle.php
+++ b/IrsteaFileUploadBundle.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle;
diff --git a/Listener/CreationDataListener.php b/Listener/CreationDataListener.php
index cae9accb..59bdce93 100644
--- a/Listener/CreationDataListener.php
+++ b/Listener/CreationDataListener.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -9,16 +8,12 @@ namespace Irstea\FileUploadBundle\Listener;
use DateTime;
use Doctrine\ORM\Event\LifecycleEventArgs;
-use Gaufrette\Exception\FileNotFound;
-use Gaufrette\Filesystem;
use Irstea\FileUploadBundle\Model\UploadedFileInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
/**
* Ajoute les informations sur la date, l'utilisateur connecté et l'adresse IP du client dans le fichier.
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
class CreationDataListener
{
@@ -43,7 +38,7 @@ class CreationDataListener
*/
public function prePersist(UploadedFileInterface $file, LifecycleEventArgs $event)
{
- $file->setCreatedAt(new DateTime("now"));
+ $file->setCreatedAt(new DateTime('now'));
if ($request = $this->requestStack->getCurrentRequest()) {
$file->setCreatedFrom($request->getClientIp());
diff --git a/Listener/UploadedFileListener.php b/Listener/UploadedFileListener.php
index 0ee58503..0d798bfd 100644
--- a/Listener/UploadedFileListener.php
+++ b/Listener/UploadedFileListener.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -18,7 +17,6 @@ use Irstea\FileUploadBundle\Model\UploadedFileInterface;
class UploadedFileListener
{
/**
- *
* @var Filesystem
*/
private $filesystem;
@@ -29,7 +27,6 @@ class UploadedFileListener
private $scheduledDeletion = [];
/**
- *
* @param Filesystem $filesystem
*/
public function __construct(Filesystem $filesystem)
@@ -38,9 +35,8 @@ class UploadedFileListener
}
/** Passe le filesystem à l'entité.
- *
* @param UploadedFileInterface $file
- * @param LifecycleEventArgs $event
+ * @param LifecycleEventArgs $event
*/
public function postLoad(UploadedFileInterface $file, LifecycleEventArgs $event)
{
@@ -48,9 +44,8 @@ class UploadedFileListener
}
/** Renomme le fichier disque lorsque l'on change l'attribut 'path'.
- *
* @param UploadedFileInterface $file
- * @param LifecycleEventArgs $event
+ * @param LifecycleEventArgs $event
*/
public function postUpdate(UploadedFileInterface $file, LifecycleEventArgs $event)
{
@@ -64,9 +59,8 @@ class UploadedFileListener
}
/** Enregistre le chemin du fichier à supprimer.
- *
* @param UploadedFileInterface $file
- * @param LifecycleEventArgs $event
+ * @param LifecycleEventArgs $event
*/
public function preRemove(UploadedFileInterface $file, LifecycleEventArgs $event)
{
@@ -74,9 +68,8 @@ class UploadedFileListener
}
/** Supprime le fichier correspondant à l'UploadedFileInterface supprimé.
- *
* @param UploadedFileInterface $file
- * @param LifecycleEventArgs $event
+ * @param LifecycleEventArgs $event
*/
public function postRemove(UploadedFileInterface $file, LifecycleEventArgs $event)
{
diff --git a/Listener/VirusScannerListener.php b/Listener/VirusScannerListener.php
index cbe9a402..1f38ac22 100644
--- a/Listener/VirusScannerListener.php
+++ b/Listener/VirusScannerListener.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -12,20 +11,16 @@ use Irstea\FileUploadBundle\Event\FileUploadCompleteEvent;
use Irstea\FileUploadBundle\Exception\RejectedFileException;
/**
- * Description of AntivirusListener
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of AntivirusListener.
*/
class VirusScannerListener
{
/**
- *
* @var AdapterInterface
*/
private $scanner;
/**
- *
* @param AdapterInterface $scanner
*/
public function __construct(AdapterInterface $scanner)
@@ -34,7 +29,6 @@ class VirusScannerListener
}
/**
- *
* @param FileUploadCompleteEvent $event
*/
public function onFileUploadCompleted(FileUploadCompleteEvent $event)
@@ -48,16 +42,16 @@ class VirusScannerListener
$meta['virus_scanner'] = ['has_virus' => $result->hasVirus()];
- if($result->hasVirus()) {
- if(null !== $desc = $result->getDetections()[0]->getDescription()) {
+ if ($result->hasVirus()) {
+ if (null !== $desc = $result->getDetections()[0]->getDescription()) {
$meta['virus_scanner']['detected'] = $desc;
}
}
$file->setMetadata($meta);
- if($result->hasVirus()) {
- throw new RejectedFileException($file, $desc ? sprintf("Found the %s virus !", $desc) : 'Virus found !');
+ if ($result->hasVirus()) {
+ throw new RejectedFileException($file, $desc ? sprintf('Found the %s virus !', $desc) : 'Virus found !');
}
}
}
diff --git a/Model/FileManagerInterface.php b/Model/FileManagerInterface.php
index ff5e4490..690c4157 100644
--- a/Model/FileManagerInterface.php
+++ b/Model/FileManagerInterface.php
@@ -1,10 +1,7 @@
<?php
-/**
- * Copyright (C) 2015 IRSTEA
+/*
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
- *
- * @package irstea/file-upload-bundle
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
namespace Irstea\FileUploadBundle\Model;
@@ -19,67 +16,62 @@ use Symfony\Component\Validator\Exception\InvalidArgumentException;
interface FileManagerInterface
{
/** 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
*/
public function get($id);
/** Crée un nouveau fichier uploadé, vide.
- *
* Le fichier est créé à l'état UploadedFileInterface::ETAT_EN_COURS.
*
- * @param string $name Nom original du fichier.
- * @param int $size Taille prévisionnelle, en octets.
- * @param string $mimeType Mime TYPE provisoire.
- * @param int $lastModified Timestamp de la date de dernière modification.
+ * @param string $name nom original du fichier
+ * @param int $size taille prévisionnelle, en octets
+ * @param string $mimeType mime TYPE provisoire
+ * @param int $lastModified timestamp de la date de dernière modification
*
- * @return UploadedFileInterface Le fichier créé.
+ * @return UploadedFileInterface le fichier créé
*
* @api
*/
public function create($name, $size, $mimeType, $lastModified = null);
/** Duplique un fichier.
- *
* N'accepte que des fichiers valides.
* Le nouveau fichier est automatiquement orphelin, avec un chemin par défaut.
*
* @param UploadedFileInterface $original
*
+ * @throws InvalidArgumentException le fichier original est invalide
+ *
* @return UploadedFileInterface
- * @throws InvalidArgumentException Le fichier original est invalide.
*
* @api
*/
public function duplicate(UploadedFileInterface $original);
/** Supprime un fichier uploadé.
- *
* *Attention :* le fichier est supprimé du disque !
*
- * @param UploadedFileInterface $file Fichier à supprimer.
+ * @param UploadedFileInterface $file fichier à supprimer
*
* @api
*/
public function delete(UploadedFileInterface $file);
/** Indique que l'upload d'un fichier est terminé.
- *
* Cela passe le fichier à l'état UploadedFileInterface::ORPHELIN et provoque la mise-à -jour de la taille, du
* type MIME et de la somme de contrôle.
*
- * @param UploadedFileInterface $file Fichier terminé.
+ * @param UploadedFileInterface $file fichier terminé
*
* @internal
*/
public function completed(UploadedFileInterface $file);
/** 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.
*
* @return UploadedFileInterface[]
@@ -89,7 +81,6 @@ interface FileManagerInterface
public function findGarbage();
/** Retourne la liste des fichiers à valider.
- *
* @return UploadedFileInterface[]
*
* @internal
diff --git a/Model/UploadedFileInterface.php b/Model/UploadedFileInterface.php
index e7a45f25..41e8536c 100644
--- a/Model/UploadedFileInterface.php
+++ b/Model/UploadedFileInterface.php
@@ -1,11 +1,7 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
- *
- * @package irstea/file-upload-bundle
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>*
*/
namespace Irstea\FileUploadBundle\Model;
@@ -18,13 +14,11 @@ use DateTime;
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
@@ -32,7 +26,6 @@ interface UploadedFileInterface
const ETAT_ORPHELIN = 'orphelin';
/** Fichier normal.
- *
* Fichier associé à un objet métier.
*
* @var string
@@ -40,7 +33,6 @@ interface UploadedFileInterface
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
@@ -48,7 +40,6 @@ interface UploadedFileInterface
const ETAT_CORROMPU = 'corrompu';
/** Fichier manquant.
- *
* Fichier existant en base de données mais introuvable sur disque.
*
* @var string
@@ -56,7 +47,6 @@ interface UploadedFileInterface
const ETAT_MANQUANT = 'manquant';
/** Fichier rejeté.
- *
* Fichier uploadé mais rejeté par un listener (par exemple l'antivirus).
*
* @var string
@@ -64,7 +54,6 @@ interface UploadedFileInterface
const ETAT_REJETE = 'rejete';
/** Retourne l'identifiant du fichier.
- *
* @return string
*
* @api
@@ -72,7 +61,7 @@ interface UploadedFileInterface
public function getId();
/**
- * Set originalFilename
+ * Set originalFilename.
*
* @param string $displayName
*
@@ -83,7 +72,6 @@ interface UploadedFileInterface
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
@@ -100,7 +88,6 @@ interface UploadedFileInterface
public function setDescription($description = null);
/** Retourne la description du fichier.
- *
* @return string
*
* @api
@@ -108,7 +95,6 @@ interface UploadedFileInterface
public function getDescription();
/** Retourne le chemin du fichier dans le filesystem.
- *
* @return string
*
* @api
@@ -116,7 +102,6 @@ interface UploadedFileInterface
public function getPath();
/** Remplace le chemin du fichier dans le filesystem.
- *
* Cela devrait causer un déplacement/renommage du fichier.
*
* @param string $path
@@ -128,19 +113,18 @@ interface UploadedFileInterface
public function setPath($path);
/** Change le chemin du fichier sans changer le nom.
- *
* @param string $newDir Nouveau répertoire
*
* @return UploadedFileInterface
*
- * @uses UploadedFileInterface::setPath
+ * @uses \UploadedFileInterface::setPath
*
* @api
*/
public function moveTo($newDir);
/**
- * Set mimeType
+ * Set mimeType.
*
* @param string $mimeType
*
@@ -151,7 +135,6 @@ interface UploadedFileInterface
public function setMimeType($mimeType);
/** Retourne le type MIME enregistré.
- *
* @return string
*
* @api
@@ -159,9 +142,9 @@ interface UploadedFileInterface
public function getMimeType();
/**
- * Set size
+ * Set size.
*
- * @param integer $size
+ * @param int $size
*
* @return UploadedFileInterface
*
@@ -170,15 +153,14 @@ interface UploadedFileInterface
public function setSize($size);
/** Retourne la taille enregistrée, en octets.
- *
- * @return integer
+ * @return int
*
* @api
*/
public function getSize();
/**
- * Set checksum
+ * Set checksum.
*
* @param string $checksum
*
@@ -189,7 +171,6 @@ interface UploadedFileInterface
public function setChecksum($checksum);
/** Retourne la somme de contrôle enregistrée.
- *
* @return string
*
* @api
@@ -197,7 +178,6 @@ interface UploadedFileInterface
public function getChecksum();
/** Modifie l'état courant du fichier.
- *
* @param string $etat
*
* @return UploadedFileInterface
@@ -207,7 +187,6 @@ interface UploadedFileInterface
public function setEtat($etat);
/** Retourne l'état courant du fichier.
- *
* @return string
*
* @api
@@ -215,7 +194,6 @@ interface UploadedFileInterface
public function getEtat();
/** Définit la date de création du fichier.
- *
* @param DateTime $time
*
* @return self
@@ -225,7 +203,6 @@ interface UploadedFileInterface
public function setCreatedAt(\DateTime $time);
/** Définit le nom de l'utilisateur ayant uploadé le fichier.
- *
* @param string $username
*
* @return self
@@ -235,7 +212,6 @@ interface UploadedFileInterface
public function setCreatedBy($username);
/** Retourne l'adresse IP du client ayant uploadé le fichier.
- *
* @param string $ipAddress
*
* @return self
@@ -245,7 +221,6 @@ interface UploadedFileInterface
public function setCreatedFrom($ipAddress);
/** Retourne la date de création du fichier.
- *
* @return DateTime
*
* @api
@@ -253,7 +228,6 @@ interface UploadedFileInterface
public function getCreatedAt();
/** Retourne le nom de l'utilisateur ayant uploadé le fichier.
- *
* @return string
*
* @api
@@ -261,7 +235,6 @@ interface UploadedFileInterface
public function getCreatedBy();
/** Retourne l'adresse IP du client ayant uploadé le fichier.
- *
* @return string
*
* @api
@@ -269,8 +242,7 @@ interface UploadedFileInterface
public function getCreatedFrom();
/** 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
*
@@ -279,7 +251,6 @@ interface UploadedFileInterface
public function setMetadata(array $metadata);
/** Retourne les métadonnées du fichier.
- *
* @return array
*
* @api
@@ -287,7 +258,6 @@ interface UploadedFileInterface
public function getMetadata();
/** Retourne une représentation texte du fichier.
- *
* @return string
*
* @api
@@ -295,34 +265,30 @@ interface UploadedFileInterface
public function __toString();
/** 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
* correspondent. En cas d'erreur, l'état du fichier est modifié en conséquence.
*
- * @uses UploadedFileInterface::setEtat
+ * @uses \UploadedFileInterface::setEtat
*
* @api
*/
public function validate();
/** Détermine si le fichier est dans un état "valide".
- *
- * @return boolean
+ * @return bool
*
* @api
*/
public function isValid();
/** Détermine si le fichier est orphelin.
- *
- * @return boolean
+ * @return bool
*
* @api
*/
public function isOrphelin();
/** Retourne la date de dernière modification dans le filesystem.
- *
* @return DateTime
*
* @api
@@ -330,15 +296,13 @@ interface UploadedFileInterface
public function getLastModified();
/** Retourne le contenu du fichier.
- *
- * @return string Une chaîne.
+ * @return string une chaîne
*
* @api
*/
public function getContent();
/** Remplace le contenu du fichier.
- *
* @param string $content
*
* @api
@@ -346,31 +310,28 @@ interface UploadedFileInterface
public function setContent($content);
/** Ecrit dans le fichier depuis un descripteur de fichier.
+ * @param resource $source flux d'entrée à lire
+ * @param int $maxlen nombre maximum d'octets à lire
+ * @param int $writeOffset offset depuis le début du fichier
*
- * @param resource $source Flux d'entrée à lire.
- * @param int $maxlen Nombre maximum d'octets à lire.
- * @param int $writeOffset Offset depuis le début du fichier.
- *
- * @return int Nombre d'octets écrits.
+ * @return int nombre d'octets écrits
*
* @api
*/
public function copyFrom($source, $maxlen = -1, $writeOffset = 0);
/** Envoie le contenu du fichier dans un descripteur de fichier.
+ * @param resource $dest flux de sortie
+ * @param int $maxlen nombre maximum d'octets à lire
+ * @param int $readOffset offset depuis le début du fichier
*
- * @param resource $dest Flux de sortie.
- * @param int $maxlen Nombre maximum d'octets à lire.
- * @param int $readOffset Offset depuis le début du fichier.
- *
- * @return int Nombre d'octets lus.
+ * @return int nombre d'octets lus
*
* @api
*/
public function copyTo($dest, $maxlen = PHP_INT_MAX, $readOffset = 0);
/** Retourne un nom de fichier local pour ce fichier.
- *
* Ce peut-être un fichier temporaire qui sera supprimé à la fin de la requête.
*
* @return string
@@ -380,7 +341,6 @@ interface UploadedFileInterface
public function getLocalPath();
/** Retourne une représentation "tableau" des attributs du fichier uploadé.
- *
* Utilisé comme sérialisation du pauvre.
*
* @todo Utiliser un vrai serializer.
@@ -396,7 +356,7 @@ interface UploadedFileInterface
*
* @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
*/
diff --git a/Service/FileUrlGenerator.php b/Service/FileUrlGenerator.php
index 16bc22af..6ca79bee 100644
--- a/Service/FileUrlGenerator.php
+++ b/Service/FileUrlGenerator.php
@@ -1,21 +1,17 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
namespace Irstea\FileUploadBundle\Service;
use Irstea\FileUploadBundle\Controller\UploadController;
-use Irstea\FileUploadBundle\Model\UploadedFileInterface;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
/**
* Implémentation de FileUrlInterface utilisant les services de Symfony.
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
class FileUrlGenerator implements FileUrlGeneratorInterface
{
@@ -30,7 +26,7 @@ class FileUrlGenerator implements FileUrlGeneratorInterface
protected $tokenManager;
/**
- * @param UrlGeneratorInterface $urlGenerator
+ * @param UrlGeneratorInterface $urlGenerator
* @param CsrfTokenManagerInterface $tokenManager
*/
public function __construct(UrlGeneratorInterface $urlGenerator, CsrfTokenManagerInterface $tokenManager)
diff --git a/Service/FileUrlGeneratorInterface.php b/Service/FileUrlGeneratorInterface.php
index f1f402cf..bee15eee 100644
--- a/Service/FileUrlGeneratorInterface.php
+++ b/Service/FileUrlGeneratorInterface.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -11,18 +10,16 @@ use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
/**
* Service générant/vérifiant une URL pour un fichier.
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
interface FileUrlGeneratorInterface
{
/**
* 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|bool $referenceType Type d'URL à générer.
+ * @param string $idFile identifiant du fichier pour lequel générer l'URL
+ * @param string|bool $referenceType type d'URL à générer
*
- * @return string L'url générée.
+ * @return string L'url générée
*/
public function generate($idFile, $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH);
}
diff --git a/Tests/Entity/UploadedFileTest.php b/Tests/Entity/UploadedFileTest.php
index 799e4adb..ffc7472d 100644
--- a/Tests/Entity/UploadedFileTest.php
+++ b/Tests/Entity/UploadedFileTest.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle\Tests\Entity;
@@ -10,7 +14,6 @@ use PHPUnit_Framework_TestCase;
*/
class UploadedFileTest extends PHPUnit_Framework_TestCase
{
-
/**
* @var UploadedFile
*/
@@ -26,8 +29,11 @@ class UploadedFileTest extends PHPUnit_Framework_TestCase
}
/**
- * @covers Irstea\FileUploadBundle\Entity\UploadedFile::isSafePath
+ * @covers \Irstea\FileUploadBundle\Entity\UploadedFile::isSafePath
* @dataProvider getIsSafePathvalues
+ *
+ * @param mixed $isSafe
+ * @param mixed $path
*/
public function testIsSafePath($isSafe, $path)
{
diff --git a/Tests/Form/DataTranformer/UploadedFileTransformerTest.php b/Tests/Form/DataTranformer/UploadedFileTransformerTest.php
index ed453b09..706646b8 100644
--- a/Tests/Form/DataTranformer/UploadedFileTransformerTest.php
+++ b/Tests/Form/DataTranformer/UploadedFileTransformerTest.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle\Tests\Form\DataTranformer;
@@ -13,7 +17,6 @@ use PHPUnit_Framework_TestCase;
class UploadedFileTransformerTest extends PHPUnit_Framework_TestCase
{
/**
- *
* @var PHPUnit_Framework_MockObject_MockObject
*/
protected $fileManager;
@@ -36,6 +39,10 @@ class UploadedFileTransformerTest extends PHPUnit_Framework_TestCase
/**
* @dataProvider getEmptyValues
+ *
+ * @param mixed $expected
+ * @param mixed $method
+ * @param mixed $value
*/
public function testEmptyValues($expected, $method, $value)
{
@@ -48,35 +55,36 @@ class UploadedFileTransformerTest extends PHPUnit_Framework_TestCase
foreach ([null, '', []] as $value) {
foreach (['transform', 'reverseTransform'] as $method) {
$values[] = [[], $method, $value];
- $values[] = [null, $method . "File", $value];
+ $values[] = [null, $method . 'File', $value];
}
}
+
return $values;
}
/**
- * @expectedException Symfony\Component\Form\Exception\TransformationFailedException
+ * @expectedException \Symfony\Component\Form\Exception\TransformationFailedException
*/
public function testTransformFileInvalidObject()
{
- $this->transformer->transform("x");
+ $this->transformer->transform('x');
}
public function testTransformFile()
{
$file = $this->getMock('\Irstea\FileUploadBundle\Model\UploadedFileInterface');
- $file->expects($this->once())->method('toArray')->willReturn(["bla"]);
+ $file->expects($this->once())->method('toArray')->willReturn(['bla']);
- $this->assertEquals(["bla"], $this->transformer->transformFile($file));
+ $this->assertEquals(['bla'], $this->transformer->transformFile($file));
}
/**
- * @expectedException Symfony\Component\Form\Exception\TransformationFailedException
+ * @expectedException \Symfony\Component\Form\Exception\TransformationFailedException
*/
public function testReverseTransformFileInvalidObject()
{
- $this->transformer->reverseTransformFile("x");
+ $this->transformer->reverseTransformFile('x');
}
public function testReverseTransformFileNoId()
@@ -88,7 +96,7 @@ class UploadedFileTransformerTest extends PHPUnit_Framework_TestCase
{
$file = $this->getMock('\Irstea\FileUploadBundle\Model\UploadedFileInterface');
- $this->fileManager->expects($this->once())->method("get")->with("FOO")->willReturn($file);
+ $this->fileManager->expects($this->once())->method('get')->with('FOO')->willReturn($file);
$file->expects($this->once())->method('isOrphelin')->willReturn(true);
$file->expects($this->once())->method('setEtat')->with(UploadedFileInterface::ETAT_NORMAL);
$file->expects($this->once())->method('setDescription')->with('truc');
@@ -99,7 +107,7 @@ class UploadedFileTransformerTest extends PHPUnit_Framework_TestCase
public function testTransformEmptyEntries()
{
$file = $this->getMock('\Irstea\FileUploadBundle\Model\UploadedFileInterface');
- $file->expects($this->any())->method('toArray')->willReturn(["bla"]);
+ $file->expects($this->any())->method('toArray')->willReturn(['bla']);
$result = $this->transformer->transform([$file, null, $file]);
@@ -109,7 +117,7 @@ class UploadedFileTransformerTest extends PHPUnit_Framework_TestCase
public function testReverseTransformEmptyEntries()
{
$file = $this->getMock('\Irstea\FileUploadBundle\Model\UploadedFileInterface');
- $this->fileManager->expects($this->any())->method("get")->with("FOO")->willReturn($file);
+ $this->fileManager->expects($this->any())->method('get')->with('FOO')->willReturn($file);
$result = $this->transformer->reverseTransform([['id' => 'FOO'], null, ['description' => 'muche'], ['id' => 'FOO']]);
diff --git a/Tests/Listener/UploadedFileListenerTest.php b/Tests/Listener/UploadedFileListenerTest.php
index 9af079ba..9a68c361 100644
--- a/Tests/Listener/UploadedFileListenerTest.php
+++ b/Tests/Listener/UploadedFileListenerTest.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle\Listener;
@@ -12,7 +16,6 @@ use PHPUnit_Framework_TestCase;
*/
class UploadedFileListenerTest extends PHPUnit_Framework_TestCase
{
-
/**
* @var UploadedFileListener
*/
@@ -74,7 +77,8 @@ class UploadedFileListenerTest extends PHPUnit_Framework_TestCase
}
/**
- * @covers Irstea\FileUploadBundle\Listener\UploadedFileListener::postLoad
+ * @covers \Irstea\FileUploadBundle\Listener\UploadedFileListener::postLoad
+ *
* @todo Implement testPostLoad().
*/
public function testPostLoad()
@@ -85,7 +89,7 @@ class UploadedFileListenerTest extends PHPUnit_Framework_TestCase
}
/**
- * @covers Irstea\FileUploadBundle\Listener\UploadedFileListener::postUpdate
+ * @covers \Irstea\FileUploadBundle\Listener\UploadedFileListener::postUpdate
*/
public function testPostUpdateNoPathChange()
{
@@ -97,7 +101,7 @@ class UploadedFileListenerTest extends PHPUnit_Framework_TestCase
}
/**
- * @covers Irstea\FileUploadBundle\Listener\UploadedFileListener::postUpdate
+ * @covers \Irstea\FileUploadBundle\Listener\UploadedFileListener::postUpdate
*/
public function testPostUpdatePathChanged()
{
@@ -111,7 +115,7 @@ class UploadedFileListenerTest extends PHPUnit_Framework_TestCase
}
/**
- * @covers Irstea\FileUploadBundle\Listener\UploadedFileListener::postRemove
+ * @covers \Irstea\FileUploadBundle\Listener\UploadedFileListener::postRemove
*/
public function testRemove()
{
@@ -125,7 +129,7 @@ class UploadedFileListenerTest extends PHPUnit_Framework_TestCase
}
/**
- * @covers Irstea\FileUploadBundle\Listener\UploadedFileListener::postRemove
+ * @covers \Irstea\FileUploadBundle\Listener\UploadedFileListener::postRemove
*/
public function testRemoveIgnoreFileNotFound()
{
@@ -139,7 +143,7 @@ class UploadedFileListenerTest extends PHPUnit_Framework_TestCase
}
/**
- * @covers Irstea\FileUploadBundle\Listener\UploadedFileListener::postRemove
+ * @covers \Irstea\FileUploadBundle\Listener\UploadedFileListener::postRemove
* @expectedException \InvalidArgumentException
*/
public function testRemovePropagateOtherExceptions()
diff --git a/Tests/Listener/VirusScannerListenerTest.php b/Tests/Listener/VirusScannerListenerTest.php
index 8cd8e323..86af4fdc 100644
--- a/Tests/Listener/VirusScannerListenerTest.php
+++ b/Tests/Listener/VirusScannerListenerTest.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle\Tests\Listener;
@@ -14,7 +18,6 @@ use PHPUnit_Framework_TestCase;
*/
class VirusScannerListenerTest extends PHPUnit_Framework_TestCase
{
-
/**
* @var VirusScannerListener
*/
@@ -63,7 +66,7 @@ class VirusScannerListenerTest extends PHPUnit_Framework_TestCase
}
/**
- * @expectedException Irstea\FileUploadBundle\Exception\RejectedFileException
+ * @expectedException \Irstea\FileUploadBundle\Exception\RejectedFileException
*/
public function testOnFileUploadCompletedVirusFound()
{
@@ -82,7 +85,7 @@ class VirusScannerListenerTest extends PHPUnit_Framework_TestCase
}
/**
- * @expectedException Irstea\FileUploadBundle\Exception\RejectedFileException
+ * @expectedException \Irstea\FileUploadBundle\Exception\RejectedFileException
*/
public function testOnFileUploadCompletedVirusFoundNoDescription()
{
diff --git a/Tests/Utils/MimeTypeIconTest.php b/Tests/Utils/MimeTypeIconTest.php
index ac1396fb..1fffeb42 100644
--- a/Tests/Utils/MimeTypeIconTest.php
+++ b/Tests/Utils/MimeTypeIconTest.php
@@ -1,4 +1,8 @@
<?php
+/*
+ * Copyright (C) 2015-2017 IRSTEA
+ * All rights reserved.
+ */
namespace Irstea\FileUploadBundle\Tests\Utils;
@@ -11,8 +15,11 @@ use PHPUnit_Framework_TestCase;
class MimeTypeIconTest extends PHPUnit_Framework_TestCase
{
/**
- * @covers Irstea\FileUploadBundle\Utils\MimeTypeIcon::getMimeTypeIcon
+ * @covers \Irstea\FileUploadBundle\Utils\MimeTypeIcon::getMimeTypeIcon
* @dataProvider getTestValues
+ *
+ * @param mixed $expected
+ * @param mixed $input
*/
public function testGetMimeTypeIcon($expected, $input)
{
@@ -34,5 +41,4 @@ class MimeTypeIconTest extends PHPUnit_Framework_TestCase
['archive', 'application/zip; format=lzh'],
];
}
-
}
diff --git a/Twig/FileUploadExtension.php b/Twig/FileUploadExtension.php
index aeb829bb..4429cb02 100644
--- a/Twig/FileUploadExtension.php
+++ b/Twig/FileUploadExtension.php
@@ -1,11 +1,7 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
- *
- * @copyright 2015 Irstea
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
namespace Irstea\FileUploadBundle\Twig;
@@ -28,7 +24,6 @@ use Twig_SimpleFunction;
class FileUploadExtension extends Twig_Extension
{
/**
- *
* @var TranslatorInterface
*/
private $translator;
@@ -39,7 +34,6 @@ class FileUploadExtension extends Twig_Extension
private $urlGenerator;
/**
- *
* @param TranslatorInterface $translator
*/
public function __construct(TranslatorInterface $translator, FileUrlGeneratorInterface $urlGenerator)
@@ -96,16 +90,15 @@ class FileUploadExtension extends Twig_Extension
*/
public function getName()
{
- return "irstea_file_upload";
+ return 'irstea_file_upload';
}
/** Genère un tag HTML pour représenter le fichier.
- *
* Inclut un lien sécurisé qui permet de télécharger le fichier, mais uniquement à l'utilisateur qui a affiché la page.
*
* Usage : `{{ irstea_uploaded_file(file) }}`
*
- * @param Twig_Environment $env
+ * @param Twig_Environment $env
* @param UploadedFileInterface $file
*
* @return string
@@ -117,17 +110,16 @@ class FileUploadExtension extends Twig_Extension
} elseif ($file instanceof UploadedFile) {
$file = $file->toArray();
} elseif (!is_array($file)) {
- throw new InvalidArgumentException("irstea_uploaded_file expects an UploadedFile instance, array or null");
+ throw new InvalidArgumentException('irstea_uploaded_file expects an UploadedFile instance, array or null');
}
return $env->render('IrsteaFileUploadBundle:Extension:uploaded_file.html.twig', ['file' => $file]);
}
/** Genère un URL sécurisée pour télécharger un fichier.
+ * Usage : `{{ irstea_file_path(file.id) }}`.
*
- * Usage : `{{ irstea_file_path(file.id) }}`
- *
- * @param string $idFile
+ * @param string $idFile
* @param string|bool $referenceType
*
* @return string
@@ -138,29 +130,28 @@ class FileUploadExtension extends Twig_Extension
}
/** Génère un tag "icône" Font-Awesome pour le type MIME indiqué.
+ * Usage : `{{ irstea_file_icon(mimeType) }}`.
*
- * Usage : `{{ irstea_file_icon(mimeType) }}`
- *
- * @param string $mimeType Type MIME.
+ * @param string $mimeType type MIME
*
- * @return string Un tag <i></i> avec les classes Font-Awesome.
+ * @return string un tag <i></i> avec les classes Font-Awesome
*
- * @uses MimeTypeIcon::getMimeTypeIcon
+ * @uses \MimeTypeIcon::getMimeTypeIcon
*/
public function formatFileIcon($mimeType)
{
$icon = MimeTypeIcon::getMimeTypeIcon($mimeType);
+
return sprintf('<i class="icon fa fa-file%s-o"></i>', ($icon && $icon !== 'file') ? ('-' . $icon) : '');
}
/** Formate une taille de fichier.
+ * Usage : `{{ size|irstea_file_size([precision][, locale]) }}`.
*
- * Usage : `{{ size|irstea_file_size([precision][, locale]) }}`
- *
- * @param array $context Contexte Twig.
- * @param integer $size Taille du fichier.
- * @param integer $precision Nombre de chiffres après la virgule.
- * @param string $locale Langue
+ * @param array $context contexte Twig
+ * @param int $size taille du fichier
+ * @param int $precision nombre de chiffres après la virgule
+ * @param string $locale Langue
*
* @return string
*
diff --git a/Utils/MimeTypeIcon.php b/Utils/MimeTypeIcon.php
index db051f75..52695180 100644
--- a/Utils/MimeTypeIcon.php
+++ b/Utils/MimeTypeIcon.php
@@ -1,16 +1,13 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
namespace Irstea\FileUploadBundle\Utils;
/**
- * Description of MimeTypeIcon
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Description of MimeTypeIcon.
*/
final class MimeTypeIcon
{
@@ -34,7 +31,6 @@ final class MimeTypeIcon
];
/**
- *
* @param string $mimeType
*
* @return string|null
diff --git a/Validation/FileMimeType.php b/Validation/FileMimeType.php
index a1d3aa0e..f015d0f4 100644
--- a/Validation/FileMimeType.php
+++ b/Validation/FileMimeType.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -11,8 +10,6 @@ use Symfony\Component\Validator\Constraint;
/**
* @Annotation
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
class FileMimeType extends Constraint
{
diff --git a/Validation/FileMimeTypeValidator.php b/Validation/FileMimeTypeValidator.php
index 1c27b4db..d1c45d6a 100644
--- a/Validation/FileMimeTypeValidator.php
+++ b/Validation/FileMimeTypeValidator.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -13,8 +12,6 @@ use Symfony\Component\Validator\ConstraintValidator;
/**
* Vérifie que le type MIME du fichier valide la contrainte.
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
class FileMimeTypeValidator extends ConstraintValidator
{
diff --git a/Validation/FileSize.php b/Validation/FileSize.php
index 976bae31..db5158ab 100644
--- a/Validation/FileSize.php
+++ b/Validation/FileSize.php
@@ -1,6 +1,6 @@
<?php
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -10,18 +10,16 @@ use Symfony\Component\Validator\Constraint;
/**
* @Annotation
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/
class FileSize extends Constraint
{
/**
- * @var integer|null
+ * @var int|null
*/
public $min = null;
/**
- * @var integer|null
+ * @var int|null
*/
public $max = null;
diff --git a/Validation/FileSizeValidator.php b/Validation/FileSizeValidator.php
index fec88094..48601f32 100644
--- a/Validation/FileSizeValidator.php
+++ b/Validation/FileSizeValidator.php
@@ -1,7 +1,6 @@
<?php
-
/*
- * Copyright (C) 2015 IRSTEA
+ * Copyright (C) 2015-2017 IRSTEA
* All rights reserved.
*/
@@ -12,9 +11,7 @@ use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
/**
- * Vérifie que la taille du fichier
- *
- * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
+ * Vérifie que la taille du fichier.
*/
class FileSizeValidator extends ConstraintValidator
{
--
GitLab