• Home
• lithium
• template
• View

PHP Class lithium\template\View

The View class interacts with a variety of other classes in order to achieve maximum flexibility and configurability at all points in the view rendering and presentation process. The Loader class is tasked with locating and reading template files which are then passed to the Renderer adapter subclass. In the default configuration, the File adapter acts as both renderer and loader, loading files from paths defined in _process steps_ (described below) and rendering them as plain PHP files, augmented with special syntax. The View class operates on _processes_, which define the steps to render a completed view. For example, the default process, which renders a template wrapped in a layout, is comprised of two _steps_: the first step renders the main template and captures it to the rendering context, where it is embedded in the layout in the second step. See the $_steps and $_processes properties for more information. Using steps and processes, you can create rendering scenarios to suit very complex needs. By default, the View class is called during the course of the framework's dispatch cycle by the Media class. However, it is also possible to instantiate and call View directly, in cases where you wish to bypass all other parts of the framework and simply return rendered content. A simple example, using the Simple renderer/loader for string templates: {{{ $view = new View(array('loader' => 'Simple', 'renderer' => 'Simple')); echo $view->render('element', array('name' => "Robert"), array('element' => 'Hello, {:name}!')); Output: "Hello, Robert!"; }}} _Note_: This is easily adapted for XML templating. Another example, this time of something that could be used in an appliation error handler: {{{ $view = new View(array( 'paths' => array( 'template' => '{:library}/views/errors/{:template}.{:type}.php', 'layout' => '{:library}/views/layouts/{:layout}.{:type}.php', ) )); $page = $View->render('all', array('content' => $info), array( 'template' => '404', 'layout' => 'error' )); }}} To learn more about processes and process steps, see the $_processes and $_steps properties, respectively. Show file Open project: unionofrad/lithium Class Usage Examples

Public Properties

Property	Type	Description
$outputFilters		Output filters for view rendering.

Protected Properties

Property	Type	Description
$_adapters	string	Path used to look up view loading and rendering adapters.
$_autoConfig		Auto-configuration parameters.
$_loader		The object responsible for loading template files.
$_processes	array	For example, the default process, 'all', renders a template, then renders a layout, using the rendered template content. A process can be defined using one or more steps defined in the $_steps property. Each process definition is a simple array of ordered values, where each value is a key in the $_steps array.
$_renderer		Object responsible for rendering output.
$_request		Holds the details of the current request that originated the call to this view, if applicable. May be empty if this does not apply. For example, if the View class is created to render an email.
$_response		Holds a reference to the Response object that will be returned at the end of the current dispatch cycle. Allows headers and other response attributes to be assigned in the templating layer.
$_steps	array	Each step is named by its key in the $_steps array, and can have the following options: - 'path' _string_: Indicates the set of paths to use when loading templates. - 'conditions' _mixed_: Make the step dependent on a value being present, or on some other arbitrary condition. If a 'conditions' is a string, it indicates that a key with that name must be present in the $options passed to render(), and must be set to a non-empty value. If a closure, it will be executed with the rendering parameters, and must return true or false. In either case, if the condition is satisfied, the step is processed. Otherwise, it is skipped. See the _conditions() method for more information. - 'capture' _array_: If specified, allows the results of this rendering step to be assigned to a template variable used in subsequent steps, or to the templating context for use in subsequent steps. If can be specified in the form of array('context' => '') or array('data' => ''). If the 'context' key is used, the results are captured to the rendering context. Likewise with the 'data' key, results are captured to a template variable. - 'multi' _boolean_: If set to true, the rendering parameter matching the name of this step can be an array containing multiple values, in which case this step is executed multiple times, once for each value of the array.

Public Methods

Method	Description
__construct ( array $config = [] ) : void	Constructor.
render ( string $process, array $data = [], array $options = [] ) : string	Executes a named rendering process by running each process step in sequence and aggregating the results. The View class comes with 3 built-in processes: 'all', 'template', and 'element'. The 'all' process is the default two-step rendered view, where a template is wrapped in a layout containing a header and footer.

Protected Methods

Method	Description
_conditions ( array $step, array $params, array $data, array $options ) : boolean	Evaluates a step condition to determine if the step should be executed.
_convertSteps ( array $command, array &$params, array $defaults ) : array	Handles API backward compatibility by converting an array-based rendering instruction passed to render() as a process, to a set of rendering steps, rewriting any associated rendering parameters as necessary.
_init ( ) : void	Perform initialization of the View.
_process ( string $process, array &$params ) : array	Converts a process name to an array containing the rendering steps to be executed for each process.
_step ( array $step, array $params, array &$data, array &$options = [] ) : string	Performs a rendering step.

Method Details

Property Details