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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 <?php
/**
* TfishTemplate class file.
*
* @copyright Simon Wilkinson 2013-2017 (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 content
*/
// Enable strict type declaration.
declare(strict_types=1);
if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");
/**
* Tuskfish template object.
*
* Used to hold template variables and to render templates for display. A template object is
* automatically made available on every page via tfish_header.php.
*
* @copyright Simon Wilkinson 2013-2017 (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 content
* @property string $theme The theme (template set) in use on this page.
*/
class TfishTemplate
{
/** @var array $__data Array holding values of this object's properties. */
protected $__data = array(
'theme' => 'default'
);
/**
* Get the value of a property.
*
* Intercepts direct calls to access an object property. This method can be modified to impose
* processing logic to the value before returning it.
*
* @param string $property Name of Property.
* @return mixed|null $property Value of property if it is set; otherwise null.
*/
public function __get(string $property)
{
$clean_property = TfishFilter::trimString($property);
if (isset($this->__data[$clean_property])) {
return $this->__data[$clean_property];
} else {
return null;
}
}
/**
* Check if a property is set.
*
* Intercepts isset() calls to correctly read object properties. Can be modified to add
* processing logic to specific properties.
*
* @param string $property Name of property.
* @return bool True if set, otherwise false.
*/
public function __isset(string $property)
{
$clean_property = TfishFilter::trimString($property);
if (isset($this->__data[$clean_property])) {
return true;
} else {
return false;
}
}
/**
* 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)
{
$template = TfishFilter::trimString($template);
// Check for directory traversals and null byte injection.
if (TfishFilter::hasTraversalorNullByte($template)) {
trigger_error(TFISH_ERROR_TRAVERSAL_OR_NULL_BYTE, E_USER_ERROR);
}
extract($this->__data);
if (file_exists(TFISH_THEMES_PATH . $this->__data['theme'] . '/' . $template
. '.html')) {
ob_start();
include TFISH_THEMES_PATH . $this->__data['theme'] . '/' . $template
. '.html';
return ob_get_clean();
} else {
echo $this->__data['theme'] . '/' . $template . '.html'; // Helps debug.
trigger_error(TFISH_ERROR_TEMPLATE_DOES_NOT_EXIST, E_USER_ERROR);
}
}
/**
* Set the value of an object property.
*
* Do not declare variables named $theme or it will disrupt this method.
*
* @param string $property Name of property.
* @param mixed $value Value to assign to property.
*/
public function __set(string $property, $value)
{
$clean_property = TfishFilter::trimString($property);
if ($clean_property === 'theme') {
$this->setTheme($value);
return;
}
$this->__data[$clean_property] = $value;
}
/**
* 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 $tfish_template->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 (TfishFilter::hasTraversalorNullByte($theme)) {
trigger_error(TFISH_ERROR_TRAVERSAL_OR_NULL_BYTE, E_USER_ERROR);
}
if (TfishFilter::isAlnumUnderscore($theme)) {
$clean_theme = TfishFilter::trimString($theme);
$this->__data['theme'] = $clean_theme;
}
}
/**
* Unsets an object property.
*
* Intercepts unset() calls to correctly unset object properties. Can be modified to add
* processing logic for specific properties.
*
* @param string $property Name of property.
* @return bool True on success, false on failure.
*/
public function __unset(string $property)
{
$clean_property = TfishFilter::trimString($property);
if (isset($this->__data[$clean_property])) {
unset($this->__data[$clean_property]);
return true;
} else {
return false;
}
}
}