WriterAbstract implements Stringable
AbstractYes
Base class for the actual transformation business logic (writers).
Table of Contents
Interfaces
- Stringable
Methods
- __toString() : string
- checkRequirements() : void
- This method verifies whether PHP has all requirements needed to run this writer.
- getName() : string
- Name of this writer, used to identify this writer.
- transform() : void
- Abstract definition of the transformation method.
Methods
__toString()
public
__toString() : string
Return values
stringcheckRequirements()
This method verifies whether PHP has all requirements needed to run this writer.
public
checkRequirements() : void
If one of the requirements is missing for this Writer then an exception of type RequirementMissing should be thrown; this indicates to the calling process that this writer will not function.
Tags
getName()
Name of this writer, used to identify this writer.
public
abstract getName() : string
This name is also used in Collection as key and should match the name provided in the template definitions' transformations.
Return values
stringtransform()
Abstract definition of the transformation method.
public
abstract transform(Transformation $transformation, ProjectDescriptor $project, DocumentationSetDescriptor $documentationSet) : void
Parameters
- $transformation : Transformation
-
Transformation to execute.
- $project : ProjectDescriptor
-
Document containing the structure.
- $documentationSet : DocumentationSetDescriptor