Factory (View)

string

renderComponent()

Render the current component.

void

slot(string $name, string|null $content = null)

Start the slot rendering process.

void

endSlot()

Save the slot content for rendering.

array

creator(array|string $views, Closure|string $callback)

array

composers(array $composers)

array

composer(array|string $views, Closure|string $callback)

void

callComposer(View $view)

Call the composer for a given view.

void

callCreator(View $view)

Call the creator for a given view.

void

startSection(string $section, string|null $content = null)

Start injecting content into a section.

void

inject(string $section, string $content)

Inject inline content into a section.

string

yieldSection()

Stop injecting content into a section and return its contents.

string

stopSection(bool $overwrite = false)

Stop injecting content into a section.

string

appendSection()

Stop injecting content into a section and append it.

string

yieldContent(string $section, string $default = '')

Get the string contents of a section.

static string

parentPlaceholder(string $section = '')

Get the parent placeholder for the current request.

bool

hasSection(string $name)

Check if section exists.

mixed

getSection(string $name, string $default = null)

Get the contents of a section.

array

getSections()

Get the entire array of sections.

void

flushSections()

Flush all of the sections.

void

addLoop(Countable|array $data)

Add new loop to the stack.

void

incrementLoopIndices()

Increment the top loop's indices.

void

popLoop()

Pop a loop from the top of the loop stack.

stdClass|null

getLastLoop()

Get an instance of the last loop in the stack.

array

getLoopStack()

Get the entire loop stack.

void

startPush(string $section, string $content = '')

Start injecting content into a push section.

string

stopPush()

Stop injecting content into a push section.

void

startPrepend(string $section, string $content = '')

Start prepending content into a push section.

string

stopPrepend()

Stop prepending content into a push section.

string

yieldPushContent(string $section, string $default = '')

Get the string contents of a push section.

void

flushStacks()

Flush all of the stacks.

void

startTranslation(array $replacements = array())

Start a translation block.

from ManagesTranslations

string

renderTranslation()

Render the current translation.

from ManagesTranslations

void

__construct(EngineResolver $engines, ViewFinderInterface $finder, Dispatcher $events)

Create a new view factory instance.

View

file(string $path, array $data = array(), array $mergeData = array())

Get the evaluated view contents for the given view.

View

make(string $view, array $data = array(), array $mergeData = array())

Get the evaluated view contents for the given view.

string

renderWhen(bool $condition, string $view, array $data = array(), array $mergeData = array())

Get the rendered content of the view based on a given condition.

string

renderEach(string $view, array $data, string $iterator, string $empty = 'raw|')

Get the rendered contents of a partial from a loop.

bool

exists(string $view)

Determine if a given view exists.

EngineInterface

getEngineFromPath(string $path)

Get the appropriate view engine for the given path.

mixed

share(array|string $key, mixed $value = null)

Add a piece of shared data to the environment.

void

incrementRender()

Increment the rendering counter.

void

decrementRender()

Decrement the rendering counter.

bool

doneRendering()

Check if there are no active render operations.

void

addLocation(string $location)

Add a location to the array of view locations.

$this

addNamespace(string $namespace, string|array $hints)

Add a new namespace to the loader.

$this

prependNamespace(string $namespace, string|array $hints)

Prepend a new namespace to the loader.

$this

replaceNamespace(string $namespace, string|array $hints)

Replace the namespace hints for the given namespace.

void

addExtension(string $extension, string $engine, Closure $resolver = null)

void

flushState()

Flush all of the factory state like sections and stacks.

void

flushStateIfDoneRendering()

Flush all of the section contents if done rendering.

array

getExtensions()

Get the extension to engine bindings.

EngineResolver

getEngineResolver()

Get the engine resolver instance.

ViewFinderInterface

getFinder()

Get the view finder instance.

void

setFinder(ViewFinderInterface $finder)

Set the view finder instance.

void

flushFinderCache()

Flush the cache of views located by the finder.

Dispatcher

getDispatcher()

Get the event dispatcher instance.

void

setDispatcher(Dispatcher $events)

Set the event dispatcher instance.

Container

getContainer()

Get the IoC container instance.

void

setContainer(Container $container)

Set the IoC container instance.

mixed

shared(string $key, mixed $default = null)

Get an item from the shared data.

array

getShared()

Get all of the shared data for the environment.

Details

void startComponent(string $name, array $data = array())

Start a component rendering process.

Parameters

string	$name
array	$data

Return Value

void

