getName()
getName() : string
Name of this writer, used to identify this writer.
This name is also used in {@see \phpDocumentor\Transformer\Writer\Collection} as key and should match the name provided in the template definitions' transformations.
Base class for the actual transformation business logic (writers).
checkRequirements() : void
This method verifies whether PHP has all requirements needed to run this writer.
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.
When a requirements is missing stating which one.
transform(\phpDocumentor\Descriptor\ProjectDescriptor $project, \phpDocumentor\Transformer\Transformation $transformation) : void
Abstract definition of the transformation method.
| \phpDocumentor\Descriptor\ProjectDescriptor | $project | Document containing the structure. |
| \phpDocumentor\Transformer\Transformation | $transformation | Transformation to execute. |