Documentation

HandlesDefaultLayout

Default-layout management for Response.

Resolution order used by Response::render() when no explicit layout is passed to render():

  1. top of the per-instance stack (setDefaultLayout / pushDefaultLayout)
  2. top of the request-wide stack (setGlobalDefaultLayout / pushGlobalDefaultLayout)
  3. framework default ("layout/default_layout.php")

Both scopes expose a set* (clear + push), push* and pop* so a "part of the app" - admin area, nested component - can install its own default and restore the previous one when done.

Table of Contents

$globalDefaultLayoutStack  : array<string|int, mixed>
$instanceDefaultLayoutStack  : array<string|int, mixed>
popDefaultLayout()  : string
popGlobalDefaultLayout()  : string
pushDefaultLayout()  : void
pushGlobalDefaultLayout()  : void
setDefaultLayout()  : void
setGlobalDefaultLayout()  : void
resolveDefaultLayout()  : string

Properties

$globalDefaultLayoutStack

private static array<string|int, mixed> $globalDefaultLayoutStack = []

$instanceDefaultLayoutStack

private array<string|int, mixed> $instanceDefaultLayoutStack = []

Methods

popGlobalDefaultLayout()

public static popGlobalDefaultLayout() : string
Return values
string

pushDefaultLayout()

public pushDefaultLayout(string $layout) : void
Parameters
$layout : string
Return values
void

pushGlobalDefaultLayout()

public static pushGlobalDefaultLayout(string $layout) : void
Parameters
$layout : string
Return values
void

setDefaultLayout()

public setDefaultLayout(string $layout) : void
Parameters
$layout : string
Return values
void

setGlobalDefaultLayout()

public static setGlobalDefaultLayout(string $layout) : void
Parameters
$layout : string
Return values
void

resolveDefaultLayout()

protected resolveDefaultLayout() : string
Return values
string

Search results