Transform

in package

Transforms the structure file into the specified output format

This task will execute the transformation rules described in the given template with the given source 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.

Properties

private$transformer  : \phpDocumentor\Transformer\Transformer                

private$compiler  : \phpDocumentor\Compiler\Compiler                

private$logger  : \Psr\Log\LoggerInterface                

private$exampleFinder  : \phpDocumentor\Reflection\DocBlock\ExampleFinder                

Methods

Initializes the command with all necessary dependencies to construct human-suitable output from the AST.

public__construct(Transformer $transformer, Compiler $compiler, LoggerInterface $logger, ExampleFinder $exampleFinder) : mixed

Parameters

$transformer : Transformer
$compiler : Compiler
$logger : LoggerInterface
$exampleFinder : ExampleFinder

Returns

mixed

Executes the business logic involved with this command.

public__invoke(Payload $payload) : Payload

Parameters

$payload : Payload

Throws

\Exception

If the target location is not a folder.

Returns

Payload

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

privateconnectOutputToEvents() : void

privateloadTemplatesBasedOnNames(array $templateNames) : void

Parameters

$templateNames : array

privatesetTargetLocationBasedOnDsn(Dsn $dsn) : void

Parameters

$dsn : Dsn

privatedoTransform(ProjectDescriptorBuilder $builder) : void

Parameters

$builder : ProjectDescriptorBuilder

privateprovideLocationsOfExamples() : void