Twig
A specialized writer which uses the Twig templating engine to convert templates to HTML output.
This writer support the Query attribute of a Transformation to generate multiple templates in one transformation.
The Query attribute supports a simplified version of Twig queries and will use each individual result as the 'node' global variable in the Twig template.
Example:
Suppose a Query indexes.classes
is given then this writer will be
invoked as many times as there are classes in the project and the
'node' global variable in twig will be filled with each individual
When using the Query attribute in the transformation it is important to use a variable in the Artifact attribute as well (otherwise the same file would be overwritten several times).
A simple example transformation line could be:
<transformation
writer="twig"
source="templates/twig/index.twig"
artifact="index.html"
/>
This example transformation would use this writer to transform the index.twig template file in the twig template folder into index.html at the destination location. Since no Query is provided the 'node' global variable will contain the Project Descriptor of the Object Graph.
A complex example transformation line could be:
<transformation
query="indexes.classes"
writer="twig"
source="templates/twig/class.twig"
artifact="{{name}}.html"/>
This example transformation would use this writer to transform the class.twig template file in the twig template folder into a file with the 'name' property for an individual class inside the Object Graph. Since a Query is provided will the 'node' global variable contain a specific instance of a class applicable to the current iteration.
Interfaces, Classes & Used Traits
Properties
$environmentFactory Line 88
private$environmentFactory : \phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory
$pathGenerator Line 91
private$pathGenerator : \phpDocumentor\Transformer\Writer\PathGenerator
Methods
checkRequirements() inherited
This method verifies whether PHP has all requirements needed to run this writer.
publiccheckRequirements() : void
If one of the requirements is missing for this Writer then an exception of type RequirementMissing should be thrown; this indicates to the calling process that this writer will not function.
Throws
- \phpDocumentor\Transformer\Writer\Exception\RequirementMissing
When a requirements is missing stating which one.
- Inherited from
- \phpDocumentor\Transformer\Writer\WriterAbstract
transform() Line 112
This method combines the ProjectDescriptor and the given target template and creates a static html page at the artifact location.
publictransform(ProjectDescriptor $project, Transformation $transformation) : void
Parameters
Document containing the structure.
Transformation to execute.
Throws
- \Twig\Error\LoaderError
- \Twig\Error\RuntimeError
- \Twig\Error\SyntaxError
__toString() inherited
public__toString() : string
__construct() Line 93
public__construct(EnvironmentFactory $environmentFactory, PathGenerator $pathGenerator) : mixed
copy() inherited
protectedcopy(Transformation $transformation, string $path, string $destination) : void
- Inherited from
- \phpDocumentor\Transformer\Writer\IoTrait
readSourceFile() inherited
protectedreadSourceFile(Transformation $transformation, string $path) : string
- Inherited from
- \phpDocumentor\Transformer\Writer\IoTrait
persistTo() inherited
protectedpersistTo(Transformation $transformation, string $path, string $contents) : void
- Inherited from
- \phpDocumentor\Transformer\Writer\IoTrait
copyDirectory() inherited
privatecopyDirectory(Transformation $transformation, string $path, string $destination) : void
- Inherited from
- \phpDocumentor\Transformer\Writer\IoTrait
stripFirstPartOfPath() inherited
privatestripFirstPartOfPath(string $path) : string
isGlobalTemplateReference() inherited
privateisGlobalTemplateReference(string $path) : bool
normalizeSourcePath() inherited
privatenormalizeSourcePath(string $path) : string
normalizeDestination() inherited
privatenormalizeDestination(string $destination) : string
Parameters
Returns
string —- Inherited from
- \phpDocumentor\Transformer\Writer\IoTrait
getTemplatePath() Line 141
Returns the path belonging to the template.
privategetTemplatePath(Transformation $transformation) : string