YetiForceCompany /
YetiForceCRM
| Total Complexity | 53 |
| Total Lines | 426 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like Vtiger_CalendarExtSource_Model 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 Vtiger_CalendarExtSource_Model, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | class Vtiger_CalendarExtSource_Model extends App\Base |
||
| 16 | { |
||
| 17 | /** @var string[] Extra source details */ |
||
| 18 | const EXTRA_SOURCE_TYPES = [ |
||
| 19 | 1 => 'LBL_SOURCE_TYPE_1', |
||
| 20 | 2 => 'LBL_SOURCE_TYPE_2', |
||
| 21 | 3 => 'LBL_SOURCE_TYPE_3', |
||
| 22 | 4 => 'LBL_SOURCE_TYPE_4', |
||
| 23 | ]; |
||
| 24 | /** @var string Extra source table name */ |
||
| 25 | const EXTRA_SOURCE_TABLE = 's_#__calendar_sources'; |
||
| 26 | |||
| 27 | /** @var string Base module name */ |
||
| 28 | protected $baseModuleName; |
||
| 29 | /** @var string Target module name */ |
||
| 30 | protected $targetModuleName; |
||
| 31 | /** @var \Vtiger_Module_Model Target module model */ |
||
| 32 | protected $targetModuleModel; |
||
| 33 | /** @var \App\QueryGenerator Query generator instance */ |
||
| 34 | protected $queryGenerator; |
||
| 35 | /** @var string[] Name record fields */ |
||
| 36 | protected $nameFields; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Get calendar extra sources list. |
||
| 40 | * |
||
| 41 | * @param int $moduleId |
||
| 42 | * |
||
| 43 | * @return array |
||
| 44 | */ |
||
| 45 | public static function getByModule(int $moduleId): array |
||
| 46 | { |
||
| 47 | if (\App\Cache::has('Calendar-GetExtraSourcesList', $moduleId)) { |
||
| 48 | return \App\Cache::get('Calendar-GetExtraSourcesList', $moduleId); |
||
| 49 | } |
||
| 50 | $query = (new \App\Db\Query())->from('s_#__calendar_sources') |
||
| 51 | ->where(['base_module' => $moduleId]); |
||
| 52 | if (!\App\User::getCurrentUserModel()->isAdmin()) { |
||
| 53 | $query->andWhere(['public' => 1]); |
||
| 54 | } |
||
| 55 | $rows = $query->createCommand(\App\Db::getInstance('admin'))->queryAllByGroup(1); |
||
| 56 | \App\Cache::save('Calendar-GetExtraSourcesList', $moduleId, $rows, \App\Cache::LONG); |
||
| 57 | return $rows; |
||
| 58 | } |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Get calendar extra source instance by id. |
||
| 62 | * |
||
| 63 | * @param int $id |
||
| 64 | * |
||
| 65 | * @return $this |
||
| 66 | */ |
||
| 67 | public static function getInstanceById(int $id) |
||
| 82 | } |
||
| 83 | |||
| 84 | /** |
||
| 85 | * Get calendar extra source clean instance by module name. |
||
| 86 | * |
||
| 87 | * @param string $moduleName |
||
| 88 | * |
||
| 89 | * @return $this |
||
| 90 | */ |
||
| 91 | public static function getCleanInstance(string $moduleName) |
||
| 92 | { |
||
| 93 | $className = Vtiger_Loader::getComponentClassName('Model', 'CalendarExtSource', $moduleName); |
||
| 94 | $handler = new $className(); |
||
| 95 | $handler->baseModuleName = $moduleName; |
||
| 96 | return $handler; |
||
| 97 | } |
||
| 98 | |||
| 99 | /** |
||
| 100 | * Get calendar extra sources data by id. |
||
| 101 | * |
||
| 102 | * @param int $id |
||
| 103 | * |
||
| 104 | * @return string[] |
||
| 105 | */ |
||
| 106 | public static function getById(int $id): array |
||
| 107 | { |
||
| 108 | if (\App\Cache::has('Calendar-GetExtraSourceById', $id)) { |
||
| 109 | return \App\Cache::get('Calendar-GetExtraSourceById', $id); |
||
| 110 | } |
||
| 111 | $row = (new \App\Db\Query())->from(self::EXTRA_SOURCE_TABLE) |
||
| 112 | ->where(['id' => $id]) |
||
| 113 | ->one(\App\Db::getInstance('admin')); |
||
| 114 | \App\Cache::save('Calendar-GetExtraSourceById', $id, $row, \App\Cache::LONG); |
||
| 115 | return $row; |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Save calendar extra sources. |
||
| 120 | * |
||
| 121 | * @return int |
||
| 122 | */ |
||
| 123 | public function save(): int |
||
| 124 | { |
||
| 125 | $dbCommand = \App\Db::getInstance('admin')->createCommand(); |
||
| 126 | if ($id = $this->get('id')) { |
||
| 127 | $dbCommand->update(self::EXTRA_SOURCE_TABLE, $this->getData(), [ |
||
| 128 | 'id' => $id |
||
| 129 | ])->execute(); |
||
| 130 | \App\Cache::save('Calendar-GetExtraSourceById', $id, $this->getData(), \App\Cache::LONG); |
||
| 131 | } else { |
||
| 132 | $params = $this->getData(); |
||
| 133 | $params['user_id'] = \App\User::getCurrentUserId(); |
||
| 134 | $dbCommand->insert(self::EXTRA_SOURCE_TABLE, $params) |
||
| 135 | ->execute(); |
||
| 136 | $id = \App\Db::getInstance('admin')->getLastInsertID(self::EXTRA_SOURCE_TABLE . '_id_seq'); |
||
| 137 | } |
||
| 138 | \App\Cache::delete('Calendar-GetExtraSourcesList', $this->get('base_module')); |
||
| 139 | return $id; |
||
| 140 | } |
||
| 141 | |||
| 142 | /** |
||
| 143 | * Delete calendar extra sources. |
||
| 144 | * |
||
| 145 | * @return bool |
||
| 146 | */ |
||
| 147 | public function delete(): bool |
||
| 148 | { |
||
| 149 | $dbCommand = \App\Db::getInstance('admin')->createCommand(); |
||
| 150 | $status = $dbCommand->delete(self::EXTRA_SOURCE_TABLE, ['id' => $this->get('id')])->execute(); |
||
| 151 | \App\Cache::delete('Calendar-GetExtraSourceById', $this->get('id')); |
||
| 152 | \App\Cache::delete('Calendar-GetExtraSourcesList', $this->get('base_module')); |
||
| 153 | return (bool) $status; |
||
| 154 | } |
||
| 155 | |||
| 156 | /** |
||
| 157 | * Get module model. |
||
| 158 | * |
||
| 159 | * @return Vtiger_Module_Model |
||
| 160 | */ |
||
| 161 | public function getModule(): Vtiger_Module_Model |
||
| 162 | { |
||
| 163 | if (!$this->targetModuleModel) { |
||
| 164 | $this->targetModuleModel = \Vtiger_Module_Model::getInstance($this->targetModuleName); |
||
| 165 | } |
||
| 166 | return $this->targetModuleModel; |
||
| 167 | } |
||
| 168 | |||
| 169 | /** |
||
| 170 | * Get extra sources query. |
||
| 171 | * |
||
| 172 | * @return \App\Db\Query |
||
| 173 | */ |
||
| 174 | protected function getExtraSourcesQuery(): ?App\Db\Query |
||
| 175 | { |
||
| 176 | if ( |
||
| 177 | !\App\Privilege::isPermitted($this->targetModuleName) |
||
| 178 | || !\App\CustomView::getCustomViewById($this->get('custom_view')) |
||
| 179 | ) { |
||
| 180 | return null; |
||
| 181 | } |
||
| 182 | $this->queryGenerator = new App\QueryGenerator($this->targetModuleName); |
||
| 183 | $this->queryGenerator->initForCustomViewById($this->get('custom_view')); |
||
| 184 | $this->targetModuleModel = $this->queryGenerator->getModuleModel(); |
||
| 185 | if ($this->get('include_filters')) { |
||
| 186 | $this->loadExtraSourcesQueryFilter(); |
||
| 187 | } |
||
| 188 | $this->queryGenerator->clearFields(); |
||
| 189 | $this->queryGenerator->setField('assigned_user_id'); |
||
| 190 | if ($this->get('field_label')) { |
||
| 191 | $this->nameFields = [$this->getModule()->getField($this->get('field_label'))->getName()]; |
||
| 192 | } else { |
||
| 193 | $this->nameFields = $this->getModule()->getNameFields(); |
||
| 194 | } |
||
| 195 | foreach ($this->nameFields as $field) { |
||
| 196 | $this->queryGenerator->setField($field); |
||
| 197 | } |
||
| 198 | $this->loadExtraSourcesQueryType(); |
||
| 199 | return $this->queryGenerator->createQuery(); |
||
| 200 | } |
||
| 201 | |||
| 202 | /** |
||
| 203 | * Load extra sources query condition by type. |
||
| 204 | * |
||
| 205 | * @return void |
||
| 206 | */ |
||
| 207 | protected function loadExtraSourcesQueryType(): void |
||
| 284 | } |
||
| 285 | } |
||
| 286 | |||
| 287 | /** |
||
| 288 | * Load extra sources query condition by type. |
||
| 289 | * |
||
| 290 | * @return void |
||
| 291 | */ |
||
| 292 | protected function loadExtraSourcesQueryFilter(): void |
||
| 293 | { |
||
| 294 | $conditions = []; |
||
| 295 | if (!empty($this->get('user')) && isset($this->get('user')['selectedIds'][0])) { |
||
| 296 | $selectedUsers = $this->get('user'); |
||
| 297 | $selectedIds = $selectedUsers['selectedIds']; |
||
| 298 | if ('all' !== $selectedIds[0]) { |
||
| 299 | $conditions[] = ['vtiger_crmentity.smownerid' => $selectedIds]; |
||
| 300 | $subQuery = (new \App\Db\Query())->select(['crmid']) |
||
| 301 | ->from('u_#__crmentity_showners') |
||
| 302 | ->where(['userid' => $selectedIds]); |
||
| 303 | $conditions[] = ['vtiger_crmentity.crmid' => $subQuery]; |
||
| 304 | } |
||
| 305 | if (isset($selectedUsers['excludedIds']) && 'all' === $selectedIds[0]) { |
||
| 306 | $conditions[] = ['not in', 'vtiger_crmentity.smownerid', $selectedUsers['excludedIds']]; |
||
| 307 | } |
||
| 308 | } |
||
| 309 | if ($conditions) { |
||
| 310 | $this->queryGenerator->addNativeCondition(array_merge(['or'], $conditions)); |
||
| 311 | } |
||
| 312 | } |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Get calendar extra source counter. |
||
| 316 | * |
||
| 317 | * @return int |
||
| 318 | */ |
||
| 319 | public function getExtraSourcesCount(): int |
||
| 320 | { |
||
| 321 | $privileges = Users_Privileges_Model::getCurrentUserPrivilegesModel(); |
||
| 322 | if ($privileges->hasModuleActionPermission($this->baseModuleName, 'CalendarExtraSources')) { |
||
| 323 | if ($query = $this->getExtraSourcesQuery()) { |
||
| 324 | return $query->count(); |
||
| 325 | } |
||
| 326 | } |
||
| 327 | return 0; |
||
| 328 | } |
||
| 329 | |||
| 330 | /** |
||
| 331 | * Get calendar extra source rows. |
||
| 332 | * |
||
| 333 | * @return array |
||
| 334 | */ |
||
| 335 | public function getRows(): array |
||
| 336 | { |
||
| 337 | $query = $this->getExtraSourcesQuery(); |
||
| 338 | $privileges = Users_Privileges_Model::getCurrentUserPrivilegesModel(); |
||
| 339 | if (!$query || !$privileges->hasModuleActionPermission($this->baseModuleName, 'CalendarExtraSources')) { |
||
| 340 | return []; |
||
| 341 | } |
||
| 342 | $dataReader = $query->createCommand()->query(); |
||
| 343 | $result = []; |
||
| 344 | while ($row = $dataReader->read()) { |
||
| 345 | $result[] = $this->formatRow($row); |
||
| 346 | } |
||
| 347 | $dataReader->close(); |
||
| 348 | return $result; |
||
| 349 | } |
||
| 350 | |||
| 351 | /** |
||
| 352 | * Format record data. |
||
| 353 | * |
||
| 354 | * @param array $row |
||
| 355 | * |
||
| 356 | * @return array |
||
| 357 | */ |
||
| 358 | protected function formatRow(array $row): array |
||
| 359 | { |
||
| 360 | $item = [ |
||
| 361 | 'id' => $row['id'], |
||
| 362 | 'editable' => false, |
||
| 363 | ]; |
||
| 364 | $this->formatDate($row, $item); |
||
| 365 | $title = ''; |
||
| 366 | foreach ($this->nameFields as $field) { |
||
| 367 | $title .= ' ' . \App\Purifier::encodeHtml($row[$field]); |
||
| 368 | } |
||
| 369 | $item['title'] = trim($title); |
||
| 370 | $item['backgroundColor'] = $this->get('color'); |
||
| 371 | $item['textColor'] = $this->get('textColor'); |
||
| 372 | $item['className'] = 'js-show-modal js-quick-detail-modal js-popover-tooltip--record ownerCBr_' . $row['assigned_user_id']; |
||
| 373 | $item['url'] = 'index.php?module=' . $this->targetModuleName . '&view=Detail&record=' . $row['id']; |
||
| 374 | return $item; |
||
| 375 | } |
||
| 376 | |||
| 377 | /** |
||
| 378 | * Format dates. |
||
| 379 | * |
||
| 380 | * @param array $row |
||
| 381 | * @param array $item |
||
| 382 | * |
||
| 383 | * @return void |
||
| 384 | */ |
||
| 385 | protected function formatDate(array $row, array &$item): void |
||
| 441 | } |
||
| 442 | } |
||
| 443 | } |
||
| 444 |
Loading history...
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.