YetiForceCompany /
YetiForceCRM
| Total Complexity | 62 |
| Total Lines | 378 |
| Duplicated Lines | 0 % |
| Coverage | 66.41% |
| Changes | 0 | ||
Complex classes like Module 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 Module, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | class Module |
||
| 16 | { |
||
| 17 | /** |
||
| 18 | * Cache for tabdata.php. |
||
| 19 | * |
||
| 20 | * @var array |
||
| 21 | */ |
||
| 22 | protected static $tabdataCache; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * Init tabdata from file. |
||
| 26 | */ |
||
| 27 | public static function init() |
||
| 31 | } |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Init tabdata form db. |
||
| 35 | 7 | */ |
|
| 36 | public static function initFromDb() |
||
| 37 | 7 | { |
|
| 38 | 7 | static::$tabdataCache = static::getModuleMeta(); |
|
| 39 | 7 | static::$tabdataCache['tabName'] = array_flip(static::$tabdataCache['tabId']); |
|
| 40 | } |
||
| 41 | 5868 | ||
| 42 | /** |
||
| 43 | 5868 | * Gets entity info. |
|
| 44 | 5868 | * |
|
| 45 | 5868 | * @param string $moduleName |
|
| 46 | * |
||
| 47 | * @return array|null |
||
| 48 | */ |
||
| 49 | public static function getEntityInfo(string $moduleName = null): ?array |
||
| 50 | 5868 | { |
|
| 51 | 5844 | return self::getEntitiesInfo()[$moduleName] ?? null; |
|
| 52 | } |
||
| 53 | |||
| 54 | /** |
||
| 55 | 62 | * Gets all entities data. |
|
| 56 | 62 | * |
|
| 57 | 62 | * @param array |
|
| 58 | 62 | */ |
|
| 59 | 62 | public static function getEntitiesInfo(): array |
|
| 60 | 62 | { |
|
| 61 | 62 | $cacheName = 'ModuleEntityInfo'; |
|
| 62 | 62 | if (!Cache::has($cacheName, '')) { |
|
| 63 | 62 | $entityInfos = []; |
|
| 64 | $dataReader = (new \App\Db\Query())->from('vtiger_entityname')->createCommand()->query(); |
||
| 65 | 62 | while ($row = $dataReader->read()) { |
|
| 66 | 62 | $row['fieldnameArr'] = $row['fieldname'] ? explode(',', $row['fieldname']) : []; |
|
| 67 | $row['searchcolumnArr'] = $row['searchcolumn'] ? explode(',', $row['searchcolumn']) : []; |
||
| 68 | $entityInfos[$row['modulename']] = $row; |
||
| 69 | 62 | } |
|
| 70 | return Cache::save($cacheName, '', $entityInfos); |
||
|
Bug
Best Practice
introduced
by
|
|||
| 71 | } |
||
| 72 | return Cache::get($cacheName, ''); |
||
| 73 | } |
||
| 74 | |||
| 75 | public static function getAllEntityModuleInfo($sort = false) |
||
| 84 | } |
||
| 85 | |||
| 86 | protected static $isModuleActiveCache = []; |
||
| 87 | |||
| 88 | /** |
||
| 89 | * Function to check whether the module is active. |
||
| 90 | * |
||
| 91 | * @param string $moduleName |
||
| 92 | * |
||
| 93 | * @return bool |
||
| 94 | 15 | */ |
|
| 95 | public static function isModuleActive(string $moduleName): bool |
||
| 96 | 15 | { |
|
| 97 | 15 | if (isset(static::$isModuleActiveCache[$moduleName])) { |
|
| 98 | return static::$isModuleActiveCache[$moduleName]; |
||
| 99 | 3 | } |
|
| 100 | 1 | if (\in_array($moduleName, ['CustomView', 'Users', 'Import', 'com_vtiger_workflow', 'PickList'])) { |
|
| 101 | static::$isModuleActiveCache[$moduleName] = true; |
||
| 102 | 1 | return true; |
|
| 103 | } |
||
| 104 | 2 | $moduleId = static::getModuleId($moduleName); |
|
| 105 | 2 | $isActive = (isset(static::$tabdataCache['tabPresence'][$moduleId]) && 0 == static::$tabdataCache['tabPresence'][$moduleId]); |
|
| 106 | 2 | static::$isModuleActiveCache[$moduleName] = $isActive; |
|
| 107 | return $isActive; |
||
| 108 | 2 | } |
|
| 109 | |||
| 110 | /** |
||
| 111 | * Get module id by module name. |
||
| 112 | * |
||
| 113 | * @param string $moduleName |
||
| 114 | * |
||
| 115 | * @return bool|int |
||
| 116 | */ |
||
| 117 | public static function getModuleId($moduleName) |
||
| 118 | 127 | { |
|
| 119 | return static::$tabdataCache['tabId'][$moduleName] ?? false; |
||
| 120 | 127 | } |
|
| 121 | |||
| 122 | /** |
||
| 123 | * Get module nane by module id. |
||
| 124 | * |
||
| 125 | * @param int $tabId |
||
| 126 | * |
||
| 127 | * @return bool|string |
||
| 128 | */ |
||
| 129 | public static function getModuleName($tabId) |
||
| 130 | 446 | { |
|
| 131 | return static::$tabdataCache['tabName'][$tabId] ?? false; |
||
| 132 | 446 | } |
|
| 133 | |||
| 134 | /** |
||
| 135 | * Get module owner by module id. |
||
| 136 | * |
||
| 137 | * @param int $tabId |
||
| 138 | * |
||
| 139 | * @return int |
||
| 140 | */ |
||
| 141 | public static function getModuleOwner($tabId) |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Get all module names. |
||
| 148 | * |
||
| 149 | * @return string[] |
||
| 150 | */ |
||
| 151 | public static function getAllModuleNames() |
||
| 152 | { |
||
| 153 | return static::$tabdataCache['tabName']; |
||
| 154 | } |
||
| 155 | |||
| 156 | /** |
||
| 157 | * Function to get the list of module for which the user defined sharing rules can be defined. |
||
| 158 | * |
||
| 159 | * @param array $eliminateModules |
||
| 160 | * |
||
| 161 | * @return array |
||
| 162 | */ |
||
| 163 | public static function getSharingModuleList($eliminateModules = false) |
||
| 173 | 2 | } |
|
| 174 | |||
| 175 | /** |
||
| 176 | * Get sql for name in display format. |
||
| 177 | * |
||
| 178 | * @param string $moduleName |
||
| 179 | * |
||
| 180 | * @return string |
||
| 181 | */ |
||
| 182 | public static function getSqlForNameInDisplayFormat($moduleName) |
||
| 198 | } |
||
| 199 | |||
| 200 | /** |
||
| 201 | * Function to get a action id for a given action name. |
||
| 202 | * |
||
| 203 | * @param string $action |
||
| 204 | * |
||
| 205 | * @return int|null |
||
| 206 | */ |
||
| 207 | public static function getActionId($action) |
||
| 227 | 7 | } |
|
| 228 | |||
| 229 | /** |
||
| 230 | * Get module meta data. |
||
| 231 | * |
||
| 232 | * @return array |
||
| 233 | */ |
||
| 234 | public static function getModuleMeta() |
||
| 259 | 7 | ]; |
|
| 260 | } |
||
| 261 | |||
| 262 | /** |
||
| 263 | * Function to create file about modules. |
||
| 264 | * |
||
| 265 | * @throws \App\Exceptions\NoPermitted |
||
| 266 | */ |
||
| 267 | public static function createModuleMetaFile() |
||
| 268 | 7 | { |
|
| 269 | Cache::delete('moduleTabs', 'all'); |
||
| 270 | 7 | Cache::delete('getTrackingModules', 'all'); |
|
| 271 | 7 | $filename = ROOT_DIRECTORY . '/user_privileges/tabdata.php'; |
|
| 272 | 7 | if (file_exists($filename)) { |
|
| 273 | 7 | if (is_writable($filename)) { |
|
| 274 | 7 | $moduleMeta = static::getModuleMeta(); |
|
| 275 | 7 | $content = '$tab_seq_array=' . Utils::varExport($moduleMeta['tabPresence']) . ";\n"; |
|
| 276 | 7 | $content .= 'return ' . Utils::varExport($moduleMeta) . ";\n"; |
|
| 277 | 7 | if (!Utils::saveToFile($filename, $content)) { |
|
| 278 | throw new Exceptions\NoPermitted("Cannot write file ($filename)"); |
||
| 279 | } |
||
| 280 | } else { |
||
| 281 | Log::error("The file $filename is not writable"); |
||
| 282 | } |
||
| 283 | } else { |
||
| 284 | Log::error("The file $filename does not exist"); |
||
| 285 | } |
||
| 286 | 7 | static::initFromDb(); |
|
| 287 | } |
||
| 288 | |||
| 289 | 7 | /** |
|
| 290 | 7 | * Function changes the module type. |
|
| 291 | * |
||
| 292 | * @param string $moduleName |
||
| 293 | * @param int $type |
||
| 294 | */ |
||
| 295 | public static function changeType(string $moduleName, int $type) |
||
| 296 | { |
||
| 297 | $moduleModel = \Vtiger_Module_Model::getInstance($moduleName); |
||
| 298 | if ($moduleModel && $moduleModel->changeType($type) && PrivilegeUtil::modifyPermissions($moduleName, ['RecordPdfInventory'], \Vtiger_Module_Model::ADVANCED_TYPE === $type)) { |
||
| 299 | UserPrivilegesFile::recalculateAll(); |
||
| 300 | } |
||
| 301 | } |
||
| 302 | |||
| 303 | /** |
||
| 304 | * Get all module names by filter. |
||
| 305 | * |
||
| 306 | * @param bool $isEntityType |
||
| 307 | * @param bool $showRestricted |
||
| 308 | * @param bool|int $presence |
||
| 309 | * |
||
| 310 | * @return string[] |
||
| 311 | */ |
||
| 312 | public static function getAllModuleNamesFilter($isEntityType = true, $showRestricted = false, $presence = false): array |
||
| 313 | { |
||
| 314 | $modules = []; |
||
| 315 | foreach (\vtlib\Functions::getAllModules($isEntityType, $showRestricted, $presence) as $value) { |
||
| 316 | $modules[$value['name']] = Language::translate($value['name'], $value['name']); |
||
| 317 | } |
||
| 318 | return $modules; |
||
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * Function to get the list of all accessible modules for Quick Create. |
||
| 323 | * |
||
| 324 | * @param bool $restrictList |
||
| 325 | * @param bool $tree |
||
| 326 | * |
||
| 327 | * @return array List of Vtiger_Module_Model instances |
||
| 328 | */ |
||
| 329 | public static function getQuickCreateModules($restrictList = false, $tree = false): array |
||
| 393 | } |
||
| 394 | } |
||
| 395 | |||
| 396 | Module::init(); |
||
| 397 |
Loading history...
