\phpDocumentor\Plugin\Scrybe\ConverterBaseConverter

__construct()

__construct(\phpDocumentor\Plugin\Scrybe\Converter\Definition\Definition  $definition, \phpDocumentor\Plugin\Scrybe\Converter\Metadata\Assets  $assets, \phpDocumentor\Plugin\Scrybe\Converter\Metadata\TableOfContents  $tableOfContents, \phpDocumentor\Plugin\Scrybe\Converter\Metadata\Glossary  $glossary) 

Initializes this converter and sets the definition.

Parameters

setLogger()

setLogger(\Monolog\Logger  $logger) : void

Set a logger for this converter.

Parameters

getAssets()

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

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

Returns

getTableOfContents()

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

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

Returns

getGlossary()

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

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

Returns

getDefinition()

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

Returns the definition for this Converter.

Returns

setOption()

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

Sets an option with the given name.

Parameters

getOption()

getOption(string  $name) : string|null

Returns the option with the given name or null if the option does not exist.

Parameters

Returns

configure()

configure() : void

Configures and initializes the subcomponents specific to this converter.

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

Returns

getDestinationFilenameRelativeToProjectRoot()

getDestinationFilenameRelativeToProjectRoot(\phpDocumentor\Fileset\File  $file) : string

Returns the filename relative to the Project Root of the fileset.

Parameters

Returns

discover()

discover() : void

Discovers the data that is spanning all files.

This method tries to find any data that needs to be collected before the actual creation and substitution phase begins.

Examples of data that needs to be collected during an initial phase is a table of contents, list of document titles for references, assets and more.

create()

create(\phpDocumentor\Plugin\Scrybe\Template\TemplateInterface  $template) : array<mixed,string>|null

Converts the input files into one or more output files in the intended format.

This method reads the files, converts them into the correct format and returns the contents of the conversion.

The template is used to decorate the individual files and can be obtained using the \phpDocumentor\Plugin\Scrybe\Template\Factory class.

Parameters

Returns

The contents of the resulting file(s) or null if the files are written directly to file.

addTemplateAssets()

addTemplateAssets(\phpDocumentor\Plugin\Scrybe\Template\TemplateInterface  $template) : void

Adds the assets of the template to the Assets manager.

Parameters

getDestinationFilename()

getDestinationFilename(\phpDocumentor\Fileset\File  $file) : string

Returns the filename used for the output path.

Parameters

Returns

getLogger()

getLogger() : \Monolog\Logger

Returns the logger for this converter.

Returns