Phraseanet/lib/Alchemy/Phrasea/Feed/Link/LinkGeneratorInterface.php

<?php

/*
 * This file is part of Phraseanet
 *
 * (c) 2005-2014 Alchemy
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Alchemy\Phrasea\Feed\Link;

use Alchemy\Phrasea\Feed\FeedInterface;
use Alchemy\Phrasea\Model\Entities\User;

interface LinkGeneratorInterface
{
    /**
     * Generates a FeedLink based on given FeedInterface and User.
     *
     * @param FeedInterface $feed
     * @param User          $user
     * @param string        $format
     * @param int           $page
     * @param bool          $renew
     *
     * @return FeedLinkInterface
     *
     * @throws \InvalidArgumentException
     */
    public function generate(FeedInterface $feed, User $user, $format, $page = null, $renew = false);

    /**
     * Generates a public FeedLink based on given FeedInterface.
     *
     * @param FeedInterface $feed
     * @param string        $format
     * @param int           $page
     *
     * @return FeedLinkInterface
     *
     * @throws \InvalidArgumentException
     */
    public function generatePublic(FeedInterface $feed, $format, $page = null);

    /**
     * Returns whether an instance of FeedInterface is supported by the class.
     *
     * @param FeedInterface $feed
     *
     * @return bool
     */
    public function supports(FeedInterface $feed);
}