\phpDocumentor\Transformer\WriterCollection

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.

Summary

Methods
Properties
Constants
__construct()
offsetSet()
offsetGet()
checkRequirements()
No public properties found
No constants found
No protected methods found
$routers
N/A
No private methods found
No private properties found
N/A

Properties

Methods

__construct()

__construct(\phpDocumentor\Transformer\Router\Queue  $routers) 

Initializes this writer collection with the necessary requirements.

Parameters

\phpDocumentor\Transformer\Router\Queue $routers

A series of routers, in order of importance, that are used to generate urls with.

offsetSet()

offsetSet(string  $index, \phpDocumentor\Transformer\Writer\WriterAbstract  $newval) : void

Registers a writer with a given name.

Parameters

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.

Throws

\InvalidArgumentException

if either of the above restrictions is not met.

offsetGet()

offsetGet(string  $index) : \phpDocumentor\Transformer\Writer\WriterAbstract

Retrieves a writer from the collection.

Parameters

string $index

the name of the writer to retrieve.

Throws

\InvalidArgumentException

if the writer is not in the collection.

Returns

\phpDocumentor\Transformer\Writer\WriterAbstract

checkRequirements()

checkRequirements() : void

Iterates over each writer in this collection and checks its requirements.

Throws

\phpDocumentor\Transformer\Writer\Exception\RequirementMissing

if a requirement of a writer is missing.