\phpDocumentor\Transformer\Command\ProjectTransformCommand

Transforms the structure file into the specified output format

This task will execute the transformation rules described in the given template (defaults to 'responsive') with the given source (defaults to output/structure.xml) and writes these to the target location (defaults to 'output').

It is possible for the user to receive additional information using the verbose option or stop additional information using the quiet option. Please take note that the quiet option also disables logging to file.

Summary

Methods
Properties
Constants
setHelperSet()
__construct()
getBuilder()
getTransformer()
loadTransformations()
No public properties found
No constants found
getProgressBar()
configure()
execute()
getCache()
getTemplates()
createTransformation()
appendReceivedTransformations()
$builder
$transformer
$compiler
N/A
connectOutputToEvents()
No private properties found
N/A

Properties

Methods

setHelperSet()

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

Registers the current command.

Parameters

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

getTransformer()

getTransformer() : \phpDocumentor\Transformer\Transformer

Returns the transformer used to guide the transformation process from AST to output.

Returns

\phpDocumentor\Transformer\Transformer

loadTransformations()

loadTransformations(\phpDocumentor\Transformer\Transformer  $transformer) : void

Load custom defined transformations.

Parameters

\phpDocumentor\Transformer\Transformer $transformer

getProgressBar()

getProgressBar(\Symfony\Component\Console\Input\InputInterface  $input) : \Symfony\Component\Console\Helper\HelperInterface|null

Adds the transformer.transformation.post event to advance the progressbar.

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\HelperInterface|null

configure()

configure() : void

Initializes this command and sets the name, description, options and arguments.

execute()

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

Executes the business logic involved with this command.

Parameters

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

Throws

\Exception

if the provided source is not an existing file or a folder.

Returns

integer

getCache()

getCache() : \Zend\Cache\Storage\StorageInterface

Returns the Cache.

Returns

\Zend\Cache\Storage\StorageInterface

getTemplates()

getTemplates(\Symfony\Component\Console\Input\InputInterface  $input) : array<mixed,string>

Retrieves the templates to be used by analyzing the options and the configuration.

Parameters

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

Returns

array<mixed,string>

createTransformation()

createTransformation(array  $transformations) : \phpDocumentor\Transformer\Transformation

Create Transformation instance.

Parameters

array $transformations

Returns

\phpDocumentor\Transformer\Transformation

appendReceivedTransformations()

appendReceivedTransformations(\phpDocumentor\Transformer\Transformer  $transformer, array  $received) : void

Append received transformations.

Parameters

\phpDocumentor\Transformer\Transformer $transformer
array $received

connectOutputToEvents()

connectOutputToEvents(\Symfony\Component\Console\Output\OutputInterface  $output) : void

Connect a series of output messages to various events to display progress.

Parameters

\Symfony\Component\Console\Output\OutputInterface $output