Collection

in package
extends ArrayObject

A collection of Writer objects.

In this collection we can receive writers.

In addition this class can also verify if all requirements for the various writers in it are met.

template-extends

ArrayObject<string,WriterAbstract>

Methods

Registers a writer with a given name.

publicoffsetSet(string $index, WriterAbstract $newval) : void

Parameters

$index : string

a Writer's name, must be at least 3 characters, alphanumeric and/or contain one or more hyphens, underscores and forward slashes.

$newval : WriterAbstract

The Writer object to register to this name.

Throws

\InvalidArgumentException

If either of the above restrictions is not met.

Retrieves a writer from the collection.

publicoffsetGet(string $index) : WriterAbstract

Parameters

$index : string

the name of the writer to retrieve.

Throws

\InvalidArgumentException

If the writer is not in the collection.

Returns

WriterAbstract

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

publiccheckRequirements() : void

Throws

\phpDocumentor\Transformer\Writer\Exception\RequirementMissing

If a requirement of a writer is missing.