ConverterInterface

Extends

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

package

Default

Methods

Converts the given $source using the formats that belong to this converter.

convert(\phpDocumentor\Fileset\Collection $source, \phpDocumentor\Plugin\Scrybe\Template\TemplateInterface $template) : array<mixed,string>|null

This method will return null unless the 'scrybe://result' is used.

see \phpDocumentor\Plugin\Scrybe\Converter\DESTINATION_RESULT

to use as destination to return data.

Arguments

$source

\phpDocumentor\Fileset\Collection

Collection of input files.

$template

\phpDocumentor\Plugin\Scrybe\Template\TemplateInterface

Template used to decorate the output with.

Response

array<mixed,string>|null

Returns the AssetManager that keep track of which assets are used.

getAssets() : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\Assets

Returns the definition for this Converter.

getDefinition() : \phpDocumentor\Plugin\Scrybe\Converter\Definition\Definition

Returns the glossary object that keeps track of all the glossary terms that have been provided.

getGlossary() : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\Glossary

Returns the table of contents object that keeps track of all headings and their titles.

getTableOfContents() : \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents

Optionally set a logger for this converter.

setLogger(\Monolog\Logger $logger) : void

Arguments

$logger

\Monolog\Logger

Sets an option which can optionally be used in converters.

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

Arguments

$name

string

$value

string

Constants

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

OPTION_TEMPLATE
see