Collection

Extends \phpDocumentor\Transformer\Behaviour\BehaviourAbstract Implements \Countable

Collection object for a set of Behaviours.

package

Default

Methods

Initializes the list of Behaviours to execute each request.

__construct(array<mixed,\phpDocumentor\Transformer\Behaviour\BehaviourAbstract> $behaviours = array()) 

Arguments

$behaviours

array<mixed,\phpDocumentor\Transformer\Behaviour\BehaviourAbstract>

List of behaviours to process.

Adds a behaviour to a collection

addBehaviour(\phpDocumentor\Transformer\Behaviour\BehaviourAbstract $behaviour) : void

Arguments

$behaviour

\phpDocumentor\Transformer\Behaviour\BehaviourAbstract

Behaviour to add to the collection.

Count the number of behaviours in this collection.

count() : integer

Response

integer

Returns the transformer that hosts this behaviour.

getTransformer() : \phpDocumentor\Transformer\Transformer
inherited

Executes the behaviour on the given dataset,

process(\phpDocumentor\Descriptor\ProjectDescriptor $project) : \phpDocumentor\Descriptor\ProjectDescriptor
inherited abstract

Arguments

$project

\phpDocumentor\Descriptor\ProjectDescriptor

document containing the source structure.

Response

\phpDocumentor\Descriptor\ProjectDescriptor

Removes a behaviour from the collection

removeBehaviour(\phpDocumentor\Transformer\Behaviour\BehaviourAbstract $behaviour) : void

Arguments

$behaviour

\phpDocumentor\Transformer\Behaviour\BehaviourAbstract

Behaviour to remove from the collection.

Sets the transformer used for this behaviour.

setTransformer(\phpDocumentor\Transformer\Transformer $transformer) : void
inherited

Arguments

$transformer

\phpDocumentor\Transformer\Transformer

Transformer responsible for output.

Properties

the list of behaviours that can be exposed using this collection

behaviours : array<mixed,\phpDocumentor\Transformer\Behaviour\BehaviourAbstract>
var

the list of behaviours that can be exposed using this collection

Type(s)

array<mixed,\phpDocumentor\Transformer\Behaviour\BehaviourAbstract>

The base transformer object from which the transformation parameters can be retrieved.

transformer : \phpDocumentor\Transformer\Transformer
inherited
var

The base transformer object from which the transformation parameters can be retrieved.

Type(s)

\phpDocumentor\Transformer\Transformer