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 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 <?php
/**
* TfPaginationControl 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.1
* @package content
*/
// Enable strict type declaration.
declare(strict_types=1);
if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");
/**
* Generates pagination controls for paging through content.
*
* The number of pagination control slots is set in Tuskfish Preferences. Choose an odd number for
* best results.
*
* @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.1
* @package content
* @var TfValidator $validator Instance of the Tuskfish data valiator class.
* @var TfPreference $preference Instance of the Tuskfish site preference class.
* @var int $count Number of content objects (pages) matching these parameters.
* @var int $limit Number of content objects to retrieve in current view.
* @var string $url Target base URL for pagination control links.
* @var int $start Position in result set to retrieve content objects from.
* @var int $tag ID of tag used to filter content.
* @var array $extraParams Query string to be appended to the URLs (control script params).
*/
class TfPaginationControl
{
protected $validator;
protected $preference;
protected $count;
protected $limit;
protected $url;
protected $start;
protected $tag;
protected $extraParams;
/**
* Constructor.
*
* @param TfValidator $validator An instance of the Tuskfish data validator class.
* @param TfPreference $preference An instance of the Tuskfish site preferences class.
*/
function __construct(TfValidator $validator, TfPreference $preference)
{
if (is_a($validator, 'TfValidator')) {
$this->validator = $validator;
} else {
trigger_error(TFISH_ERROR_NOT_OBJECT, E_USER_ERROR);
}
if (is_a($preference, 'TfPreference')) {
$this->preference = $preference;
} else {
trigger_error(TFISH_ERROR_NOT_OBJECT, E_USER_ERROR);
}
$this->count = 0;
$this->limit = 0;
$this->url = '';
$this->start = 0;
$this->tag = 0;
$this->extraParams = array();
}
/**
* Creates a pagination control designed for use with the Bootstrap framework.
*
* $query is an array of arbitrary query string parameters. Note that these need to be passed
* in as an array of key => value pairs, and you should build this yourself using known and
* whitelisted values. Do not pass through random query strings someone gave you on the
* internetz.
*
* If you want to create pagination controls for other presentation-side libraries add
* additional methods to this class.
*
* @return string HTML pagination control.
*/
public function renderPaginationControl()
{
// If the count is zero there is no need for a pagination control.
if ($this->count === 0) {
return false;
}
// 1. Calculate number of pages, page number of start object and adjust for remainders.
$page_slots = array();
$page_count = (int) (($this->count / $this->limit));
$remainder = $this->count % $this->limit;
if ($remainder) {
$page_count += 1;
}
$page_range = range(1, $page_count);
// No need for pagination control if only one page.
if ($page_count === 1) {
return false;
}
// 2. Calculate current page.
$current_page = (int) (($this->start / $this->limit) + 1);
// 3. Calculate length of pagination control (number of slots).
$elements = ((int) $this->preference->paginationElements > $page_count)
? $page_count : (int) $this->preference->paginationElements;
// 4. Calculate the fore offset and initial (pre-adjustment) starting position.
$offset_int = (int) (($elements - 1) / 2);
$offset_float = ($elements - 1) / 2;
$page_start = $current_page - $offset_int;
// 5. Check if fore exceeds bounds. If so, set start = 1 and extract the range.
$fore_boundcheck = $current_page - $offset_int;
// 6. Check if aft exceeds bounds. If so set start = $page_count - length.
$aft_boundcheck = ($current_page + $offset_float);
// This is the tricky bit - slicing a variable region out of the range.
if ($page_count === $elements) {
$page_slots = $page_range;
} elseif ($fore_boundcheck < 1) {
$page_slots = array_slice($page_range, 0, $elements, true);
} elseif ($aft_boundcheck >= $page_count) {
$page_start = $page_count - $elements;
$page_slots = array_slice($page_range, $page_start, $elements, true);
} else {
$page_slots = array_slice($page_range, ($page_start - 1), $elements, true);
}
// 7. Substitute in the 'first' and 'last' page elements and sort the array back into
// numerical order.
end($page_slots);
unset($page_slots[key($page_slots)]);
$page_slots[($page_count - 1)] = TFISH_PAGINATION_LAST;
reset($page_slots);
unset($page_slots[key($page_slots)]);
$page_slots[0] = TFISH_PAGINATION_FIRST;
ksort($page_slots);
// Construct a HTML pagination control.
$control = '<nav aria-label="Page navigation"><ul class="pagination">';
// Prepare the query string.
$query = $start_arg = $tag_arg = '';
foreach ($page_slots as $key => $slot) {
$this->start = (int) ($key * $this->limit);
// Set the arguments.
if ($this->start || $this->tag || $this->extraParams) {
$arg_array = array();
if (!empty($this->start)) {
$arg_array[] = 'start=' . $this->start;
}
if (!empty($this->tag)) {
$arg_array[] = 'tagId=' . $this->tag;
}
if (!empty($this->extraParams)) {
$arg_array[] = $this->extraParams;
}
$query = '?' . implode('&', $arg_array);
}
if (($key + 1) === $current_page) {
$control .= '<li class="page-item active"><a class="page-link" href="' . $this->url
. $query . '">' . $slot . '</a></li>';
} else {
$control .= '<li class="page-item"><a class="page-link" href="' . $this->url
. $query . '">' . $slot . '</a></li>';
}
unset($query, $key, $slot);
}
$control .= '</ul></nav>';
return $control;
}
/**
* Disallow direct setting of properties.
*
* @param string $property Name of property.
* @param mixed $value Value to assign to property.
*/
public function __set(string $property, $value)
{
trigger_error(TFISH_ERROR_DIRECT_PROPERTY_SETTING_DISALLOWED);
exit;
}
/**
* Set the count property, which represents the number of objects matching the page parameters.
*
* @param int $count
*/
public function setCount($count)
{
$cleanCount = (int) $count;
$this->count = $this->validator->isInt($cleanCount, 0) ? $cleanCount : 0;
}
/**
* Sets the limit property, which controls the number of objects to be retrieved in a single
* page view.
*
* @param int $limit Number of content objects to retrieve in current view.
*/
public function setLimit(int $limit)
{
$cleanLimit = (int) $limit;
$this->limit = $this->validator->isInt($cleanLimit, 0) ? $cleanLimit : 0;
}
/**
* Set the base URL for pagination control links.
*
* @param string $url Base file name for constructing URLs, without the extention.
*/
public function setUrl(string $url)
{
$cleanUrl = $this->validator->trimString($url);
$this->url = $this->validator->isAlnumUnderscore($cleanUrl) ? $cleanUrl . '.php'
: TFISH_URL;
}
/**
* Set the starting position in the set of available object.
*
* @param int $start ID of first object to view in the set of available records.
*/
public function setStart(int $start)
{
$cleanStart = (int) $start;
$this->start = $this->validator->isInt($cleanStart, 0) ? $cleanStart : 0;
}
/**
* Set the ID of a tag used to filter content.
*
* @param int $tag ID of tag used to filter content.
*/
public function setTag(int $tag)
{
$cleanTag = (int) $tag;
$this->tag = $this->validator->isInt($cleanTag, 0) ? $cleanTag : 0;
}
/**
* Set extra parameters to be included in pagination control links.
*
* $extraParams is a potential XSS attack vector.
* The key => value pairs be i) rawurlencoded and ii) entity escaped. However, in order to
* avoid messing up the query and avoid unnecessary decoding it is possible to maintain
* manual control over the operators. (Basically, input requiring encoding or escaping is
* absolutely not wanted here, it is just being conducted to mitigate XSS attacks). If you
* actually *want* to use such input (check your sanity), you will need to decode it prior to
* use on the landing page.
*
* @param array $extraParams Query string to be appended to the URLs (control script params)
* @return boolean Returns false on failure.
*/
public function setExtraParams(array $extraParams)
{
$clean_extraParams = array();
foreach ($extraParams as $key => $value) {
if ($this->validator->hasTraversalorNullByte((string) $key)
|| $this->validator->hasTraversalorNullByte((string) $value)) {
trigger_error(TFISH_ERROR_TRAVERSAL_OR_NULL_BYTE, E_USER_ERROR);
return false;
}
$clean_extraParams[] = $this->validator->encodeEscapeUrl($key) . '='
. $this->validator->encodeEscapeUrl((string) $value);
unset($key, $value);
}
if (empty($clean_extraParams)) {
$this->extraParams = '';
} else {
$this->extraParams = $this->validator->escapeForXss(implode("&", $clean_extraParams));
}
}
}