1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 <?php
/**
* TfTemplate class file.
*
* @copyright Simon Wilkinson 2013+ (https://tuskfish.biz)
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Simon Wilkinson <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package core
*/
// Enable strict type declaration.
declare(strict_types=1);
if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");
/**
* Used to hold variables that will be inserted into templates and to render templates for display.
*
* A template object is automatically made available on every page via tfHeader.php.
*
* @copyright Simon Wilkinson 2013+ (https://tuskfish.biz)
* @license https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html GNU General Public License (GPL) V2
* @author Simon Wilkinson <[email protected]>
* @version Release: 1.0
* @since 1.0
* @package core
* @var TfValidator $tfValidator Instance of the Tuskfish data validator class.
* @var string $theme The theme (template set) in use on this page.
*/
class TfTemplate
{
// Note that the data validator is *required* to escape data within the scope of templates.
protected $tfValidator;
protected $theme = 'default';
/**
* Constructor.
*
* @param TfValidator $validator An instance of the Tuskfish data validator class.
*/
public function __construct(TfValidator $validator)
{
if (is_a($validator, 'TfValidator')) {
$this->tfValidator = $validator;
} else {
trigger_error(TFISH_ERROR_NOT_VALIDATOR, E_USER_ERROR);
}
}
/**
* Retrieve the name of the theme in use on this page.
*
* @return string Returns the the name of the theme in use.
*/
public function getTheme()
{
if (isset($this->theme)) {
return $this->theme;
} else {
return 'default';
}
}
/**
* Renders a HTML template file for display.
*
* Extracts all properties assigned to the template object as variables and includes the
* designated template file. The extracted variables are used to populate the dynamic sections
* of the template. Templates can be nested by assigning a rendered child template as a property
* of a parent template object.
*
* @param string $template Name of the template file in the /themes/sometemplate directory.
* @return string Rendered HTML template.
*/
public function render(string $template)
{
// Make the data validator available within scope of the templates.
$tfValidator = $this->tfValidator;
$template = $this->tfValidator->trimString($template);
// Check for directory traversals and null byte injection.
if ($this->tfValidator->hasTraversalorNullByte($template)) {
trigger_error(TFISH_ERROR_TRAVERSAL_OR_NULL_BYTE, E_USER_ERROR);
}
extract((array) $this);
if (file_exists(TFISH_THEMES_PATH . $this->theme . '/' . $template
. '.html')) {
ob_start();
include TFISH_THEMES_PATH . $this->theme . '/' . $template
. '.html';
return ob_get_clean();
} else {
echo $this->theme . '/' . $template . '.html'; // Helps debug.
trigger_error(TFISH_ERROR_TEMPLATE_DOES_NOT_EXIST, E_USER_ERROR);
}
}
/**
* Set the theme (template set) to be used.
*
* The theme must be specified through this method. This is a safety measure to prevent
* someone accidentally overwriting the template set when assigning a variable to the template
* object (if content were assigned to $tfTemplate->setTheme() it would mess things up).
*
* @param string $theme Name of theme (alphanumeric and underscore characters only).
*/
public function setTheme(string $theme)
{
// Check for directory traversals and null byte injection.
if ($this->tfValidator->hasTraversalorNullByte($theme)) {
trigger_error(TFISH_ERROR_TRAVERSAL_OR_NULL_BYTE, E_USER_ERROR);
}
if ($this->tfValidator->isAlnumUnderscore($theme)) {
$clean_theme = $this->tfValidator->trimString($theme);
$this->theme = $clean_theme;
}
}
}