FileUrlGeneratorInterface.php

<?php

/*
 * Copyright (C) 2015 IRSTEA
 * All rights reserved.
 */

namespace Irstea\FileUploadBundle\Service;

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.
     * @return string L'url générée.
     */
    public function generate($idFile, $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH);
}