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

Toujours plus de mise à jour de la doc de l'API.

Showing with 10 additions and 8 deletions
+10 -8
...@@ -4,7 +4,6 @@ ...@@ -4,7 +4,6 @@
* Copyright (C) 2015 IRSTEA * Copyright (C) 2015 IRSTEA
* All rights reserved. * All rights reserved.
* *
* @package irstea/file-upload-bundle
* @copyright 2015 Irstea * @copyright 2015 Irstea
* @author Guillaume Perréal <guillaume.perreal@irstea.fr> * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/ */
...@@ -30,6 +29,7 @@ use Symfony\Component\Validator\Constraints\NotNull; ...@@ -30,6 +29,7 @@ use Symfony\Component\Validator\Constraints\NotNull;
/** Type de champ 'file_upload'. /** Type de champ 'file_upload'.
* *
* Options : * Options :
*
* * multiple (boolean) : fichier unique ou multiple ? false par défaut. * * 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. * * accept_file_types (string) : expression régulière de contrôle des types MIME acceptés. Aucune par défaut.
* * max_file_size (integer) : taille maximale d'un fichier. 0 (illimité) par défaut. * * max_file_size (integer) : taille maximale d'un fichier. 0 (illimité) par défaut.
......
...@@ -4,7 +4,6 @@ ...@@ -4,7 +4,6 @@
* Copyright (C) 2015 IRSTEA * Copyright (C) 2015 IRSTEA
* All rights reserved. * All rights reserved.
* *
* @package irstea/file-upload-bundle
* @copyright 2015 Irstea * @copyright 2015 Irstea
* @author Guillaume Perréal <guillaume.perreal@irstea.fr> * @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/ */
...@@ -20,10 +19,7 @@ use Twig_Extension; ...@@ -20,10 +19,7 @@ use Twig_Extension;
use Twig_SimpleFilter; use Twig_SimpleFilter;
use Twig_SimpleFunction; use Twig_SimpleFunction;
/** /** Extension Twig pour les fichiers uploadés.
* Description of FileUploadExtension
*
* @author Guillaume Perréal <guillaume.perreal@irstea.fr>
*/ */
class FileUploadExtension extends Twig_Extension class FileUploadExtension extends Twig_Extension
{ {
...@@ -74,7 +70,7 @@ class FileUploadExtension extends Twig_Extension ...@@ -74,7 +70,7 @@ class FileUploadExtension extends Twig_Extension
'irstea_file_size', 'irstea_file_size',
[$this, 'formatFileSize'], [$this, 'formatFileSize'],
['needs_context' => true] ['needs_context' => true]
), ),license
]; ];
} }
...@@ -90,6 +86,8 @@ class FileUploadExtension extends Twig_Extension ...@@ -90,6 +86,8 @@ class FileUploadExtension extends Twig_Extension
* *
* Inclut un lien sécurisé qui permet de télécharger le fichier, mais uniquement à l'utilisateur qui a affiché la page. * 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 * @param UploadedFileInterface $file
* *
...@@ -109,10 +107,12 @@ class FileUploadExtension extends Twig_Extension ...@@ -109,10 +107,12 @@ class FileUploadExtension extends Twig_Extension
} }
/** Génère un tag "icône" Font-Awesome pour le type MIME indiqué. /** Génère un tag "icône" Font-Awesome pour le type MIME indiqué.
*
* 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
*/ */
...@@ -123,6 +123,8 @@ class FileUploadExtension extends Twig_Extension ...@@ -123,6 +123,8 @@ class FileUploadExtension extends Twig_Extension
} }
/** Formate une taille de fichier. /** Formate une taille de fichier.
*
* Usage : `{{ size|irstea_file_size([precision][, locale]) }}`
* *
* @param array $context Contexte Twig. * @param array $context Contexte Twig.
* @param integer $size Taille du fichier. * @param integer $size Taille du fichier.
......
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