$routers
$routers : \phpDocumentor\Transformer\Router\Queue
A collection of Writer objects.
In this collection we can receive writers, and if they implement the Routable interface assign the router queue that was provided to this class so that those writers can generate urls for various Descriptors.
In addition this class can also verify if all requirements for the various writers in it are met.
$routers : \phpDocumentor\Transformer\Router\Queue
__construct(\phpDocumentor\Transformer\Router\Queue $routers)
Initializes this writer collection with the necessary requirements.
| \phpDocumentor\Transformer\Router\Queue | $routers | A series of routers, in order of importance, that are used to generate urls with. |
offsetSet(string $index, \phpDocumentor\Transformer\Writer\WriterAbstract $newval) : void
Registers a writer with a given name.
| string | $index | a Writer's name, must be at least 3 characters, alphanumeric and/or contain one or more hyphens, underscores and forward slashes. |
| \phpDocumentor\Transformer\Writer\WriterAbstract | $newval | The Writer object to register to this name. |
if either of the above restrictions is not met.
offsetGet(string $index) : \phpDocumentor\Transformer\Writer\WriterAbstract
Retrieves a writer from the collection.
| string | $index | the name of the writer to retrieve. |
if the writer is not in the collection.
Loading…