Factory
class Factory implements 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 array | $loopsStack | The stack of in-progress loops. | |
| protected array | $pushes | All of the finished, captured push sections. | |
| protected array | $pushStack | The stack of in-progress push sections. | |
| protected int | $renderCount | The number of active rendering operations. |
Methods
| void | __construct(EngineResolver $engines, ViewFinderInterface $finder, Dispatcher $events) Create a new view factory instance. | |
| View | file(string $path, array $data = [], array $mergeData = []) Get the evaluated view contents for the given view. | |
| View | make(string $view, array $data = [], array $mergeData = []) Get the evaluated view contents for the given view. | |
| string | normalizeName(string $name) Normalize a view name. | |
| array | parseData(mixed $data) Parse the given data into a raw array. | |
| View | of(string $view, mixed $data = []) 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. | |
| string | getExtension(string $path) Get the extension used by the view file. | |
| mixed | share(array|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. | |
| Closure|null | addViewEvent(string $view, Closure|string $callback, string $prefix = 'composing: ', int|null $priority = null) Add an event for a given view. | |
| Closure | addClassEvent(string $view, string $class, string $prefix, int|null $priority = null) Register a class based view composer. | |
| void | addEventListener(string $name, Closure $callback, int|null $priority = null) Add a listener to the event dispatcher. | |
| Closure | buildClassEventCallback(string $class, string $prefix) Build a class based container callback Closure. | |
| 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. | |
| 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 | startPush(string $section, string $content = '') Start injecting content into a push section. | |
| string | stopPush() Stop injecting content into a push section. | |
| void | extendPush(string $section, string $content) Append content to a given push section. | |
| string | yieldPushContent(string $section, string $default = '') Get the string contents of a push 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 | 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. | |
| array | getFirstLoop() Get an instance of the first loop in the stack. | |
| array | getLoopStack() Get the entire loop stack. | |
| 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. | |
| bool | hasSection(string $name) Check if section exists. | |
| array | getSections() Get the entire array of sections. | |
| array | getNames() 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 file(string $path, array $data = [], array $mergeData = [])
Get the evaluated view contents for the given view.
View make(string $view, array $data = [], array $mergeData = [])
Get the evaluated view contents for the given view.
protected string normalizeName(string $name)
Normalize a view name.
protected array parseData(mixed $data)
Parse the given data into a raw array.
View of(string $view, mixed $data = [])
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.
mixed share(array|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|null 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|null $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 startPush(string $section, string $content = '')
Start injecting content into a push section.
string stopPush()
Stop injecting content into a push section.
protected void extendPush(string $section, string $content)
Append content to a given push section.
string yieldPushContent(string $section, string $default = '')
Get the string contents of a push 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 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.
array getFirstLoop()
Get an instance of the first loop in the stack.
array getLoopStack()
Get the entire loop stack.
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.
bool hasSection(string $name)
Check if section exists.
array getSections()
Get the entire array of sections.
array getNames()
Get all of the registered named views in environment.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/View/Factory.html