YetiForceCompany /
YetiForceCRM
| Total Complexity | 97 |
| Total Lines | 409 |
| Duplicated Lines | 0 % |
| Coverage | 34.15% |
| Changes | 0 | ||
Complex classes like Users_Privileges_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 Users_Privileges_Model, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | class Users_Privileges_Model extends Users_Record_Model |
||
| 16 | { |
||
| 17 | /** |
||
| 18 | * Function to get the Display Name for the record. |
||
| 19 | * |
||
| 20 | * @return string - Entity Display Name for the record |
||
| 21 | */ |
||
| 22 | public function getName(): string |
||
| 23 | { |
||
| 24 | if (!isset($this->label)) { |
||
| 25 | $entityData = \App\Module::getEntityInfo('Users'); |
||
| 26 | $separator = $entityData['separator'] ?? ' '; |
||
| 27 | $labelName = []; |
||
| 28 | foreach ($entityData['fieldnameArr'] as $columnName) { |
||
| 29 | $fieldModel = $this->getModule()->getFieldByColumn($columnName); |
||
| 30 | $labelName[] = $fieldModel->getDisplayValue($this->get($fieldModel->getName()), $this->getId(), $this, true); |
||
| 31 | } |
||
| 32 | $this->label = \App\Purifier::encodeHtml(implode($separator, $labelName)); |
||
| 33 | } |
||
| 34 | return $this->label; |
||
| 35 | } |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Function to get the Global Read Permission for the user. |
||
| 39 | * |
||
| 40 | * @return <Number> 0/1 |
||
|
Documentation
Bug
introduced
by
|
|||
| 41 | */ |
||
| 42 | protected function getGlobalReadPermission() |
||
| 43 | { |
||
| 44 | $profileGlobalPermissions = $this->get('profile_global_permission'); |
||
| 45 | |||
| 46 | return $profileGlobalPermissions[Settings_Profiles_Module_Model::GLOBAL_ACTION_VIEW]; |
||
| 47 | } |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Function to get the Global Write Permission for the user. |
||
| 51 | * |
||
| 52 | * @return <Number> 0/1 |
||
| 53 | */ |
||
| 54 | protected function getGlobalWritePermission() |
||
| 55 | { |
||
| 56 | $profileGlobalPermissions = $this->get('profile_global_permission'); |
||
| 57 | |||
| 58 | return $profileGlobalPermissions[Settings_Profiles_Module_Model::GLOBAL_ACTION_EDIT]; |
||
| 59 | } |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Function to check if the user has Global Read Permission. |
||
| 63 | * |
||
| 64 | * @return bool true/false |
||
| 65 | */ |
||
| 66 | public function hasGlobalReadPermission() |
||
| 71 | } |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Function to check if the user has Global Write Permission. |
||
| 75 | * |
||
| 76 | * @return bool true/false |
||
| 77 | */ |
||
| 78 | public function hasGlobalWritePermission() |
||
| 79 | { |
||
| 80 | return $this->isAdminUser() || Settings_Profiles_Module_Model::IS_PERMITTED_VALUE === $this->getGlobalWritePermission(); |
||
| 81 | } |
||
| 82 | |||
| 83 | public function hasGlobalPermission($actionId) |
||
| 84 | { |
||
| 85 | if (Settings_Profiles_Module_Model::GLOBAL_ACTION_VIEW == $actionId) { |
||
| 86 | return $this->hasGlobalReadPermission(); |
||
| 87 | } |
||
| 88 | if (Settings_Profiles_Module_Model::GLOBAL_ACTION_EDIT == $actionId) { |
||
| 89 | return $this->hasGlobalWritePermission(); |
||
| 90 | } |
||
| 91 | return false; |
||
| 92 | } |
||
| 93 | |||
| 94 | /** |
||
| 95 | * Function to check whether the user has access to a given module by tabid. |
||
| 96 | * |
||
| 97 | * @param int $mixed |
||
| 98 | * |
||
| 99 | * @return bool true/false |
||
| 100 | */ |
||
| 101 | public function hasModulePermission($mixed) |
||
| 106 | } |
||
| 107 | |||
| 108 | /** |
||
| 109 | * Function to check whether the user has access to the specified action/operation on a given module by tabid. |
||
| 110 | * |
||
| 111 | 3 | * @param <Number> $tabId |
|
| 112 | * @param <String/Number> $action |
||
| 113 | 3 | * @param mixed $mixed |
|
| 114 | 3 | * |
|
| 115 | * @return bool true/false |
||
| 116 | 3 | */ |
|
| 117 | 3 | public function hasModuleActionPermission($mixed, $action) |
|
| 129 | } |
||
| 130 | |||
| 131 | /** |
||
| 132 | 6 | * Static Function to get the instance of the User Privileges model from the given list of key-value array. |
|
| 133 | * |
||
| 134 | 6 | * @param <Array> $valueMap |
|
| 135 | 6 | * |
|
| 136 | 6 | * @return \Users_Privileges_Model object |
|
| 137 | */ |
||
| 138 | 6 | public static function getInstance($valueMap) |
|
| 139 | { |
||
| 140 | 6 | $instance = new self(); |
|
| 141 | foreach ($valueMap as $key => $value) { |
||
| 142 | $instance->{$key} = $value; |
||
| 143 | } |
||
| 144 | $instance->setData($valueMap); |
||
| 145 | $instance->setModule('Users'); |
||
| 146 | return $instance; |
||
| 147 | } |
||
| 148 | |||
| 149 | protected static $userPrivilegesModelCache = []; |
||
| 150 | |||
| 151 | /** |
||
| 152 | 16 | * Static Function to get the instance of the User Privileges model, given the User id. |
|
| 153 | * |
||
| 154 | 16 | * @param <Number> $userId |
|
| 155 | * @param mixed|null $module |
||
| 156 | * |
||
| 157 | * @return \Users_Privileges_Model object |
||
| 158 | 16 | */ |
|
| 159 | 12 | public static function getInstanceById($userId, $module = null) |
|
| 160 | { |
||
| 161 | 6 | if (empty($userId)) { |
|
| 162 | 6 | return null; |
|
| 163 | 6 | } |
|
| 164 | if (isset(self::$userPrivilegesModelCache[$userId])) { |
||
| 165 | 6 | return self::$userPrivilegesModelCache[$userId]; |
|
| 166 | 6 | } |
|
| 167 | $valueMap = App\User::getPrivilegesFile($userId); |
||
| 168 | 6 | if (\is_array($valueMap['user_info'])) { |
|
| 169 | $valueMap = array_merge($valueMap, $valueMap['user_info']); |
||
| 170 | } |
||
| 171 | $instance = self::getInstance($valueMap); |
||
| 172 | $instance->setId($userId); |
||
| 173 | self::$userPrivilegesModelCache[$userId] = $instance; |
||
| 174 | return $instance; |
||
| 175 | } |
||
| 176 | 14 | ||
| 177 | /** |
||
| 178 | 14 | * Static function to get the User Privileges Model for the current user. |
|
| 179 | * |
||
| 180 | * @return \Users_Privileges_Model object |
||
| 181 | */ |
||
| 182 | public static function getCurrentUserPrivilegesModel() |
||
| 183 | 1 | { |
|
| 184 | return self::getInstanceById(App\User::getCurrentUserId()); |
||
| 185 | 1 | } |
|
| 186 | 1 | ||
| 187 | protected static $lockEditCache = []; |
||
| 188 | |||
| 189 | 1 | public static function checkLockEdit($moduleName, Vtiger_Record_Model $recordModel) |
|
| 190 | 1 | { |
|
| 191 | $recordId = $recordModel->getId(); |
||
| 192 | if (isset(self::$lockEditCache[$moduleName . $recordId])) { |
||
| 193 | return self::$lockEditCache[$moduleName . $recordId]; |
||
| 194 | } |
||
| 195 | 1 | $return = false; |
|
| 196 | 1 | if (empty($recordId)) { |
|
| 197 | 1 | self::$lockEditCache[$moduleName . $recordId] = $return; |
|
| 198 | 1 | return $return; |
|
| 199 | } |
||
| 200 | Vtiger_Loader::includeOnce('~~modules/com_vtiger_workflow/include.php'); |
||
| 201 | Vtiger_Loader::includeOnce('~~modules/com_vtiger_workflow/VTEntityMethodManager.php'); |
||
| 202 | $workflows = (new VTWorkflowManager())->getWorkflowsForModule($moduleName, VTWorkflowManager::$BLOCK_EDIT); |
||
| 203 | if (\count($workflows)) { |
||
| 204 | foreach ($workflows as &$workflow) { |
||
| 205 | 1 | if ($workflow->evaluate($recordModel)) { |
|
| 206 | $return = true; |
||
| 207 | 1 | } |
|
| 208 | } |
||
| 209 | } |
||
| 210 | self::$lockEditCache[$moduleName . $recordId] = $return; |
||
| 211 | return $return; |
||
| 212 | } |
||
| 213 | |||
| 214 | /** |
||
| 215 | * Clear LockEdit Cache. |
||
| 216 | * |
||
| 217 | * @param string $cacheName |
||
| 218 | */ |
||
| 219 | public static function clearLockEditCache(string $cacheName = '') |
||
| 225 | } |
||
| 226 | } |
||
| 227 | |||
| 228 | /** |
||
| 229 | 5778 | * Clear user cache. |
|
| 230 | * |
||
| 231 | 5778 | * @param int|bool $userId |
|
| 232 | 5778 | */ |
|
| 233 | 5778 | public static function clearCache($userId = false) |
|
| 234 | { |
||
| 235 | self::$lockEditCache = []; |
||
| 236 | if ($userId) { |
||
| 237 | 5778 | unset(self::$userPrivilegesModelCache[$userId]); |
|
| 238 | } else { |
||
| 239 | self::$userPrivilegesModelCache = []; |
||
| 240 | } |
||
| 241 | } |
||
| 242 | |||
| 243 | /** |
||
| 244 | * Function to set Shared Owner. |
||
| 245 | 25 | * |
|
| 246 | * @param int|array|string $userIds |
||
| 247 | 25 | * @param int $record |
|
| 248 | */ |
||
| 249 | 25 | public static function setSharedOwner($userIds, $record) |
|
| 250 | 25 | { |
|
| 251 | $saveFull = true; |
||
| 252 | $db = \App\Db::getInstance(); |
||
| 253 | 25 | if ('SaveAjax' == \App\Request::_get('action') && \App\Request::_has('field') && 'shownerid' != \App\Request::_get('field')) { |
|
| 254 | 25 | $saveFull = false; |
|
| 255 | 25 | } |
|
| 256 | 25 | if ($saveFull) { |
|
| 257 | $db->createCommand()->delete('u_#__crmentity_showners', ['crmid' => $record])->execute(); |
||
| 258 | if (empty($userIds)) { |
||
| 259 | return false; |
||
| 260 | } |
||
| 261 | if (!\is_array($userIds) && $userIds) { |
||
| 262 | $userIds = explode(',', $userIds); |
||
| 263 | } |
||
| 264 | foreach (array_unique($userIds) as $userId) { |
||
| 265 | $db->createCommand()->insert('u_#__crmentity_showners', [ |
||
| 266 | 'crmid' => $record, |
||
| 267 | 'userid' => $userId, |
||
| 268 | ])->execute(); |
||
| 269 | } |
||
| 270 | \App\Cache::delete('SharedOwnerFieldValue', $record); |
||
| 271 | } |
||
| 272 | } |
||
| 273 | |||
| 274 | public static function isPermittedByUserId($userId, $moduleName, $actionName = '', $record = false) |
||
| 275 | { |
||
| 276 | return \App\Privilege::isPermitted($moduleName, $actionName, $record, $userId); |
||
| 277 | } |
||
| 278 | |||
| 279 | /** |
||
| 280 | * Get parent record id. |
||
| 281 | * |
||
| 282 | * @param int $record |
||
| 283 | * @param string|bool $moduleName |
||
| 284 | * @param int $type |
||
| 285 | * @param type $actionid |
||
| 286 | * |
||
| 287 | * @return int|bool |
||
| 288 | */ |
||
| 289 | public static function getParentRecord($record, $moduleName = false, $type = 1, $actionid = false) |
||
| 412 | } |
||
| 413 | |||
| 414 | /** |
||
| 415 | * Get profiles ids. |
||
| 416 | * |
||
| 417 | * @return array |
||
| 418 | */ |
||
| 419 | public function getProfiles() |
||
| 424 | } |
||
| 425 | } |
||
| 426 |
Loading history...
