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 <?php
/**
* TfishRss 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");
/**
* RSS feed generator class.
*
* For information about the RSS 2.0 spec see http://cyber.harvard.edu/rss/rss.html
*
* @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
* @param object $tfish_preference TfishPreference object to make site preferences available.
* @property string $title Name of channel.
* @property string $link URL to website associated with this channel.
* @property string $description Sentence describing the channel.
* @property string $copyright Copyright license of this channel.
* @property string $managingEditor Email of the editor.
* @property string $webMaster Email of the webmaster.
* @property string $generator Name of software system generating this feed.
* @property string $image Image representing channel.
* @property array $items Array of content objects.
* @property string $template Template for presenting feed, default 'rss'.
*/
class TfishRss extends TfishAncestralObject
{
/** Initialise default property values and unset unneeded ones. */
public function __construct(TfishPreference $tfish_preference)
{
// Whitelist of official channel properties and datatypes.
$this->__properties['title'] = 'string';
$this->__properties['link'] = 'url';
$this->__properties['description'] = 'string';
$this->__properties['copyright'] = 'string';
$this->__properties['managingEditor'] = 'email';
$this->__properties['webMaster'] = 'email';
// $this->__properties['category'] = 'int'; // Todo: Implement tag-specific sub-channels.
$this->__properties['generator'] = 'string';
$this->__properties['image'] = 'string';
$this->__properties['items'] = 'array';
// Set the permitted properties of this object.
foreach ($this->__properties as $key => $value) {
$this->__data[$key] = '';
}
// Set default values of permitted properties.
$this->__data['title'] = $tfish_preference->site_name;
$this->__data['link'] = TFISH_RSS_URL;
$this->__data['description'] = $tfish_preference->site_description;
$this->__data['copyright'] = $tfish_preference->site_copyright;
$this->__data['managingEditor'] = $tfish_preference->site_email;
$this->__data['webMaster'] = $tfish_preference->site_email;
// $this->__data['category'] = 'int'; // Todo: Implement tag-specific sub-channels.
$this->__data['generator'] = 'Tuskfish';
//$this->__data['image'] = ''; // Todo: Add a preference or something for RSS feed.
$this->__data['items'] = array();
$this->__data['template'] = 'rss';
}
/**
* Make a RSS feed for a collection object.
*
* @param object $obj TfishCollection object.
*/
public function makeFeedForCollection(TfishCollection $obj)
{
if (!is_a($obj, 'TfishCollection')) {
trigger_error(TFISH_ERROR_NOT_OBJECT, E_USER_ERROR);
}
$this->__set('title', $obj->title);
$this->__set('link', TFISH_RSS_URL . '?id=' . (int) $obj->id);
$this->__set('description', $obj->teaser);
}
/**
* Validate and set an existing object property according to type specified in constructor.
*
* For more fine-grained control each property could be dealt with individually.
*
* @param string $property Name of property.
* @param mixed $value Value of property.
*/
public function __set(string $property, $value)
{
$clean_property = TfishFilter::trimString($property);
// Check that property is whitelisted.
if (isset($this->__data[$clean_property])) {
$type = $this->__properties[$clean_property];
} else {
trigger_error(TFISH_ERROR_NO_SUCH_PROPERTY, E_USER_ERROR);
}
// Validate $value against expected data type and business rules.
switch ($type) {
case "array": // Items
if (TfishFilter::isArray($value)) {
$clean_items = array();
foreach ($value as $val) {
if (is_a('TfishContentObject')) {
$clean_items[] = $val;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
unset($clean_val);
}
$this->__data[$clean_property] = $clean_items;
} else {
trigger_error(TFISH_ERROR_NOT_ARRAY, E_USER_ERROR);
}
break;
case "email":
$value = TfishFilter::trimString($value);
if (TfishFilter::isEmail($value)) {
$this->__data[$clean_property] = $value;
} else {
trigger_error(TFISH_ERROR_NOT_EMAIL, E_USER_ERROR);
}
break;
case "int": // Tags, minimum value 1.
if (TfishFilter::isInt($value, 1)) {
$this->__data[$clean_property] = (int) $value;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
break;
case "string":
$this->__data[$clean_property] = TfishFilter::trimString($value);
break;
case "url":
$value = TfishFilter::trimString($value);
if (TfishFilter::isUrl($value)) {
$this->__data[$clean_property] = $value;
} else {
trigger_error(TFISH_ERROR_NOT_URL, E_USER_ERROR);
}
break;
}
}
}