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

View

class View implements ArrayAccess, Htmlable, Stringable, View (View source)

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected Factory $factory

The view factory instance.
protected Engine $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

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
View
__call(string $method, array $parameters)

Dynamically bind parameters to the view.

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

Create a new view instance.

string
fragment(string $fragment)

Get the evaluated contents of a given fragment.

string
fragments(array|null $fragments = null)

Get the evaluated contents for a given array of fragments or return all fragments.

string
fragmentIf(bool $boolean, string $fragment)

Get the evaluated contents of a given fragment if the given condition is true.

string
fragmentsIf(bool $boolean, array|null $fragments = null)

Get the evaluated contents for a given array of fragments if the given condition is true.

string
allFragments()

Get all fragments as a single string.

string
render(callable|null $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|string $provider, string $bag = 'default')

Add validation errors to the view.

MessageBag
formatErrors(MessageProvider|array|string $provider)

Parse the given errors into an appropriate value.

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.

Engine
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.

void
__unset(string $key)

Remove a piece of bound data from the view.

string
toHtml()

Get content as a string of HTML.

string
__toString()

Get the string contents of the view.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Dynamically bind parameters to the view.

Parameters

string $method
array $parameters

Return Value

View

Exceptions

BadMethodCallException

at line 71
__construct(Factory $factory, Engine $engine, string $view, string $path, mixed $data = [])

Create a new view instance.

Parameters

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

at line 87
string fragment(string $fragment)

Get the evaluated contents of a given fragment.

Parameters

string $fragment

Return Value

string

at line 100
string fragments(array|null $fragments = null)

Get the evaluated contents for a given array of fragments or return all fragments.

Parameters

array|null $fragments

Return Value

string

at line 114
string fragmentIf(bool $boolean, string $fragment)

Get the evaluated contents of a given fragment if the given condition is true.

Parameters

bool $boolean
string $fragment

Return Value

string

at line 130
string fragmentsIf(bool $boolean, array|null $fragments = null)

Get the evaluated contents for a given array of fragments if the given condition is true.

Parameters

bool $boolean
array|null $fragments

Return Value

string

at line 144
protected string allFragments()

Get all fragments as a single string.

Return Value

string

at line 157
string render(callable|null $callback = null)

Get the string contents of the view.

Parameters

callable|null $callback

Return Value

string

Exceptions

Throwable

at line 182
protected string renderContents()

Get the contents of the view instance.

Return Value

string

at line 206
protected string getContents()

Get the evaluated contents of the view.

Return Value

string

at line 216
array gatherData()

Get the data bound to the view instance.

Return Value

array

at line 236
array renderSections()

Get the sections of the rendered view.

Return Value

array

Exceptions

Throwable

at line 250
$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 269
$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 281
$this withErrors(MessageProvider|array|string $provider, string $bag = 'default')

Add validation errors to the view.

Parameters

MessageProvider|array|string $provider
string $bag

Return Value

$this

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

Parse the given errors into an appropriate value.

Parameters

MessageProvider|array|string $provider

Return Value

MessageBag

at line 306
string name()

Get the name of the view.

Return Value

string

at line 316
string getName()

Get the name of the view.

Return Value

string

at line 326
array getData()

Get the array of view data.

Return Value

array

at line 336
string getPath()

Get the path to the view file.

Return Value

string

at line 347
void setPath(string $path)

Set the path to the view.

Parameters

string $path

Return Value

void

at line 357
Factory getFactory()

Get the view factory instance.

Return Value

Factory

at line 367
Engine getEngine()

Get the view's rendering engine.

Return Value

Engine

at line 378
bool offsetExists(string $key)

Determine if a piece of data is bound.

Parameters

string $key

Return Value

bool

at line 389
mixed offsetGet(string $key)

Get a piece of bound data to the view.

Parameters

string $key

Return Value

mixed

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

Set a piece of data on the view.

Parameters

string $key
mixed $value

Return Value

void

at line 412
void offsetUnset(string $key)

Unset a piece of data from the view.

Parameters

string $key

Return Value

void

at line 423
mixed __get(string $key)

Get a piece of data from the view.

Parameters

string $key

Return Value

mixed

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

Set a piece of data on the view.

Parameters

string $key
mixed $value

Return Value

void

at line 446
bool __isset(string $key)

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

Parameters

string $key

Return Value

bool

at line 457
void __unset(string $key)

Remove a piece of bound data from the view.

Parameters

string $key

Return Value

void

at line 491
string toHtml()

Get content as a string of HTML.

Return Value

string

at line 503
string __toString()

Get the string contents of the view.

Return Value

string

Exceptions

Throwable