Class Phalcon\Mvc\View

extends Phalcon\DI\Injectable

implements Phalcon\Events\EventsAwareInterface, Phalcon\DI\InjectionAwareInterface, Phalcon\Mvc\ViewInterface

Phalcon\Mvc\View is a class for working with the “view” portion of the model-view-controller pattern. That is, it exists to help keep the view script separate from the model and controller scripts. It provides a system of helpers, output filters, and variable escaping.

<?php

 //Setting views directory
 $view = new Phalcon\Mvc\View();
 $view->setViewsDir('app/views/');

 $view->start();
 //Shows recent posts view (app/views/posts/recent.phtml)
 $view->render('posts', 'recent');
 $view->finish();

 //Printing views output
 echo $view->getContent();

Constants

integer LEVEL_MAIN_LAYOUT

integer LEVEL_AFTER_TEMPLATE

integer LEVEL_LAYOUT

integer LEVEL_BEFORE_TEMPLATE

integer LEVEL_ACTION_VIEW

integer LEVEL_NO_RENDER

Methods

public __construct ([array $options])

Phalcon\Mvc\View constructor

public setViewsDir (string $viewsDir)

Sets views directory. Depending of your platform, always add a trailing slash or backslash

public string getViewsDir ()

Gets views directory

public setLayoutsDir (string $layoutsDir)

Sets the layouts sub-directory. Must be a directory under the views directory. Depending of your platform, always add a trailing slash or backslash

<?php

 $view->setLayoutsDir('../common/layouts/');

public string getLayoutsDir ()

Gets the current layouts sub-directory

public setPartialsDir (string $partialsDir)

Sets a partials sub-directory. Must be a directory under the views directory. Depending of your platform, always add a trailing slash or backslash

<?php

 $view->setPartialsDir('../common/partials/');

public string getPartialsDir ()

Gets the current partials sub-directory

public setBasePath (string $basePath)

Sets base path. Depending of your platform, always add a trailing slash or backslash

<?php

    $view->setBasePath(__DIR__.'/');

public setRenderLevel (string $level)

Sets the render level for the view

<?php

    //Render the view related to the controller only
    $this->view->setRenderLevel(View::LEVEL_VIEW);

public disableLevel (int|array $level)

Disables a specific level of rendering

<?php

 //Render all levels except ACTION level
 $this->view->disableLevel(View::LEVEL_ACTION_VIEW);

public setMainView (string $viewPath)

Sets default view name. Must be a file without extension in the views directory

<?php

    //Renders as main view views-dir/inicio.phtml
    $this->view->setMainView('inicio');

public string getMainView ()

Returns the name of the main view

public setLayout (string $layout)

Change the layout to be used instead of using the name of the latest controller name

<?php

    $this->view->setLayout('main');

public string getLayout ()

Returns the name of the main view

public setTemplateBefore (string|array $templateBefore)

Appends template before controller layout

public cleanTemplateBefore ()

Resets any template before layouts

public setTemplateAfter (string|array $templateAfter)

Appends template after controller layout

public cleanTemplateAfter ()

Resets any template before layouts

public setParamToView (string $key, mixed $value)

Adds parameters to views (alias of setVar)

<?php

$this->view->setParamToView('products', $products);

public setVars (array $params, [boolean $merge])

Set all the render params

<?php

$this->view->setVars(array('products' => $products));

public setVar (string $key, mixed $value)

Set a single view parameter

<?php

$this->view->setVar('products', $products);

public mixed getVar (string $key)

Returns a parameter previously set in the view

public array getParamsToView ()

Returns parameters to views

public string getControllerName ()

Gets the name of the controller rendered

public string getActionName ()

Gets the name of the action rendered

public array getParams ()

Gets extra parameters of the action rendered

public start ()

Starts rendering process enabling the output buffering

protected array _loadTemplateEngines ()

Loads registered template engines, if none is registered it will use Phalcon\Mvc\View\Engine\Php

protected _engineRender ()

Checks whether view exists on registered extensions and render it

public registerEngines (array $engines)

Register templating engines

<?php

$this->view->registerEngines(array(
  ".phtml" => "Phalcon\Mvc\View\Engine\Php",
  ".volt" => "Phalcon\Mvc\View\Engine\Volt",
  ".mhtml" => "MyCustomEngine"
));

public render (string $controllerName, string $actionName, [array $params])

Executes render process from dispatching data

<?php

 $view->start();
 //Shows recent posts view (app/views/posts/recent.phtml)
 $view->render('posts', 'recent');
 $view->finish();

public pick (string $renderView)

Choose a different view to render instead of last-controller/last-action

<?php

 class ProductsController extends Phalcon\Mvc\Controller
 {

    public function saveAction()
    {

         //Do some save stuff...

         //Then show the list view
         $this->view->pick("products/list");
    }
 }

public string partial (string $partialPath)

Renders a partial view

<?php

    //Show a partial inside another view
    $this->partial('shared/footer');

public string getRender (string $controllerName, string $actionName, [array $params], [mixed $configCallback])

Perform the automatic rendering returning the output as a string

<?php

    $template = $this->view->getRender('products', 'show', array('products' => $products));

public finish ()

Finishes the render process by stopping the output buffering

protected Phalcon\Cache\BackendInterface _createCache ()

Create a Phalcon\Cache based on the internal cache options

public boolean isCaching ()

Check if the component is currently caching the output content

public Phalcon\Cache\BackendInterface getCache ()

Returns the cache instance used to cache

public cache ([boolean|array $options])

Cache the actual view render to certain level

public setContent (string $content)

Externally sets the view content

<?php

$this->view->setContent("<h1>hello</h1>");

public string getContent ()

Returns cached ouput from another view stage

public string getActiveRenderPath ()

Returns the path of the view that is currently rendered

public disable ()

Disables the auto-rendering process

public enable ()

Enables the auto-rendering process

public reset ()

Resets the view component to its factory default values

public __set (string $key, mixed $value)

Magic method to pass variables to the views

<?php

$this->view->products = $products;

public mixed __get (string $key)

Magic method to retrieve a variable passed to the view

<?php

echo $this->view->products;

public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\DI\Injectable

Sets the dependency injector

public Phalcon\DiInterface getDI () inherited from Phalcon\DI\Injectable

Returns the internal dependency injector

public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\DI\Injectable

Sets the event manager

public Phalcon\Events\ManagerInterface getEventsManager () inherited from Phalcon\DI\Injectable

Returns the internal event manager