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 <?php
/**
* TfCriteria 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 database
*/
// Enable strict type declaration.
declare(strict_types=1);
if (!defined("TFISH_ROOT_PATH")) die("TFISH_ERROR_ROOT_PATH_NOT_DEFINED");
/**
* Sets conditions on database queries, used to compose a query.
*
* Use this class to set parameters on database-related actions. Individual conditions are held
* within the item property, as TfCriteriaItem objects. Criteria holds the basic query parameters
* and controls how TfCriteriaItem are chained together (eg. with "AND", "OR").
*
* See the Tuskfish Developer Guide for a full explanation and examples.
*
* @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 database
* @uses trait TfMagicMethods Prevents direct setting of properties / unlisted properties.
* @property TfValidator $validator Instance of the Tuskfish data validator class.
* @property array $item Array of TfCriteriaItem.
* @property array $condition Array of conditions used to join TfCriteriaItem (AND, OR).
* @property string $groupBy Column to group results by.
* @property int $limit Number of records to retrieve.
* @property int $offset Starting point for retrieving records.
* @property string $order Primary column to sort records by.
* @property string $orderType Sort ascending (ASC) or descending(DESC).
* @property string $secondaryOrder secondary column to sort records by.
* @property string $secondaryOrderType Sort ascending (ASC) or descending (DESC).
* @property array $tag Array of tag IDs.
*/
class TfCriteria
{
use TfMagicMethods;
protected $validator;
protected $item = array();
protected $condition = array();
protected $groupBy = '';
protected $limit = 0;
protected $offset = 0;
protected $order = '';
protected $orderType = "DESC";
protected $secondaryOrder = '';
protected $secondaryOrderType = "DESC";
protected $tag = array();
/**
* Constructor.
*
* @param TfValidator $validator An instance of the Tuskfish data validator class.
*/
public function __construct(TfValidator $validator)
{
if (is_a($validator, 'TfValidator')) {
$this->validator = $validator;
} else {
trigger_error(TFISH_ERROR_NOT_OBJECT, E_USER_ERROR);
}
}
/**
* Add conditions (TfCriteriaItem) to a query.
*
* @param object $criteriaItem TfCriteriaItem object.
* @param string $condition Condition used to chain TfCriteriaItems, "AND" or "OR" only.
*/
public function add(TfCriteriaItem $criteriaItem, string $condition = "AND")
{
$this->setItem($criteriaItem);
$this->setCondition($condition);
}
/**
* Add a condition (AND, OR) to a query.
*
* @param string $condition AND or OR, only.
*/
private function setCondition(string $condition)
{
$clean_condition = $this->validator->trimString($condition);
if ($clean_condition === "AND" || $clean_condition === "OR") {
$this->condition[] = $clean_condition;
} else {
trigger_error(TFISH_ERROR_ILLEGAL_VALUE, E_USER_ERROR);
}
}
/**
* Set a GROUP BY condition on a query.
*
* @param string $groupBy Column to group results by.
*/
public function setGroupBy(string $groupBy)
{
$cleanGroupBy = $this->validator->trimString($groupBy);
if ($this->validator->isAlnumUnderscore($cleanGroupBy)) {
$this->groupBy = $cleanGroupBy;
} else {
trigger_error(TFISH_ERROR_NOT_ALNUMUNDER, E_USER_ERROR);
}
}
/**
* Add an item to filter a query with.
*
* @param TfCriteriaItem $item Contains database column, value and operator to filter a query.
*/
private function setItem(TfCriteriaItem $item)
{
if (is_a($item, 'TfCriteriaItem')) {
$this->item[] = $item;
} else {
trigger_error(TFISH_ERROR_NOT_CRITERIA_ITEM_OBJECT, E_USER_ERROR);
}
}
/**
* Sets a limit on the number of database records to retrieve in a database query.
*
* @param int $limit The number of records to retrieve.
*/
public function setLimit(int $limit)
{
if ($this->validator->isInt($limit, 0)) {
$this->limit = (int) $limit;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Sets an offset (starting point) for retrieving records in a database query.
*
* @param int $offset The record to start retrieving results from, from a result set.
*/
public function setOffset(int $offset)
{
if ($this->validator->isInt($offset, 0)) {
$this->offset = (int) $offset;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
}
/**
* Sets the primary column to order query results by.
*
* @param string $order Name of the primary column to order the query results by.
*/
public function setOrder(string $order)
{
$clean_order = $this->validator->trimString($order);
if ($this->validator->isAlnumUnderscore($clean_order)) {
$this->order = $clean_order;
} else {
trigger_error(TFISH_ERROR_NOT_ALNUMUNDER, E_USER_ERROR);
}
}
/**
* Sets the sort type (ascending or descending) for the primary order column of a result set.
*
* @param string $orderType Ascending (ASC) or descending (DESC) order.
*/
public function setOrderType(string $orderType)
{
$cleanOrderType = $this->validator->trimString($orderType);
if ($cleanOrderType === "ASC") {
$this->orderType = "ASC";
} else {
$this->orderType = "DESC";
}
}
/**
* Sets the secondary column to order query results by.
*
* @param string $secondaryOrder Name of the secondary column to order the query results by.
*/
public function setSecondaryOrder(string $secondaryOrder)
{
$cleanSecondaryOrder = $this->validator->trimString($secondaryOrder);
if ($this->validator->isAlnumUnderscore($cleanSecondaryOrder)) {
$this->secondaryOrder = $cleanSecondaryOrder;
} else {
trigger_error(TFISH_ERROR_NOT_ALNUMUNDER, E_USER_ERROR);
}
}
/**
* Sets the secondary column to order query results by.
*
* @param string $secondaryOrderType order Name of the secondary column to order the query
* results by.
*/
public function setSecondaryOrderType(string $secondaryOrderType)
{
$cleanSecondaryOrderType = $this->validator->trimString($secondaryOrderType);
if ($cleanSecondaryOrderType === "ASC") {
$this->secondaryOrderType = "ASC";
} else {
$this->secondaryOrderType = "DESC";
}
}
/**
* Set tag(s) to filter query results by.
*
* @param array $tags Array of tag IDs to be used to filter a query.
*/
public function setTag(array $tags)
{
if ($this->validator->isArray($tags)) {
$cleanTags = array();
foreach ($tags as $tag) {
if ($this->validator->isInt($tag, 1)) {
$cleanTags[] = (int) $tag;
} else {
trigger_error(TFISH_ERROR_NOT_INT, E_USER_ERROR);
}
unset($tag);
}
$this->tag = $cleanTags;
} else {
trigger_error(TFISH_ERROR_NOT_ARRAY, E_USER_ERROR);
}
}
/**
* Unset existing type criteria.
*
* Used by content object handler subclasses to remove any existing type filter when they may
* need to set or reset it to a specific type.
*
* @param int $key Key of the item array containing the type filter.
*/
public function unsetType(int $key)
{
if (isset($this->item[$key])) {
unset($this->item[$key]);
unset($this->condition[$key]);
}
// Reindex the arrays.
$this->item = array_values($this->item);
$this->condition = array_values($this->condition);
}
}