interface/modules/zend_modules/library/Zend/View/Renderer/RendererInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\View\Renderer;
  11
  12 use Zend\View\Model\ModelInterface;
  13 use Zend\View\Resolver\ResolverInterface;
  14
  15 /**
  16  * Interface class for Zend\View\Renderer\* compatible template engine implementations
  17  */
  18 interface RendererInterface
  19 {
  20     /**
  21      * Return the template engine object, if any
  22      *
  23      * If using a third-party template engine, such as Smarty, patTemplate,
  24      * phplib, etc, return the template engine object. Useful for calling
  25      * methods on these objects, such as for setting filters, modifiers, etc.
  26      *
  27      * @return mixed
  28      */
  29     public function getEngine();
  30
  31     /**
  32      * Set the resolver used to map a template name to a resource the renderer may consume.
  33      *
  34      * @param  ResolverInterface $resolver
  35      * @return RendererInterface
  36      */
  37     public function setResolver(ResolverInterface $resolver);
  38
  39     /**
  40      * Processes a view script and returns the output.
  41      *
  42      * @param  string|ModelInterface   $nameOrModel The script/resource process, or a view model
  43      * @param  null|array|\ArrayAccess $values      Values to use during rendering
  44      * @return string The script output.
  45      */
  46     public function render($nameOrModel, $values = null);
  47 }