\phpDocumentor\Plugin\Scrybe\Command\ManualToLatexCommand

Command used to tell the application to convert from a format to Latex.

Includes additional methods to forward the output to the logging events of phpDocumentor.

Summary

Methods
Properties
Constants
__construct()
getConverterFactory()
setHelperSet()
No public properties found
No constants found
configure()
execute()
writeToDisk()
getTemplate()
getConverter()
buildCollection()
getTemplateFactory()
getProgressBar()
configureConverterFromInputOptions()
$converterFactory
$templateFactory
$output_format
N/A
No private methods found
No private properties found
N/A

Properties

$output_format

$output_format : string

Type

string — The string representation of the output format

Methods

setHelperSet()

setHelperSet(\Symfony\Component\Console\Helper\HelperSet  $helperSet) 

Registers the current command.

Parameters

\Symfony\Component\Console\Helper\HelperSet $helperSet

configure()

configure() : void

Defines the name, description and additional options for this command and inherits the behaviour of the parent configure.

execute()

execute(\Symfony\Component\Console\Input\InputInterface  $input, \Symfony\Component\Console\Output\OutputInterface  $output) : integer

Execute the transformation process to an output format as defined in the $output_format class variable.

Parameters

\Symfony\Component\Console\Input\InputInterface $input
\Symfony\Component\Console\Output\OutputInterface $output

Returns

integer

writeToDisk()

writeToDisk(array<mixed,string>  $files, string  $destination) 

Parameters

array<mixed,string> $files
string $destination

getTemplate()

getTemplate(\Symfony\Component\Console\Input\InputInterface  $input) : \phpDocumentor\Plugin\Scrybe\Template\TemplateInterface

Returns a template object based off the human-readable template name.

Parameters

\Symfony\Component\Console\Input\InputInterface $input

Returns

\phpDocumentor\Plugin\Scrybe\Template\TemplateInterface

getConverter()

getConverter(\Symfony\Component\Console\Input\InputInterface  $input) : \phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface

Returns and configures the converter for this operation.

This method overrides the parent getConverter method and invokes the configureConverterFromInputOptions() method to set the options coming from the Input object.

Parameters

\Symfony\Component\Console\Input\InputInterface $input

Returns

\phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface

buildCollection()

buildCollection(array  $sources, array  $extensions) : \phpDocumentor\Fileset\Collection

Constructs a Fileset collection and returns that.

Parameters

array $sources

List of source paths.

array $extensions

List of extensions to scan for in directories.

Returns

\phpDocumentor\Fileset\Collection

getProgressBar()

getProgressBar(\Symfony\Component\Console\Input\InputInterface  $input) : \Symfony\Component\Console\Helper\ProgressHelper

Returns the Progress bar helper.

With this helper it is possible to display a progress bar and make it fill.

Parameters

\Symfony\Component\Console\Input\InputInterface $input

Returns

\Symfony\Component\Console\Helper\ProgressHelper

configureConverterFromInputOptions()

configureConverterFromInputOptions(\phpDocumentor\Plugin\Scrybe\Converter\ToLatexInterface  $converter, \Symfony\Component\Console\Input\InputInterface  $input) : void

Configures the converter with the options provided by the Input options.

Parameters

\phpDocumentor\Plugin\Scrybe\Converter\ToLatexInterface $converter
\Symfony\Component\Console\Input\InputInterface $input

Throws

\InvalidArgumentException

if the provided converter is not derived from ToLatexInterface