\phpDocumentor\Transformer\WriterRoutable

Public interface for writers who use the routing system to determine relative URLs for Descriptors.

Summary

Methods

Constants

setRouters()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setRouters()

setRouters(\phpDocumentor\Transformer\Router\Queue  $routers) : void

Sets the routers that can be used to determine the path of links.

Parameters

\phpDocumentor\Transformer\Router\Queue

$routers

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @copyright 2010-2014 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Transformer\Writer;

use phpDocumentor\Transformer\Router\Queue;

/**
 * Public interface for writers who use the routing system to determine relative URLs for Descriptors.
 */
interface Routable
{
    /**
     * Sets the routers that can be used to determine the path of links.
     *
     * @param Queue $routers
     *
     * @return void
     */
    public function setRouters(Queue $routers);
}