OPTION_TEMPLATE
OPTION_TEMPLATE = 'template'
Standard option used to convey the name of the template to use.
This interface provides a basic contract between the Converters and all classes that want to use them.
convert(\phpDocumentor\Fileset\Collection $source, \phpDocumentor\Plugin\Scrybe\Template\TemplateInterface $template) : array<mixed,string>|null
Converts the given $source using the formats that belong to this converter.
This method will return null unless the 'scrybe://result' is used.
| \phpDocumentor\Fileset\Collection | $source | Collection of input files. |
| \phpDocumentor\Plugin\Scrybe\Template\TemplateInterface | $template | Template used to decorate the output with. |
getDefinition() : \phpDocumentor\Plugin\Scrybe\Converter\Definition\Definition
Returns the definition for this Converter.
getAssets() : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\Assets
Returns the AssetManager that keep track of which assets are used.
getTableOfContents() : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents
Returns the table of contents object that keeps track of all headings and their titles.
getGlossary() : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\Glossary
Returns the glossary object that keeps track of all the glossary terms that have been provided.