\phpDocumentor\Plugin\Scrybe\Command\ManualBaseConvertCommand

Abstract Command class containing the scaffolding for the subsequent converting commands.

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

Summary

Methods
Properties
Constants
setHelperSet()
__construct()
getConverterFactory()
No public properties found
No constants found
getProgressBar()
configure()
execute()
writeToDisk()
getTemplate()
getConverter()
buildCollection()
getTemplateFactory()
$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

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

configure()

configure() : void

Configures the options and default help text.

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 the converter for this operation.

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