BaseConvertCommand

Extends \phpDocumentor\Command\Command

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

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

package

Default

Methods

Initializes this command with a template and converter factory.

__construct(string $name, \phpDocumentor\Plugin\Scrybe\Template\Factory $templateFactory, \phpDocumentor\Plugin\Scrybe\Converter\Factory $converterFactory) 

Arguments

$name

string

Constructs a Fileset collection and returns that.

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

Arguments

$sources

array

List of source paths.

$extensions

array

List of extensions to scan for in directories.

Response

\phpDocumentor\Fileset\Collection

Configures the options and default help text.

configure() : void

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

execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : integer
see \phpDocumentor\Plugin\Scrybe\Command\Manual\BaseConvertCommand::output_format

to determine the output format.

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

$output

\Symfony\Component\Console\Output\OutputInterface

Response

integer

Returns the converter for this operation.

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

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

Response

\phpDocumentor\Plugin\Scrybe\Converter\ConverterInterface

Returns the factory for converters.

getConverterFactory() : \phpDocumentor\Plugin\Scrybe\Converter\Factory

Returns the Progress bar helper.

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

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

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

Response

\Symfony\Component\Console\Helper\ProgressHelper

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

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

Arguments

$input

\Symfony\Component\Console\Input\InputInterface

Response

\phpDocumentor\Plugin\Scrybe\Template\TemplateInterface

Returns a factory object that can return any Scrybe template.

getTemplateFactory() : \phpDocumentor\Plugin\Scrybe\Template\Factory

Registers the current command.

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

Arguments

$helperSet

\Symfony\Component\Console\Helper\HelperSet

writeToDisk

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

Arguments

$files

array<mixed,string>

$destination

string

Properties

converterFactory

converterFactory : \phpDocumentor\Plugin\Scrybe\Converter\Factory

templateFactory

templateFactory : \phpDocumentor\Plugin\Scrybe\Template\Factory

The string representation of the output format

output_format : string
var

The string representation of the output format

Type(s)

string