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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 <?php
/**
* TfMetadata 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");
/**
* Provides page-level metadata.
*
* User-facing controller scripts can override the site-level defaults by uncommenting the options
* at the bottom of each file. A good example of this is when viewing a single content object; if
* it has the metaTitle and metaDescription fields set you can assign those to this object in order
* to customise the page title and description to the object, thereby improving your SEO.
*
* @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
* @uses trait TfMagicMethods Prevents direct setting of properties / unlisted properties.
* @property TfValidator $validator Instance of the Tuskfish data validator class.
* @property TfPreference $preference Instance of Tuskfish site preferences class.
* @property string $title Meta title of this website.
* @property string $description Meta description of this website.
* @property string $author Author of this website.
* @property string $copyright Copyright notice.
* @property string $generator Software system that generated this page.
* @property string $seo SEO optimisation string to append to page URL.
* @property string $robots Meta instructions to robots.
* @property int $paginationElements Number of slots in the pagination control.
*/
class TfMetadata
{
use TfMagicMethods;
protected $validator;
protected $preference;
protected $title = '';
protected $description = '';
protected $author = '';
protected $copyright = '';
protected $generator = '';
protected $seo = '';
protected $robots = '';
/**
* Constructor.
*
* @param TfValidator $validator An instance of the Tuskfish data validator class.
* @param TfPreference $preference Instance of TfPreference, holding site preferences.
*/
function __construct(TfValidator $validator, TfPreference $preference)
{
if (is_a($validator, 'TfValidator')) {
$this->validator = $validator;
} else {
trigger_error(TFISH_ERROR_NOT_VALIDATOR, E_USER_ERROR);
}
if (!is_a($preference, 'TfPreference')) {
trigger_error(TFISH_ERROR_NOT_PREFERENCE, E_USER_ERROR);
}
$this->setTitle($preference->siteName);
$this->setDescription($preference->siteDescription);
$this->setAuthor($preference->siteAuthor);
$this->setCopyright($preference->siteCopyright);
$this->setGenerator('Tuskfish CMS');
$this->setSeo('');
$this->setRobots('index,follow');
}
/**
* Access an existing property and escape it for output to browser.
*
* @param string $property Name of property.
* @return string|bool Value of preference escaped for display if set, otherwise false.
*
* Note that the ENT_QUOTES flag must be set on htmlspecialchars() as these properties are
* used within attributes of meta tags, so a double quote would cause breakage.
*/
public function __get(string $property)
{
$cleanProperty = $this->validator->trimString($property);
if (isset($this->$cleanProperty)) {
return htmlspecialchars((string) $this->$cleanProperty, ENT_QUOTES, "UTF-8",
false);
} else {
return null;
}
}
/**
* Sets the page meta title property.
*
* @param string $value Page title.
*/
public function setTitle(string $value)
{
$this->setProperty('title', $value);
}
/**
* Sets the meta description property.
*
* @param string $value Page description.
*/
public function setDescription(string $value)
{
$this->setProperty('description', $value);
}
/**
* Sets the page meta author property.
*
* @param string $value Page author.
*/
public function setAuthor(string $value)
{
$this->setProperty('author', $value);
}
/**
* Sets the page meta copyright property.
*
* @param string $value Page copyright.
*/
public function setCopyright(string $value)
{
$this->setProperty('copyright', $value);
}
/**
* Sets the meta generatorf (software used) property, which is not used in the default theme.
*
* @param string $value Site generator.
*/
public function setGenerator(string $value)
{
$this->setProperty('generator', $value);
}
/**
* Sets the SEO-friendly URL string for this page.
*
* @param string $value SEO string.
*/
public function setSeo(string $value)
{
$this->setProperty('seo', $value);
}
/**
* Sets the meta robots directive for this page.
*
* @param string $value Robots directive.
*/
public function setRobots(string $value)
{
$this->setProperty('robots', $value);
}
/**
* Set an existing property.
*
* @param string $property Name of property.
* @param mixed $value Value to assign to property.
*
* Note that htmlspecialchars() should use the ENT_QUOTES flag, as most of these values are
* used within attributes of meta tags, and a double quote would break them.
*/
private function setProperty(string $property, string $value)
{
$cleanProperty = $this->validator->trimString($property);
$cleanValue = $this->validator->trimString($value);
$this->$cleanProperty = htmlspecialchars($cleanValue, ENT_QUOTES, "UTF-8", false);
}
}