W3cubDocs

/Laravel 5.1

Factory

class Factory implements Factory (View source)

Methods

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.

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.

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.

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.

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.

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.

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

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

View

View of( string $view, mixed $data = array())

Get the evaluated view contents for a named view.

Parameters

string $view
mixed $data

Return Value

View

void name( string $view, string $name)

Register a named view.

Parameters

string $view
string $name

Return Value

void

void alias( string $view, string $alias)

Add an alias for a view.

Parameters

string $view
string $alias

Return Value

void

bool exists( string $view)

Determine if a given view exists.

Parameters

string $view

Return Value

bool

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

EngineInterface getEngineFromPath( string $path)

Get the appropriate view engine for the given path.

Parameters

string $path

Return Value

EngineInterface

Exceptions

InvalidArgumentException

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

Add a piece of shared data to the environment.

Parameters

array|string $key
mixed $value

Return Value

mixed

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

Register a view creator event.

Parameters

array|string $views
Closure|string $callback

Return Value

array

array composers( array $composers)

Register multiple view composers via an array.

Parameters

array $composers

Return Value

array

array composer( array|string $views, Closure|string $callback, int|null $priority = null)

Register a view composer event.

Parameters

array|string $views
Closure|string $callback
int|null $priority

Return Value

array

void callComposer( View $view)

Call the composer for a given view.

Parameters

View $view

Return Value

void

void callCreator( View $view)

Call the creator for a given view.

Parameters

View $view

Return Value

void

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

Start injecting content into a section.

Parameters

string $section
string $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

InvalidArgumentException

string appendSection()

Stop injecting content into a section and append it.

Return Value

string

Exceptions

InvalidArgumentException

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

Get the string contents of a section.

Parameters

string $section
string $default

Return Value

string

void flushSections()

Flush all of the section contents.

Return Value

void

void flushSectionsIfDoneRendering()

Flush all of the section contents if done rendering.

Return Value

void

void incrementRender()

Increment the rendering counter.

Return Value

void

void decrementRender()

Decrement the rendering counter.

Return Value

void

bool doneRendering()

Check if there are no active render operations.

Return Value

bool

void addLocation( string $location)

Add a location to the array of view locations.

Parameters

string $location

Return Value

void

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

Add a new namespace to the loader.

Parameters

string $namespace
string|array $hints

Return Value

void

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

Prepend a new namespace to the loader.

Parameters

string $namespace
string|array $hints

Return Value

void

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

Register a valid view extension and its engine.

Parameters

string $extension
string $engine
Closure $resolver

Return Value

void

array getExtensions()

Get the extension to engine bindings.

Return Value

array

EngineResolver getEngineResolver()

Get the engine resolver instance.

Return Value

EngineResolver

ViewFinderInterface getFinder()

Get the view finder instance.

Return Value

ViewFinderInterface

void setFinder( ViewFinderInterface $finder)

Set the view finder instance.

Parameters

ViewFinderInterface $finder

Return Value

void

Dispatcher getDispatcher()

Get the event dispatcher instance.

Return Value

Dispatcher

void setDispatcher( Dispatcher $events)

Set the event dispatcher instance.

Parameters

Dispatcher $events

Return Value

void

Container getContainer()

Get the IoC container instance.

Return Value

Container

void setContainer( Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

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

Get an item from the shared data.

Parameters

string $key
mixed $default

Return Value

mixed

array getShared()

Get all of the shared data for the environment.

Return Value

array

bool hasSection( string $name)

Check if section exists.

Parameters

string $name

Return Value

bool

array getSections()

Get the entire array of sections.

Return Value

array

array getNames()

Get all of the registered named views in environment.

Return Value

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/View/Factory.html