Factory
class Factory (View source)
Properties
| protected EngineResolver | $engines | The engine implementation. |
|
| protected ViewFinderInterface | $finder | The view finder implementation. |
|
| protected Dispatcher | $events | The event dispatcher instance. |
|
| protected Container | $container | The IoC container instance. |
|
| protected array | $shared | Data that should be available to all templates. |
|
| protected array | $aliases | Array of registered view name aliases. |
|
| protected array | $names | All of the registered view names. |
|
| protected array | $extensions | The extension to engine bindings. |
|
| protected array | $composers | The view composer events. |
|
| protected array | $sections | All of the finished, captured sections. |
|
| protected array | $sectionStack | The stack of in-progress sections. |
|
| protected int | $renderCount | The number of active rendering operations. |
Methods
Create a new view factory instance.
Get the evaluated view contents for the given view.
Parse the given data into a raw array.
Register a named view.
Add an alias for a view.
Determine if a given view exists.
Get the rendered contents of a partial from a loop.
Get the appropriate view engine for the given path.
Get the extension used by the view file.
Add a piece of shared data to the environment.
Register multiple view composers via an array.
Add an event for a given view.
Register a class based view composer.
Add a listener to the event dispatcher.
Build a class based container callback Closure.
Parse a class based composer name.
Start injecting content into a section.
Inject inline content into a section.
Stop injecting content into a section and return its contents.
Stop injecting content into a section.
Stop injecting content into a section and append it.
Append content to a given section.
Get the string contents of a section.
Flush all of the section contents.
Flush all of the section contents if done rendering.
Increment the rendering counter.
Decrement the rendering counter.
Check if there are no active render operations.
Add a location to the array of view locations.
Add a new namespace to the loader.
Prepend a new namespace to the loader.
Register a valid view extension and its engine.
Get the extension to engine bindings.
Get the engine resolver instance.
Get the view finder instance.
Get the event dispatcher instance.
Get the IoC container instance.
Get an item from the shared data.
Get all of the shared data for the environment.
Get the entire array of sections.
Get all of the registered named views in environment.
Details
void
__construct(EngineResolver $engines, ViewFinderInterface $finder, Dispatcher $events)
Create a new view factory instance.
View
make(string $view, array $data = array(), array $mergeData = array())
Get the evaluated view contents for the given view.
protected array
parseData(mixed $data)
Parse the given data into a raw array.
View
of(string $view, mixed $data = array())
Get the evaluated view contents for a named view.
void
name(string $view, string $name)
Register a named view.
void
alias(string $view, string $alias)
Add an alias for a view.
bool
exists(string $view)
Determine if a given view exists.
string
renderEach(string $view, array $data, string $iterator, string $empty = 'raw|')
Get the rendered contents of a partial from a loop.
EngineInterface
getEngineFromPath(string $path)
Get the appropriate view engine for the given path.
protected string
getExtension(string $path)
Get the extension used by the view file.
void
share(string $key, mixed $value = null)
Add a piece of shared data to the environment.
array
creator(array|string $views, Closure|string $callback)
Register a view creator event.
array
composers(array $composers)
Register multiple view composers via an array.
array
composer(array|string $views, Closure|string $callback, int|null $priority = null)
Register a view composer event.
protected Closure
addViewEvent(string $view, Closure|string $callback, string $prefix = 'composing: ', int|null $priority = null)
Add an event for a given view.
protected Closure
addClassEvent(string $view, string $class, string $prefix, int|null $priority = null)
Register a class based view composer.
protected void
addEventListener(string $name, Closure $callback, int $priority = null)
Add a listener to the event dispatcher.
protected Closure
buildClassEventCallback(string $class, string $prefix)
Build a class based container callback Closure.
protected array
parseClassEvent(string $class, string $prefix)
Parse a class based composer name.
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 $content = '')
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.
protected void
extendSection(string $section, string $content)
Append content to a given section.
string
yieldContent(string $section, string $default = '')
Get the string contents of a section.
void
flushSections()
Flush all of the section contents.
void
flushSectionsIfDoneRendering()
Flush all of the section contents if done rendering.
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.
void
addNamespace(string $namespace, string|array $hints)
Add a new namespace to the loader.
void
prependNamespace(string $namespace, string|array $hints)
Prepend a new namespace to the loader.
void
addExtension(string $extension, string $engine, Closure $resolver = null)
Register a valid view extension and its engine.
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.
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.
array
getSections()
Get the entire array of sections.
array
getNames()
Get all of the registered named views in environment.