Browse Source

Better phpdoc for view renderers, composite view renderer

tags/2.0.0-beta
Alexander Makarov 12 years ago
parent
commit
4a78705934
  1. 56
      framework/renderers/CompositeViewRenderer.php
  2. 15
      framework/renderers/SmartyViewRenderer.php
  3. 13
      framework/renderers/TwigViewRenderer.php

56
framework/renderers/CompositeViewRenderer.php

@ -0,0 +1,56 @@
<?php
/**
* Composite view renderer class file.
*
* @link http://www.yiiframework.com/
* @copyright Copyright &copy; 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\renderers;
use Yii;
use yii\base\View;
use yii\base\ViewRenderer;
/**
* CompositeViewRenderer allows you to use multiple view renderers in a single
* application.
*
* @author Alexander Makarov <sam@rmcreative.ru>
* @since 2.0
*/
class CompositeViewRenderer extends ViewRenderer
{
/**
* @var array a config array with the view renderer objects or the configuration arrays for
* creating the view renderers indexed by file extensions.
*/
public $renderers = array();
/**
* Renders a view file.
*
* This method is invoked by [[View]] whenever it tries to render a view.
* Child classes must implement this method to render the given view file.
*
* @param View $view the view object used for rendering the file.
* @param string $file the view file.
* @param array $params the parameters to be passed to the view file.
*
* @return string the rendering result
*/
public function render($view, $file, $params)
{
$ext = pathinfo($file, PATHINFO_EXTENSION);
if($ext === 'php' || !isset($this->renderers[$ext])) {
return $view->renderPhpFile($file, $params);
}
else {
if (is_array($this->renderers[$ext])) {
$this->renderers[$ext] = Yii::createObject($this->renderers[$ext]);
}
return $this->renderers[$ext]->render($view, $file, $params);
}
}
}

15
framework/renderers/SmartyViewRenderer.php

@ -20,9 +20,24 @@ use \yii\base\ViewRenderer;
*/
class SmartyViewRenderer extends ViewRenderer
{
/**
* @var string alias pointing to where Smarty code is located.
*/
public $smartyDir = '@app/vendors/Smarty';
/**
* @var string alias pointing to where Smarty cache will be stored.
*/
public $cacheDir = '@app/runtime/Smarty/cache';
/**
* @var string alias pointing to where Smarty compiled teamplates will be stored.
*/
public $compileDir = '@app/runtime/Smarty/compile';
/**
* @var string file extension to use for template files
*/
public $fileExtension = 'tpl';
/** @var \Smarty */

13
framework/renderers/TwigViewRenderer.php

@ -20,12 +20,23 @@ use \yii\base\ViewRenderer;
*/
class TwigViewRenderer extends ViewRenderer
{
/**
* @var string alias pointing to where Twig code is located.
*/
public $twigDir = '@app/vendors/Twig';
/**
* @var string alias pointing to where Twig cache will be stored.
*/
public $cacheDir = '@app/runtime/Twig/cache';
/**
* @var string file extension to use for template files.
*/
public $fileExtension = 'twig';
/**
* @var array options
* @var array Twig options
* @see http://twig.sensiolabs.org/doc/api.html#environment-options
*/
public $options = array();

Loading…
Cancel
Save