View
class View implements ArrayAccess, Htmlable, Stringable, View (View source)
Traits
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
Mix another object into the class.
Dynamically handle calls to the class.
Create a new view instance.
Get the evaluated contents of a given fragment.
Get the evaluated contents for a given array of fragments or return all fragments.
Get the evaluated contents of a given fragment if the given condition is true.
Get the evaluated contents for a given array of fragments if the given condition is true.
Get all fragments as a single string.
Get the string contents of the view.
Get the contents of the view instance.
Get the evaluated contents of the view.
Get the data bound to the view instance.
Get the sections of the rendered view.
Add a piece of data to the view.
Add a view instance to the view data.
Add validation errors to the view.
Parse the given errors into an appropriate value.
Get the name of the view.
Get the name of the view.
Get the array of view data.
Get the path to the view file.
Set the path to the view.
Get the view factory instance.
Determine if a piece of data is bound.
Get a piece of bound data to the view.
Set a piece of data on the view.
Unset a piece of data from the view.
Get a piece of data from the view.
Set a piece of data on the view.
Check if a piece of data is bound to the view.
Remove a piece of bound data from the view.
Get content as a string of HTML.
Get the string contents of the view.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
View
__call(string $method, array $parameters)
Dynamically bind parameters to the view.
void
__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.
protected string
allFragments()
Get all fragments as a single string.
string
render(callable|null $callback = null)
Get the string contents of the view.
protected string
renderContents()
Get the contents of the view instance.
protected 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, string $bag = 'default')
Add validation errors to the view.
protected 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.