XoopsModules25x /
xhelp
| Total Complexity | 40 |
| Total Lines | 322 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like TicketFieldDepartmentHandler often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use TicketFieldDepartmentHandler, and based on these observations, apply Extract Interface, too.
| 1 | <?php declare(strict_types=1); |
||
| 25 | class TicketFieldDepartmentHandler // extends BaseObjectHandler |
||
| 26 | { |
||
| 27 | private $db; |
||
| 28 | private $ticketFieldHandler; |
||
| 29 | private $departmentHandler; |
||
| 30 | |||
| 31 | // private const TABLE = 'xhelp_ticket_field_departments'; |
||
| 32 | // private const ENTITY = TicketFieldDepartment::class; |
||
| 33 | // private const ENTITYNAME = 'TicketFieldDepartment'; |
||
| 34 | // private const KEYNAME = 'fieldid'; |
||
| 35 | // private const IDENTIFIER = 'deptid'; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Constructor |
||
| 39 | */ |
||
| 40 | public function __construct(\XoopsMySQLDatabase $db = null) |
||
| 41 | { |
||
| 42 | $this->db = $db; |
||
| 43 | $this->helper = Helper::getInstance(); |
||
|
Bug
Best Practice
introduced
by
|
|||
| 44 | |||
| 45 | /** @var \XoopsModules\Xhelp\TicketFieldHandler $this- >ticketFieldHandler */ |
||
| 46 | $this->ticketFieldHandler = $this->helper->getHandler('TicketField'); |
||
| 47 | /** @var \XoopsModules\Xhelp\DepartmentHandler $this- >ticketFieldHandler */ |
||
| 48 | $this->departmentHandler = $this->helper->getHandler('Department'); |
||
| 49 | |||
| 50 | // parent::__construct($db, static::TABLE, static::ENTITY, static::KEYNAME, static::IDENTIFIER); |
||
| 51 | } |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Get every department a field is "in" |
||
| 55 | * |
||
| 56 | * @param int $field Field ID |
||
| 57 | * @param bool $id_as_key Should object ID be used as array key? |
||
| 58 | * @return array array of {@Link Department} objects |
||
| 59 | */ |
||
| 60 | public function departmentsByField(int $field, bool $id_as_key = false): array |
||
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Get every field in a department |
||
| 85 | * |
||
| 86 | * @param int $dept Department ID |
||
| 87 | * @param bool $id_as_key Should object ID be used as array key? |
||
| 88 | * @return array array of {@Link TicketField} objects |
||
| 89 | */ |
||
| 90 | public function fieldsByDepartment(int $dept, bool $id_as_key = false): array |
||
| 91 | { |
||
| 92 | $dept = $dept; |
||
| 93 | $sql = \sprintf('SELECT f.* FROM `%s` f INNER JOIN %s j ON f.id = j.fieldid WHERE j.deptid = %u ORDER BY f.weight', $this->db->prefix('xhelp_ticket_fields'), $this->db->prefix('xhelp_ticket_field_departments'), $dept); |
||
| 94 | $result = $this->db->query($sql); |
||
| 95 | $arr = []; |
||
| 96 | |||
| 97 | if ($this->db->getRowsNum($result) > 0) { |
||
| 98 | while (false !== ($temp = $this->db->fetchArray($result))) { |
||
| 99 | $field = $this->ticketFieldHandler->create(); |
||
| 100 | $field->assignVars($temp); |
||
| 101 | if ($id_as_key) { |
||
| 102 | $arr[$field->getVar('id')] = $field; |
||
| 103 | } else { |
||
| 104 | $arr[] = $field; |
||
| 105 | } |
||
| 106 | unset($temp); |
||
| 107 | } |
||
| 108 | } |
||
| 109 | |||
| 110 | return $arr; |
||
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Add the given field to the given department |
||
| 115 | * |
||
| 116 | * @param array|TicketField $field |
||
| 117 | * @param int $deptid Department ID |
||
| 118 | * @return bool True if successful, False if not |
||
| 119 | * @internal param mixed $staff single or array of uids or TicketField object |
||
| 120 | */ |
||
| 121 | public function addFieldToDepartment($field, int $deptid): bool |
||
| 122 | { |
||
| 123 | $ret = false; |
||
| 124 | if (\is_array($field)) { |
||
| 125 | foreach ($field as $var) { |
||
| 126 | $ret = $this->addMembership($var, $deptid); |
||
| 127 | if (!$ret) { |
||
| 128 | break; |
||
| 129 | } |
||
| 130 | } |
||
| 131 | } else { |
||
| 132 | $ret = $this->addMembership($field, $deptid); |
||
| 133 | } |
||
| 134 | |||
| 135 | return $ret; |
||
| 136 | } |
||
| 137 | |||
| 138 | /** |
||
| 139 | * Add the given department(s) to the given field |
||
| 140 | * |
||
| 141 | * @param mixed $dept single or array of department id's or {@Link Department} objects |
||
| 142 | * @param int $field Field ID |
||
| 143 | * @retnr bool True if successful, False if not |
||
| 144 | * @return bool |
||
| 145 | */ |
||
| 146 | public function addDepartmentToField($dept, int $field): bool |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Remove the given field(s) from the given department |
||
| 165 | * |
||
| 166 | * @param mixed $field single or array of field ids or {@link TicketField} objects |
||
| 167 | * @param int $deptid Department ID |
||
| 168 | * @return bool True if successful, False if not |
||
| 169 | */ |
||
| 170 | public function removeFieldFromDept($field, int $deptid): bool |
||
| 171 | { |
||
| 172 | $ret = false; |
||
| 173 | if (\is_array($field)) { |
||
| 174 | foreach ($field as $var) { |
||
| 175 | $ret = $this->removeMembership($var, $deptid); |
||
| 176 | if (!$ret) { |
||
| 177 | break; |
||
| 178 | } |
||
| 179 | } |
||
| 180 | } else { |
||
| 181 | $ret = $this->removeMembership($field, $deptid); |
||
| 182 | } |
||
| 183 | |||
| 184 | return $ret; |
||
| 185 | } |
||
| 186 | |||
| 187 | /** |
||
| 188 | * Remove the given department(s) from the given field |
||
| 189 | * |
||
| 190 | * @param mixed $dept single or array of department id's or {@link Department} objects |
||
| 191 | * @param int $field Field ID |
||
| 192 | * @return bool True if successful, False if not |
||
| 193 | */ |
||
| 194 | public function removeDeptFromField($dept, int $field): bool |
||
| 195 | { |
||
| 196 | $ret = false; |
||
| 197 | if (\is_array($dept)) { |
||
| 198 | foreach ($dept as $var) { |
||
| 199 | $ret = $this->removeMembership($field, $var); |
||
| 200 | if (!$ret) { |
||
| 201 | break; |
||
| 202 | } |
||
| 203 | } |
||
| 204 | } else { |
||
| 205 | $ret = $this->removeMembership($field, $dept); |
||
| 206 | } |
||
| 207 | |||
| 208 | return $ret; |
||
| 209 | } |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Remove All Departments from a particular field |
||
| 213 | * @param int $fieldId Field ID |
||
| 214 | * @return bool True if successful, False if not |
||
| 215 | */ |
||
| 216 | public function removeFieldFromAllDept(int $fieldId): bool |
||
| 217 | { |
||
| 218 | $ret = false; |
||
| 219 | // $field = $field; |
||
| 220 | $criteria = new \Criteria('fieldid', $fieldId); |
||
| 221 | $ret = $this->deleteAll($criteria); |
||
| 222 | |||
| 223 | return $ret; |
||
| 224 | } |
||
| 225 | |||
| 226 | /** |
||
| 227 | * Remove All Departments from a particular field |
||
| 228 | * @param int $dept |
||
| 229 | * @return bool True if successful, False if not |
||
| 230 | * @internal param int $field Field ID |
||
| 231 | */ |
||
| 232 | public function removeDeptFromAllFields(int $dept): bool |
||
| 233 | { |
||
| 234 | $ret = false; |
||
| 235 | $dept = $dept; |
||
| 236 | $criteria = new \Criteria('deptid', $dept); |
||
| 237 | $ret = $this->deleteAll($criteria); |
||
| 238 | |||
| 239 | return $ret; |
||
| 240 | } |
||
| 241 | |||
| 242 | /** |
||
| 243 | * @param \CriteriaElement|\CriteriaCompo|null $criteria |
||
| 244 | * @param bool $force |
||
| 245 | * @return bool |
||
| 246 | */ |
||
| 247 | public function deleteAll(\CriteriaElement $criteria = null, bool $force = false): bool |
||
| 248 | { |
||
| 249 | $sql = 'DELETE FROM ' . $this->db->prefix('xhelp_ticket_field_departments'); |
||
| 250 | if (($criteria instanceof \CriteriaCompo) || ($criteria instanceof \Criteria)) { |
||
| 251 | $sql .= ' ' . $criteria->renderWhere(); |
||
| 252 | } |
||
| 253 | |||
| 254 | if ($force) { |
||
| 255 | $result = $this->db->queryF($sql); |
||
| 256 | } else { |
||
| 257 | $result = $this->db->query($sql); |
||
| 258 | } |
||
| 259 | if (!$result) { |
||
| 260 | return false; |
||
| 261 | } |
||
| 262 | |||
| 263 | return true; |
||
| 264 | } |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Add a field to a department |
||
| 268 | * |
||
| 269 | * @param mixed $field fieldid or {@Link TicketField} object |
||
| 270 | * @param mixed $dept deptid or {@Link Department} object |
||
| 271 | * @return bool True if Successful, False if not |
||
| 272 | */ |
||
| 273 | public function addMembership($field, $dept): bool |
||
| 274 | { |
||
| 275 | $ret = false; |
||
| 276 | $fieldid = $deptid = 0; |
||
| 277 | |||
| 278 | if (\is_object($field)) { |
||
| 279 | $fieldid = $field->getVar('id'); |
||
| 280 | } else { |
||
| 281 | $fieldid = (int)$field; |
||
| 282 | } |
||
| 283 | |||
| 284 | if (\is_object($dept)) { |
||
| 285 | $deptid = $dept->getVar('id'); |
||
| 286 | } else { |
||
| 287 | $deptid = (int)$dept; |
||
| 288 | } |
||
| 289 | |||
| 290 | $ret = $this->addJoinerRecord($fieldid, $deptid); |
||
| 291 | |||
| 292 | return $ret; |
||
| 293 | } |
||
| 294 | |||
| 295 | /** |
||
| 296 | * @param int $fieldid |
||
| 297 | * @param int $deptid |
||
| 298 | * @return bool|\mysqli_result |
||
| 299 | */ |
||
| 300 | private function addJoinerRecord(int $fieldid, int $deptid) |
||
| 301 | { |
||
| 302 | $ret = false; |
||
| 303 | $sql = \sprintf('INSERT INTO `%s` (fieldid, deptid) VALUES (%u, %u)', $this->db->prefix('xhelp_ticket_field_departments'), $fieldid, $deptid); |
||
| 304 | $ret = $this->db->query($sql); |
||
| 305 | |||
| 306 | return $ret; |
||
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * @param int|\XoopsModules\Xhelp\TicketField $field |
||
| 311 | * @param int|\XoopsModules\Xhelp\Department $dept |
||
| 312 | * @return mixed |
||
| 313 | */ |
||
| 314 | private function removeMembership($field, $dept) |
||
| 315 | { |
||
| 316 | $ret = false; |
||
| 317 | $fieldid = $deptid = 0; |
||
| 318 | if (\is_object($field)) { |
||
| 319 | $fieldid = $field->getVar('id'); |
||
| 320 | } else { |
||
| 321 | $fieldid = (int)$field; |
||
| 322 | } |
||
| 323 | |||
| 324 | if (\is_object($dept)) { |
||
| 325 | $deptid = $dept->getVar('id'); |
||
| 326 | } else { |
||
| 327 | $deptid = (int)$dept; |
||
| 328 | } |
||
| 329 | |||
| 330 | $ret = $this->removeJoinerRecord($fieldid, $deptid); |
||
| 331 | |||
| 332 | return $ret; |
||
| 333 | } |
||
| 334 | |||
| 335 | /** |
||
| 336 | * @param int $fieldid |
||
| 337 | * @param int $deptid |
||
| 338 | * @return bool|\mysqli_result |
||
| 339 | */ |
||
| 340 | private function removeJoinerRecord(int $fieldid, int $deptid) |
||
| 347 | } |
||
| 348 | } |
||
| 349 |
Loading history...