ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]
Packages:
ForwardFW

Source for file Templater.php

Documentation is available at Templater.php

  1. <?php
  2. declare(encoding = "utf-8");
  3. /**
  4.  * This file is part of ForwardFW a web application framework.
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2.1 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public
  17.  * License along with this library; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  *
  20.  * PHP version 5
  21.  *
  22.  * @category   Templater
  23.  * @package    ForwardFW
  24.  * @subpackage Interface
  25.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  26.  * @copyright  2009,2010 The Authors
  27.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  28.  * @version    SVN: $Id: $
  29.  * @link       http://forwardfw.sourceforge.net
  30.  * @since      File available since Release 0.0.2
  31.  */
  32.  
  33. /**
  34.  *
  35.  */
  36.  
  37. /**
  38.  * Interface for a Templater.
  39.  *
  40.  * @category   Templater
  41.  * @package    ForwardFW
  42.  * @subpackage Interface
  43.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  44.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  45.  * @link       http://forwardfw.sourceforge.net
  46.  */
  47. interface ForwardFW_Interface_Templater
  48. {
  49.     /**
  50.      * Constructor
  51.      *
  52.      * @param ForwardFW_Interface_Application $application The running application
  53.      *
  54.      * @return void 
  55.      */
  56.     public function __construct(
  57.         ForwardFW_Interface_Application $application
  58.     );
  59.  
  60.     /**
  61.      * Sets file to use for templating
  62.      *
  63.      * @param string $_strFile Complete path and filename.
  64.      *
  65.      * @return ForwardFW_Interface_Templater The instance.
  66.      */
  67.     public function setTemplateFile($_strFile);
  68.  
  69.     /**
  70.      * Sets a var in the template to a value
  71.      *
  72.      * @param string $_strName Name of template var.
  73.      * @param mixed  $_mValue  Value of template var.
  74.      *
  75.      * @return ForwardFW_Interface_Templater The instance.
  76.      */
  77.     public function setVar($_strName, $_mValue);
  78.  
  79.     /**
  80.      * Returns compiled template for outputing.
  81.      *
  82.      * @return string Content of template after compiling.
  83.      */
  84.     public function getCompiled();
  85.  
  86.     public function defineBlock($strBlockName);
  87.  
  88.     public function showBlock($strBlockName);
  89.  
  90.     public function hideBlock($strBlockName);
  91.  
  92. }
  93. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:47 +0100 by phpDocumentor 1.4.3