\phpDocumentor\Plugin\Scrybe\ConverterConverterInterface

This interface provides a basic contract between the Converters and all classes that want to use them.

Summary

Methods
Constants
convert()
getDefinition()
setOption()
getAssets()
getTableOfContents()
getGlossary()
setLogger()
OPTION_TEMPLATE
No protected methods found
N/A
No private methods found
N/A

Constants

OPTION_TEMPLATE

OPTION_TEMPLATE

Standard option used to convey the name of the template to use.

Methods

convert()

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.

Parameters

\phpDocumentor\Fileset\Collection $source

Collection of input files.

\phpDocumentor\Plugin\Scrybe\Template\TemplateInterface $template

Template used to decorate the output with.

Returns

array<mixed,string>|null

setOption()

setOption(string  $name, string  $value) : void

Sets an option which can optionally be used in converters.

Parameters

string $name
string $value

setLogger()

setLogger(\Monolog\Logger  $logger) : void

Optionally set a logger for this converter.

Parameters

\Monolog\Logger $logger