Properties
$writer Line 24
private$writer : string
$artifact Line 27
private$artifact : string
$source Line 30
private$source : string
$query Line 36
private$query : string
$transformer Line 39
private$transformer : \phpDocumentor\Transformer\Transformer
$parameters Line 45
private$parameters : \phpDocumentor\Transformer\Template\Parameter[]
$template Line 48
private$template : \phpDocumentor\Transformer\Template
Methods
__construct() Line 58
Constructs a new Transformation object and populates the required parameters.
public__construct(Template $template, string $query, string $writer, string $source, string $artifact) : mixed
Parameters
What information to use as datasource for the writer's source.
What type of transformation to apply (PDF, Twig etc).
Which template or type of source to use.
What is the filename of the result (relative to the generated root)
Returns
mixed —Parameters
Free-form string with writer-specific values.
Returns
string —
setWriter() Line 90
Sets the writer type and instantiates a writer.
publicsetWriter(string $writer) : void
Parameters
Name of writer to instantiate.
Returns
string —
setSource() Line 108
Sets the source / type which the writer will use to generate artifacts from.
publicsetSource(string $source) : void
Parameters
Free-form string with writer-specific meaning.
getSource() Line 116
Returns the name of the source / type used in the transformation process.
publicgetSource() : string
Returns
string —
template() Line 121
publictemplate() : Template
setArtifact() Line 135
Filename of the resulting artifact relative to the root.
publicsetArtifact(string $artifact) : void
If the query results in a set of artifacts (multiple nodes / array); then this string must contain an identifying variable as returned by the writer.
Parameters
Name of artifact to generate; usually a filepath.
Returns
string —
setParameters() Line 154
Sets an array of parameters (key => value).
publicsetParameters(\phpDocumentor\Transformer\Template\Parameter[] $parameters) : void
Parameters
Associative multidimensional array containing parameters for the Writer.
getParameters() Line 164
Returns all parameters for this transformation.
publicgetParameters() : \phpDocumentor\Transformer\Template\Parameter[]
Returns
\phpDocumentor\Transformer\Template\Parameter[] —
getParameter() Line 174
Returns a specific parameter, or $default if none exists.
publicgetParameter(string $name) : Parameter|null
getParametersWithKey() Line 192
Returns a specific parameter, or $default if none exists.
publicgetParametersWithKey(string $name) : \phpDocumentor\Transformer\Template\Parameter[]
Parameters
Name of the parameter to return.
Returns
\phpDocumentor\Transformer\Template\Parameter[] —
setTransformer() Line 210
Sets the transformer on this transformation.
publicsetTransformer(Transformer $transformer) : void
getTransformer() Line 218
Returns the transformer for this transformation.
publicgetTransformer() : Transformer|null