\Tale\Jade\RendererAdapterBase

Acts as a base class for renderer adapters.

Provides some requirements for the renderer adapters. The key is the ->render() method with actually does the rendering.

Summary

Methods
Properties
Constants
__construct()
getRenderer()
render()
No public properties found
No constants found
getOption()
No protected properties found
N/A
No private methods found
$_renderer
$_options
N/A

Properties

$_renderer

$_renderer : \Tale\Jade\Renderer

The renderer this adapter got created in.

Type

\Tale\Jade\Renderer

$_options

$_options : array

The options array for this adapter.

Type

array

Methods

__construct()

__construct(\Tale\Jade\Renderer  $renderer, array|null  $options = null) 

Creates a new adapter.

If you create a child-adapter, make sure to set your default options correctly

Something along these lines: parent::__construct($renderer, array_replace_recursive([ 'your' => 'default', 'option' => 'array' ], $options ? $options : []);

Parameters

\Tale\Jade\Renderer $renderer

the renderer this adapter is created in

array|null $options

the options array for the adapter

getRenderer()

getRenderer() : \Tale\Jade\Renderer

Returns the attached renderer this adapter was created in.

Returns

\Tale\Jade\Renderer

render()

render(string  $path, array|null  $args = null) : string

Renders a jade file by a given path.

The extension can be omitted if it's the extension set in the Compiler-options ('.jade' by default)

The given $args-argument should be an associative array and will be passed as variables that you can use inside the rendered template file

Notice that the path is relative to the Compiler-option 'paths' or, if no paths passed, the paths in get_include_path()

You might just echo the result, cache it or do anything else with it

Parameters

string $path

the relative path to be rendered

array|null $args

the variables for the template

Returns

string —

the rendered markup

getOption()

getOption(string  $name) : mixed

Returns an option by a given name.

The existence of the option is not checked

Parameters

string $name

the name of the option

Returns

mixed —

the value of the option