phpDocumentor

Collection extends ArrayObject
in package

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.

Table of Contents

checkRequirements()  : void
Iterates over each writer in this collection and checks its requirements.
offsetGet()  : WriterAbstract
Retrieves a writer from the collection.
offsetSet()  : void
Registers a writer with a given name.

Methods

checkRequirements()

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

public checkRequirements() : void
Tags
throws
RequirementMissing

If a requirement of a writer is missing.

Return values
void

offsetGet()

Retrieves a writer from the collection.

public offsetGet(string $index) : WriterAbstract
Parameters
$index : string

the name of the writer to retrieve.

Tags
throws
InvalidArgumentException

If the writer is not in the collection.

Return values
WriterAbstract

offsetSet()

Registers a writer with a given name.

public offsetSet(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.

Tags
throws
InvalidArgumentException

If either of the above restrictions is not met.

Return values
void

Search results