1. class
  2. Windwalker
  3. Core
  4. Renderer
  5. RendererManager

RendererManager

class RendererManager (View source)

The RendererFactory class.

Traits

GlobalVarsTrait
The GlobalVarsTrait class.

Constants

PHP

BLADE

EDGE

TWIG

MUSTACHE

Methods

GlobalVarsTrait
addGlobal(string $name, mixed $value)

addGlobal

from GlobalVarsTrait
GlobalVarsTrait
removeGlobal(string $name)

removeGlobal

from GlobalVarsTrait
array
getGlobals()

Method to get property Globals

from GlobalVarsTrait
GlobalVarsTrait
setGlobals(array $globals)

Method to set property globals

from GlobalVarsTrait
__construct(Config $config, PackageFinder $finder, array $paths = array())

RendererFactory constructor.

AbstractRenderer|CoreRendererInterface
getRenderer(string $type = self::PHP, array $config = array())

Create a renderer object and auto inject the global paths.

PhpRenderer
getPhpRenderer(array $config = array())

Create php renderer.

BladeRenderer
getBladeRenderer(array $config = array())

Create blade renderer.

EdgeRenderer
getEdgeRenderer(array $config = array())

getEdgeRenderer

TwigRenderer
getTwigRenderer(array $config = array())

Create twig renderer.

MustacheRenderer
getMustacheRenderer(array $config = array())

Create mustache renderer.

PriorityQueue
getGlobalPaths()

Get a clone of global paths.

RendererManager
addGlobalPath(string $path, int $priority = PriorityQueue::LOW)

Add a global path for Renderer search.

RendererManager
addPath(string $path, int $priority = PriorityQueue::LOW)

An alias of getGlobalPath()

RendererManager
reset()

Reset all paths.

RendererManager
setPaths(array $paths)

Method to set property paths

RendererManager
addHelper(string $name, object $helper)

addHelper

AbstractHelper|object
getHelper(string $name)

getHelper

AbstractHelper[]
getHelpers()

Method to get property Helpers

RendererManager
setHelpers(AbstractHelper[] $helpers)

Method to set property helpers

Details

in GlobalVarsTrait at line line 33
GlobalVarsTrait addGlobal(string $name, mixed $value)

addGlobal

Parameters

string $name
mixed $value

Return Value

GlobalVarsTrait

in GlobalVarsTrait at line line 47
GlobalVarsTrait removeGlobal(string $name)

removeGlobal

Parameters

string $name

Return Value

GlobalVarsTrait

in GlobalVarsTrait at line line 59
array getGlobals()

Method to get property Globals

Return Value

array

in GlobalVarsTrait at line line 71
GlobalVarsTrait setGlobals(array $globals)

Method to set property globals

Parameters

array $globals

Return Value

GlobalVarsTrait Return self to support chaining.

at line line 74
__construct(Config $config, PackageFinder $finder, array $paths = array())

RendererFactory constructor.

Parameters

Config $config
PackageFinder $finder
array $paths

at line line 94
AbstractRenderer|CoreRendererInterface getRenderer(string $type = self::PHP, array $config = array())

Create a renderer object and auto inject the global paths.

Parameters

string $type Renderer engine name, php, blade, twig or mustache.
array $config Renderer config array.

Return Value

AbstractRenderer|CoreRendererInterface

at line line 152
PhpRenderer getPhpRenderer(array $config = array())

Create php renderer.

Parameters

array $config Renderer config array.

Return Value

PhpRenderer

at line line 166
BladeRenderer getBladeRenderer(array $config = array())

Create blade renderer.

Parameters

array $config Renderer config array.

Return Value

BladeRenderer

at line line 180
EdgeRenderer getEdgeRenderer(array $config = array())

getEdgeRenderer

Parameters

array $config

Return Value

EdgeRenderer

at line line 194
TwigRenderer getTwigRenderer(array $config = array())

Create twig renderer.

Parameters

array $config Renderer config array.

Return Value

TwigRenderer

at line line 208
MustacheRenderer getMustacheRenderer(array $config = array())

Create mustache renderer.

Parameters

array $config Renderer config array.

Return Value

MustacheRenderer

at line line 220
PriorityQueue getGlobalPaths()

Get a clone of global paths.

Return Value

PriorityQueue

at line line 235
RendererManager addGlobalPath(string $path, int $priority = PriorityQueue::LOW)

Add a global path for Renderer search.

Parameters

string $path The path you want to set.
int $priority Priority flag to order paths.

Return Value

RendererManager

at line line 252
RendererManager addPath(string $path, int $priority = PriorityQueue::LOW)

An alias of getGlobalPath()

Parameters

string $path The path you want to set.
int $priority Priority flag to order paths.

Return Value

RendererManager

at line line 311
RendererManager reset()

Reset all paths.

Return Value

RendererManager

at line line 325
RendererManager setPaths(array $paths)

Method to set property paths

Parameters

array $paths

Return Value

RendererManager Return self to support chaining.

at line line 345
RendererManager addHelper(string $name, object $helper)

addHelper

Parameters

string $name
object $helper

Return Value

RendererManager

at line line 359
AbstractHelper|object getHelper(string $name)

getHelper

Parameters

string $name

Return Value

AbstractHelper|object

at line line 374
AbstractHelper[] getHelpers()

Method to get property Helpers

Return Value

AbstractHelper[]

at line line 386
RendererManager setHelpers(AbstractHelper[] $helpers)

Method to set property helpers

Parameters

AbstractHelper[] $helpers

Return Value

RendererManager Return self to support chaining.