root/branches/0.11/src/view/AgaviFileTemplateLayer.class.php

<?php

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2008 the Agavi Project.                                |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+

/**
 * Template layer implementation for templates fetched using a PHP stream.
 *
 * @package    agavi
 * @subpackage view
 *
 * @author     David Zülke <dz@bitxtender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.11.0
 *
 * @version    $Id$
 */
class AgaviFileTemplateLayer extends AgaviStreamTemplateLayer
{
  /**
   * Constructor.
   *
   * @param      array Initial parameters.
   *
   * @author     David Zülke <dz@bitxtender.com>
   * @since      0.11.0
   */
  public function __construct(array $parameters = array())
  {
    $targets = array();
    if(AgaviConfig::get('core.use_translation')) {
      $targets[] = '${directory}/${locale}/${template}${extension}';
      $targets[] = '${directory}/${template}.${locale}${extension}';
    }
    $targets[] = '${directory}/${template}${extension}';
    
    parent::__construct(array_merge(array(
      'directory' => AgaviConfig::get('core.module_dir') . '/${module}/templates',
      'scheme' => 'file',
      'check' => true,
      'targets' => $targets,
    ), $parameters));
  }
  
  /**
   * Get the full, resolved stream location name to the template resource.
   *
   * @return     string A PHP stream resource identifier.
   *
   * @throws     AgaviException If the template could not be found.
   *
   * @author     David Zülke <dz@bitxtender.com>
   * @since      0.11.0
   */
  public function getResourceStreamIdentifier()
  {
    $retval = null;
    $template = $this->getParameter('template');
    
    if($template === null) {
      // no template set, we return null so nothing gets rendered
      return null;
    } elseif(AgaviToolkit::isPathAbsolute($template)) {
      // the template is an absolute path, ignore the dir
      $directory = dirname($template);
      $template = basename($template);
    } else {
      $directory = $this->getParameter('directory');
    }
    // treat the directory as sprintf format string and inject module name
    $directory = AgaviToolkit::expandVariables($directory, array_merge(array_filter($this->getParameters(), 'is_scalar'), array_filter($this->getParameters(), 'is_null')));
    
    $this->setParameter('directory', $directory);
    $this->setParameter('template', $template);
    if(!$this->hasParameter('extension')) {
      $this->setParameter('extension', $this->renderer->getDefaultExtension());
    }
    
    // everything set up for the parent
    return parent::getResourceStreamIdentifier();
  }
}

?>