string renderComponent()

Render the current component.

Return Value

string

void slot(string $name, string|null $content = null)

Start the slot rendering process.

Parameters

string	$name
string\|null	$content

Return Value

void

void endSlot()

Save the slot content for rendering.

Return Value

void

array creator(array|string $views, Closure|string $callback)

Parameters

array\|string	$views
Closure\|string	$callback

Return Value

array

array composers(array $composers)

Parameters

array

$composers

Return Value

array

array composer(array|string $views, Closure|string $callback)

Parameters

array\|string	$views
Closure\|string	$callback

Return Value

array

void callComposer(View $view)

Call the composer for a given view.

Parameters

$view

Return Value

void

void callCreator(View $view)

Call the creator for a given view.

Parameters

$view

Return Value

void

void startSection(string $section, string|null $content = null)

Start injecting content into a section.

Parameters

string	$section
string\|null	$content

Return Value

void

void inject(string $section, string $content)

Inject inline content into a section.

Parameters

string	$section
string	$content

Return Value

void

string yieldSection()

Stop injecting content into a section and return its contents.

Return Value

string

string stopSection(bool $overwrite = false)

Stop injecting content into a section.

Parameters

bool

$overwrite

Return Value

string

Exceptions

string appendSection()

Stop injecting content into a section and append it.

Return Value

string

Exceptions

string yieldContent(string $section, string $default = '')

Get the string contents of a section.

Parameters

string	$section
string	$default

Return Value

string

static string parentPlaceholder(string $section = '')

Get the parent placeholder for the current request.

Parameters

string

$section

Return Value

string

bool hasSection(string $name)

Check if section exists.

Parameters

string

$name

Return Value

bool

mixed getSection(string $name, string $default = null)

Get the contents of a section.

Parameters

string	$name
string	$default

Return Value

mixed

array getSections()

Get the entire array of sections.

Return Value

array

void flushSections()

Flush all of the sections.

Return Value

void

void addLoop(Countable|array $data)

Add new loop to the stack.

Parameters

Countable|array

$data

Return Value

void

void incrementLoopIndices()

Increment the top loop's indices.

Return Value

void

void popLoop()

Pop a loop from the top of the loop stack.

Return Value

void

stdClass|null getLastLoop()

Get an instance of the last loop in the stack.

Return Value

stdClass|null

array getLoopStack()

Get the entire loop stack.

Return Value

array

void startPush(string $section, string $content = '')

Start injecting content into a push section.

Parameters

string	$section
string	$content

Return Value

void

string stopPush()

Stop injecting content into a push section.

Return Value

string

Exceptions

void startPrepend(string $section, string $content = '')

Start prepending content into a push section.

Parameters

string	$section
string	$content

Return Value

void

string stopPrepend()

Stop prepending content into a push section.

Return Value

string

Exceptions

string yieldPushContent(string $section, string $default = '')

Get the string contents of a push section.

Parameters

string	$section
string	$default

Return Value

string

void flushStacks()

Flush all of the stacks.

Return Value

void

void startTranslation(array $replacements = array())

Start a translation block.

Parameters

array

$replacements

Return Value

void

string renderTranslation()

Render the current translation.

Return Value

string

void __construct(EngineResolver $engines, ViewFinderInterface $finder, Dispatcher $events)

Create a new view factory instance.

Parameters

EngineResolver	$engines
ViewFinderInterface	$finder
Dispatcher	$events

Return Value

void

View file(string $path, array $data = array(), array $mergeData = array())

Get the evaluated view contents for the given view.

Parameters

string	$path
array	$data
array	$mergeData

Return Value

View make(string $view, array $data = array(), array $mergeData = array())

Get the evaluated view contents for the given view.

Parameters

string	$view
array	$data
array	$mergeData

Return Value

string renderWhen(bool $condition, string $view, array $data = array(), array $mergeData = array())

Get the rendered content of the view based on a given condition.

Parameters

bool	$condition
string	$view
array	$data
array	$mergeData

Return Value

string

string renderEach(string $view, array $data, string $iterator, string $empty = 'raw|')

Get the rendered contents of a partial from a loop.

Parameters

string	$view
array	$data
string	$iterator
string	$empty

Return Value

string

bool exists(string $view)

Determine if a given view exists.

Parameters

string

$view

Return Value

bool

EngineInterface getEngineFromPath(string $path)

Get the appropriate view engine for the given path.

Parameters

string

$path

Return Value

EngineInterface

Exceptions