1. class
  2. Illuminate
  3. \
  4. View
  5. \
  6. View

View

class View implements ArrayAccess, View

Properties

protected Factory $factory

The view factory instance.
protected EngineInterface $engine

The engine implementation.
protected string $view

The name of the view.
protected array $data

The array of view data.
protected string $path

The path to the view file.

Methods

void
__construct(Factory $factory, EngineInterface $engine, string $view, string $path, mixed $data = [])

Create a new view instance.

string
render(callable $callback = null)

Get the string contents of the view.

string
renderContents()

Get the contents of the view instance.

string
getContents()

Get the evaluated contents of the view.

array
gatherData()

Get the data bound to the view instance.

array
renderSections()

Get the sections of the rendered view.

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

Add a piece of data to the view.

$this
nest(string $key, string $view, array $data = [])

Add a view instance to the view data.

$this
withErrors(MessageProvider|array $provider)

Add validation errors to the view.

MessageBag
formatErrors(MessageProvider|array $provider)

Format the given message provider into a MessageBag.

string
name()

Get the name of the view.

string
getName()

Get the name of the view.

array
getData()

Get the array of view data.

string
getPath()

Get the path to the view file.

void
setPath(string $path)

Set the path to the view.

Factory
getFactory()

Get the view factory instance.

EngineInterface
getEngine()

Get the view's rendering engine.

bool
offsetExists(string $key)

Determine if a piece of data is bound.

mixed
offsetGet(string $key)

Get a piece of bound data to the view.

void
offsetSet(string $key, mixed $value)

Set a piece of data on the view.

void
offsetUnset(string $key)

Unset a piece of data from the view.

mixed
__get(string $key)

Get a piece of data from the view.

void
__set(string $key, mixed $value)

Set a piece of data on the view.

bool
__isset(string $key)

Check if a piece of data is bound to the view.

bool
__unset(string $key)

Remove a piece of bound data from the view.

View
__call(string $method, array $parameters)

Dynamically bind parameters to the view.

string
__toString()

Get the string contents of the view.

Details

at line 64
void __construct(Factory $factory, EngineInterface $engine, string $view, string $path, mixed $data = [])

Create a new view instance.

Parameters

Factory $factory
EngineInterface $engine
string $view
string $path
mixed $data

Return Value

void

at line 82
string render(callable $callback = null)

Get the string contents of the view.

Parameters

callable $callback

Return Value

string

Exceptions

Throwable

at line 111
protected string renderContents()

Get the contents of the view instance.

Return Value

string

at line 135
protected string getContents()

Get the evaluated contents of the view.

Return Value

string

at line 145
protected array gatherData()

Get the data bound to the view instance.

Return Value

array

at line 163
array renderSections()

Get the sections of the rendered view.

Return Value

array

at line 177
$this with(string|array $key, mixed $value = null)

Add a piece of data to the view.

Parameters

string|array $key
mixed $value

Return Value

$this

at line 196
$this nest(string $key, string $view, array $data = [])

Add a view instance to the view data.

Parameters

string $key
string $view
array $data

Return Value

$this

at line 207
$this withErrors(MessageProvider|array $provider)

Add validation errors to the view.

Parameters

MessageProvider|array $provider

Return Value

$this

at line 220
protected MessageBag formatErrors(MessageProvider|array $provider)

Format the given message provider into a MessageBag.

Parameters

MessageProvider|array $provider

Return Value

MessageBag

at line 231
string name()

Get the name of the view.

Return Value

string

at line 241
string getName()

Get the name of the view.

Return Value

string

at line 251
array getData()

Get the array of view data.

Return Value

array

at line 261
string getPath()

Get the path to the view file.

Return Value

string

at line 272
void setPath(string $path)

Set the path to the view.

Parameters

string $path

Return Value

void

at line 282
Factory getFactory()

Get the view factory instance.

Return Value

Factory

at line 292
EngineInterface getEngine()

Get the view's rendering engine.

Return Value

EngineInterface

at line 303
bool offsetExists(string $key)

Determine if a piece of data is bound.

Parameters

string $key

Return Value

bool

at line 314
mixed offsetGet(string $key)

Get a piece of bound data to the view.

Parameters

string $key

Return Value

mixed

at line 326
void offsetSet(string $key, mixed $value)

Set a piece of data on the view.

Parameters

string $key
mixed $value

Return Value

void

at line 337
void offsetUnset(string $key)

Unset a piece of data from the view.

Parameters

string $key

Return Value

void

at line 348
mixed __get(string $key)

Get a piece of data from the view.

Parameters

string $key

Return Value

mixed

at line 360
void __set(string $key, mixed $value)

Set a piece of data on the view.

Parameters

string $key
mixed $value

Return Value

void

at line 371
bool __isset(string $key)

Check if a piece of data is bound to the view.

Parameters

string $key

Return Value

bool

at line 382
bool __unset(string $key)

Remove a piece of bound data from the view.

Parameters

string $key

Return Value

bool

at line 396
View __call(string $method, array $parameters)

Dynamically bind parameters to the view.

Parameters

string $method
array $parameters

Return Value

View

Exceptions

BadMethodCallException

at line 410
string __toString()

Get the string contents of the view.

Return Value

string