XoopsModules25x /
xhelp
| Total Complexity | 48 |
| Total Lines | 330 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like TicketFieldHandler 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 TicketFieldHandler, and based on these observations, apply Extract Interface, too.
| 1 | <?php declare(strict_types=1); |
||
| 31 | class TicketFieldHandler extends BaseObjectHandler |
||
| 32 | { |
||
| 33 | /** |
||
| 34 | * Name of child class |
||
| 35 | * |
||
| 36 | * @var string |
||
| 37 | */ |
||
| 38 | public $classname = TicketField::class; |
||
| 39 | /** |
||
| 40 | * DB Table Name |
||
| 41 | * |
||
| 42 | * @var string |
||
| 43 | */ |
||
| 44 | public $dbtable = 'xhelp_ticket_fields'; |
||
| 45 | public $id = 'id'; |
||
| 46 | |||
| 47 | private const TABLE = 'xhelp_ticket_fields'; |
||
| 48 | private const ENTITY = TicketField::class; |
||
| 49 | private const ENTITYNAME = 'TicketField'; |
||
| 50 | private const KEYNAME = 'id'; |
||
| 51 | private const IDENTIFIER = 'name'; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Constructor |
||
| 55 | * |
||
| 56 | * @param \XoopsMySQLDatabase|null $db reference to a xoopsDB object |
||
| 57 | */ |
||
| 58 | public function __construct(\XoopsMySQLDatabase $db = null) |
||
| 59 | { |
||
| 60 | $this->init($db); |
||
| 61 | $this->helper = Helper::getInstance(); |
||
| 62 | parent::__construct($db, static::TABLE, static::ENTITY, static::KEYNAME, static::IDENTIFIER); |
||
| 63 | } |
||
| 64 | |||
| 65 | /** |
||
| 66 | * @param \XoopsObject $object |
||
| 67 | * @return string |
||
| 68 | */ |
||
| 69 | public function insertQuery(\XoopsObject $object): string |
||
| 70 | { |
||
| 71 | //TODO mb replace with individual variables |
||
| 72 | // Copy all object vars into local variables |
||
| 73 | foreach ($object->cleanVars as $k => $v) { |
||
| 74 | ${$k} = $v; |
||
| 75 | } |
||
| 76 | |||
| 77 | $sql = \sprintf( |
||
| 78 | 'INSERT INTO `%s` (id, NAME, description, fieldname, controltype, datatype, required, fieldlength, weight, fieldvalues, defaultvalue, VALIDATION) |
||
| 79 | VALUES (%u, %s, %s, %s, %u, %s, %u, %u, %s, %s, %s, %s)', |
||
| 80 | $this->db->prefix($this->dbtable), |
||
| 81 | $id, |
||
|
Comprehensibility
Best Practice
introduced
by
|
|||
| 82 | $this->db->quoteString($name), |
||
| 83 | $this->db->quoteString($description), |
||
| 84 | $this->db->quoteString($fieldname), |
||
| 85 | $controltype, |
||
| 86 | $this->db->quoteString($datatype), |
||
| 87 | $required, |
||
| 88 | $fieldlength, |
||
| 89 | $weight, |
||
| 90 | $this->db->quoteString($fieldvalues), |
||
| 91 | $this->db->quoteString($defaultvalue), |
||
| 92 | $this->db->quoteString($validation) |
||
| 93 | ); |
||
| 94 | |||
| 95 | return $sql; |
||
| 96 | } |
||
| 97 | |||
| 98 | /** |
||
| 99 | * @param \XoopsObject $object |
||
| 100 | * @return string |
||
| 101 | */ |
||
| 102 | public function updateQuery(\XoopsObject $object): string |
||
| 103 | { |
||
| 104 | //TODO mb replace with individual variables |
||
| 105 | // Copy all object vars into local variables |
||
| 106 | foreach ($object->cleanVars as $k => $v) { |
||
| 107 | ${$k} = $v; |
||
| 108 | } |
||
| 109 | |||
| 110 | $sql = \sprintf( |
||
| 111 | 'UPDATE `%s` SET NAME = %s, description = %s, fieldname = %s, controltype = %u, datatype = %s, required = %u, fieldlength = %u, weight = %u, fieldvalues = %s, |
||
| 112 | defaultvalue = %s, VALIDATION = %s WHERE id = %u', |
||
| 113 | $this->db->prefix($this->dbtable), |
||
| 114 | $this->db->quoteString($name), |
||
| 115 | $this->db->quoteString($description), |
||
| 116 | $this->db->quoteString($fieldname), |
||
| 117 | $controltype, |
||
| 118 | $this->db->quoteString($datatype), |
||
| 119 | $required, |
||
| 120 | $fieldlength, |
||
| 121 | $weight, |
||
| 122 | $this->db->quoteString($fieldvalues), |
||
| 123 | $this->db->quoteString($defaultvalue), |
||
| 124 | $this->db->quoteString($validation), |
||
| 125 | $id |
||
| 126 | ); |
||
| 127 | |||
| 128 | return $sql; |
||
| 129 | } |
||
| 130 | |||
| 131 | /** |
||
| 132 | * @param \XoopsObject $object |
||
| 133 | * @return string |
||
| 134 | */ |
||
| 135 | public function deleteQuery(\XoopsObject $object): string |
||
| 136 | { |
||
| 137 | $sql = \sprintf('DELETE FROM `%s` WHERE id = %u', $this->db->prefix($this->dbtable), $object->getVar($this->id)); |
||
| 138 | |||
| 139 | return $sql; |
||
| 140 | } |
||
| 141 | |||
| 142 | /** |
||
| 143 | * @param \XoopsObject $object |
||
| 144 | * @param bool $force |
||
| 145 | * @return bool |
||
| 146 | */ |
||
| 147 | public function insert(\XoopsObject $object, $force = true): bool |
||
| 148 | { |
||
| 149 | /** @var \XoopsModules\Xhelp\TicketFieldDepartmentHandler $ticketFieldDepartmentHandler */ |
||
| 150 | $ticketFieldDepartmentHandler = $this->helper->getHandler('TicketFieldDepartment'); |
||
| 151 | if ($object->isNew()) { |
||
| 152 | $add_field = true; |
||
| 153 | $fieldname = $object->getVar('fieldname'); |
||
| 154 | } else { |
||
| 155 | $old_obj = $this->get($object->getVar('id')); |
||
| 156 | |||
| 157 | $old_name = $old_obj->getVar('fieldname'); |
||
| 158 | $new_name = $object->getVar('fieldname'); |
||
| 159 | |||
| 160 | $add_field = false; |
||
| 161 | $alter_table = ($old_name != $new_name) |
||
| 162 | || ($old_obj->getVar('fieldlength') != $object->getVar('fieldlength')) |
||
| 163 | || ($old_obj->getVar('controltype') != $object->getVar('controltype')) |
||
| 164 | || ($old_obj->getVar('datatype') != $object->getVar('datatype')); |
||
| 165 | } |
||
| 166 | |||
| 167 | //Store base object |
||
| 168 | $ret = parent::insert($object, $force); |
||
| 169 | if ($ret) { |
||
| 170 | //Update Joiner Records |
||
| 171 | $ret2 = $ticketFieldDepartmentHandler->removeFieldFromAllDept($object->getVar('id')); |
||
| 172 | |||
| 173 | $depts = $object->getDepartments(); |
||
| 174 | |||
| 175 | if (\count($depts)) { |
||
| 176 | $ret = $ticketFieldDepartmentHandler->addDepartmentToField($depts, $object->getVar('id')); |
||
| 177 | } |
||
| 178 | |||
| 179 | $mysql = $this->mysqlDBType($object); |
||
| 180 | |||
| 181 | if ($add_field) { |
||
| 182 | Utility::addDBField('xhelp_ticket_values', $fieldname, $mysql['fieldtype'], $mysql['length']); |
||
| 183 | } elseif ($alter_table) { |
||
| 184 | Utility::renameDBField('xhelp_ticket_values', $old_name, $new_name, $mysql['fieldtype'], $mysql['length']); |
||
| 185 | } |
||
| 186 | } |
||
| 187 | |||
| 188 | return $ret; |
||
| 189 | } |
||
| 190 | |||
| 191 | /** |
||
| 192 | * @param \XoopsObject $object |
||
| 193 | * @param bool $force |
||
| 194 | * @return bool |
||
| 195 | */ |
||
| 196 | public function delete(\XoopsObject $object, $force = false): bool |
||
| 197 | { |
||
| 198 | //Remove FieldDepartment Records |
||
| 199 | /** @var \XoopsModules\Xhelp\TicketFieldDepartmentHandler $ticketFieldDepartmentHandler */ |
||
| 200 | $ticketFieldDepartmentHandler = $this->helper->getHandler('TicketFieldDepartment'); |
||
| 201 | $fieldId = $object->getVar('id'); |
||
| 202 | if (!$ret = $ticketFieldDepartmentHandler->removeFieldFromAllDept($fieldId, $force)) { |
||
| 203 | $object->setErrors('Unable to remove field from departments'); |
||
| 204 | } |
||
| 205 | |||
| 206 | //Remove values from ticket values table |
||
| 207 | if (!$ret = Utility::removeDBField('xhelp_ticket_values', $object->getVar('fieldname'))) { |
||
| 208 | $object->setErrors('Unable to remove field from ticket values table'); |
||
| 209 | } |
||
| 210 | |||
| 211 | //Remove obj from table |
||
| 212 | $ret = $this->delete($object, $force); |
||
| 213 | |||
| 214 | return $ret; |
||
| 215 | } |
||
| 216 | |||
| 217 | /** |
||
| 218 | * @param int $dept |
||
| 219 | * @return array |
||
| 220 | */ |
||
| 221 | public function getByDept(int $dept): array |
||
| 222 | { |
||
| 223 | /** @var TicketFieldDepartmentHandler $ticketFieldDepartmentHandler */ |
||
| 224 | $ticketFieldDepartmentHandler = $this->helper->getHandler('TicketFieldDepartment'); |
||
| 225 | $ret = $ticketFieldDepartmentHandler->fieldsByDepartment($dept); |
||
| 226 | |||
| 227 | return $ret; |
||
| 228 | } |
||
| 229 | |||
| 230 | /** |
||
| 231 | * @param \XoopsObject $object |
||
| 232 | * @return array |
||
| 233 | */ |
||
| 234 | private function mysqlDBType(\XoopsObject $object): array |
||
| 361 | } |
||
| 362 | } |
||
| 363 |
Loading history...