\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
__construct()
get()
checkRequirements()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$writers
N/A

Properties

$writers

$writers : array<string,\phpDocumentor\Transformer\Writer\WriterAbstract>

Type

WriterAbstract>

Methods

__construct()

__construct(iterable<string,\phpDocumentor\Transformer\Writer\WriterAbstract>  $writers) : mixed

Parameters

iterable $writers

Returns

mixed —

get()

get(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.