1 <?php

     2 

     3 /*

     4  * This file is part of the Pagerfanta package.

     5  *

     6  * (c) Pablo Díez <pablodip@gmail.com>

     7  *

     8  * For the full copyright and license information, please view the LICENSE

     9  * file that was distributed with this source code.

    10  */

    11 

    12 namespace Pagerfanta\View;

    13 

    14 use Pagerfanta\PagerfantaInterface;

    15 

    16 /**

    17  * ViewInterface.

    18  *

    19  * @author Pablo Díez <pablodip@gmail.com>

    20  *

    21  * @api

    22  */

    23 interface ViewInterface

    24 {

    25     /**

    26      * Renders a pagerfanta.

    27      *

    28      * The route generator is any callable to generate the routes receiving the page number

    29      * as first and unique argument.

    30      *

    31      * @param PagerfantaInterface $pagerfanta      A pagerfanta.

    32      * @param mixed               $routeGenerator A callable to generate the routes.

    33      * @param array               $options        An array of options (optional).

    34      *

    35      * @api

    36      */

    37     function render(PagerfantaInterface $pagerfanta, $routeGenerator, array $options = array());

    38 

    39     /**

    40      * Returns the canonical name.

    41      *

    42      * @return string The canonical name.

    43      *

    44      * @api

    45      */

    46     function getName();

    47 

    48 }