$modules
$modules : \Phug\Util\Partial\array<ModuleInterface>
$importNode : \Phug\Parser\NodeInterface
$yieldNode : \Phug\Parser\NodeInterface
$parser : \Phug\Parser
$locator : \Phug\Compiler\LocatorInterface
$upperLocator : \Phug\Compiler\LocatorInterface|null
$layout : \Phug\Compiler\Layout
$currentNode : \Phug\Parser\NodeInterface
$parentCompiler : \Phug\CompilerInterface
hasModule(string|\Phug\Util\ModuleInterface $module) : boolean
| string|\Phug\Util\ModuleInterface | $module |
getModule(string|\Phug\Util\ModuleInterface $module) : \Phug\Util\ModuleInterface
| string|\Phug\Util\ModuleInterface | $module |
addModule(string|\Phug\Util\ModuleInterface $module) : $this
| string|\Phug\Util\ModuleInterface | $module |
removeModule(string|\Phug\Util\ModuleInterface $module) : $this
| string|\Phug\Util\ModuleInterface | $module |
setImportNode(\Phug\Parser\NodeInterface $importNode) : $this
| \Phug\Parser\NodeInterface | $importNode |
setYieldNode(\Phug\Parser\NodeInterface $yieldNode) : $this
| \Phug\Parser\NodeInterface | $yieldNode |
getYieldNode() : \Phug\Parser\NodeInterface
getImportNode() : \Phug\Parser\NodeInterface
getParentCompiler() : \Phug\CompilerInterface|null
Get parent compiler (compiler of the file that included/extended the current file) or null if the file is not compiled via an import.
setParentCompiler(\Phug\CompilerInterface $compiler) : $this
Set the parent compiler (should be used to declare an import relation such as include/extend).
| \Phug\CompilerInterface | $compiler |
setUpperLocator(\Phug\Compiler\LocatorInterface|null $upperLocator)
Set a master locator to use before the internal one.
| \Phug\Compiler\LocatorInterface|null | $upperLocator | locator strategy |
getLayout() : \Phug\Compiler\Layout
Return the current layout extended if set.
setLayout(\Phug\Compiler\Layout $layout) : $this
Set the current layout to extend.
| \Phug\Compiler\Layout | $layout | layout extended |
getParser() : \Phug\Parser
Returns the currently used Parser instance.
getFormatter() : \Phug\Formatter
Returns the currently used Formatter instance.
setNodeCompiler(string $className, \Phug\Compiler\NodeCompilerInterface|string $handler) : $this
Set the node compiler for a given node class name.
| string | $className | node class name |
| \Phug\Compiler\NodeCompilerInterface|string | $handler | handler |
compileNode(\Phug\Parser\NodeInterface $node, \Phug\Formatter\ElementInterface $parent = null) : \Phug\Formatter\ElementInterface
Returns PHTML from pug node input.
| \Phug\Parser\NodeInterface | $node | input |
| \Phug\Formatter\ElementInterface | $parent | optional parent element |
replaceBlock(\Phug\Compiler\Element\BlockElement $block, array $children = null)
Replace a block by its nodes.
| \Phug\Compiler\Element\BlockElement | $block | |
| array | $children |
compileDocument(string $input, string $path = null) : null|\Phug\Formatter\ElementInterface
Returns ElementInterface from pug input with all layouts and blocks compiled.
| string | $input | pug input |
| string | $path | optional path of the compiled source |
compileIntoElement(string $input, string $path = null) : null|\Phug\Formatter\ElementInterface
Returns ElementInterface from pug input.
| string | $input | pug input |
| string | $path | optional path of the compiled source |
compileFileIntoElement(string $path) : \Phug\Formatter\ElementInterface
Returns ElementInterface from pug input file.
| string | $path | path of the compiled source |
setFilter(string $name, callable $filter) : \Phug\Compiler|\Phug\CompilerInterface
Set a filter for the current compiler.
| string | $name | |
| callable | $filter |
unsetFilter(string $name) : \Phug\Compiler|\Phug\CompilerInterface
Remove a filter from the compiler.
| string | $name |
throwException(string $message, \Phug\Parser\NodeInterface $node = null, integer $code, \Throwable $previous = null)
Throws a compiler-exception.
The current file, line and offset of the exception get automatically appended to the exception
| string | $message | A meaningful error message |
| \Phug\Parser\NodeInterface | $node | Node generating the error |
| integer | $code | Error code |
| \Throwable | $previous | Source error |
assert(boolean $condition, string|\Closure $message, null $node = null, integer $code, null $previous = null)
Throw an exception if given condition is false.
| boolean | $condition | condition to validate |
| string|\Closure | $message | message to throw if condition isn't validated or a closure that returns it |
| null | $node | optional node to get code position in error details |
| integer | $code | optional error code |
| null | $previous | optional link to previous exception |
getNamedCompiler(string $compiler) : \Phug\Compiler\NodeCompilerInterface
Create a new compiler instance by name or return the previous instance with the same name.
| string | $compiler | name |
initializeFormatter() : \Phug\Formatter
Create the instance of formatter.