\phpDocumentor\Transformer\WriterCollection

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.

Summary

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

Methods

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.