nextcloud /
polls
| Total Complexity | 41 |
| Total Lines | 249 |
| Duplicated Lines | 0 % |
| Changes | 5 | ||
| Bugs | 0 | Features | 1 |
Complex classes like UserGroupClass 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 UserGroupClass, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 32 | class UserGroupClass implements \JsonSerializable { |
||
| 33 | public const TYPE = 'generic'; |
||
| 34 | public const TYPE_PUBLIC = 'public'; |
||
| 35 | public const TYPE_EXTERNAL = 'external'; |
||
| 36 | public const TYPE_CIRCLE = Circle::TYPE; |
||
| 37 | public const TYPE_CONTACT = Contact::TYPE; |
||
| 38 | public const TYPE_CONTACTGROUP = ContactGroup::TYPE; |
||
| 39 | public const TYPE_EMAIL = Email::TYPE; |
||
| 40 | public const TYPE_GROUP = Group::TYPE; |
||
| 41 | public const TYPE_USER = User::TYPE; |
||
| 42 | |||
| 43 | private $l10n; |
||
| 44 | |||
| 45 | /** @var string */ |
||
| 46 | protected $id; |
||
| 47 | |||
| 48 | /** @var string */ |
||
| 49 | protected $type; |
||
| 50 | |||
| 51 | /** @var string */ |
||
| 52 | protected $displayName = ''; |
||
| 53 | |||
| 54 | /** @var string */ |
||
| 55 | protected $description = ''; |
||
| 56 | |||
| 57 | /** @var string */ |
||
| 58 | protected $emailAddress = ''; |
||
| 59 | |||
| 60 | /** @var string */ |
||
| 61 | protected $language = ''; |
||
| 62 | |||
| 63 | /** @var string */ |
||
| 64 | protected $organisation = ''; |
||
| 65 | |||
| 66 | /** @var string */ |
||
| 67 | protected $icon = ''; |
||
| 68 | |||
| 69 | /** @var bool */ |
||
| 70 | protected $isNoUser = true; |
||
| 71 | |||
| 72 | /** @var string[] */ |
||
| 73 | protected $categories = []; |
||
| 74 | |||
| 75 | public function __construct( |
||
| 89 | } |
||
| 90 | |||
| 91 | public function getId(): string { |
||
| 92 | return $this->id; |
||
| 93 | } |
||
| 94 | |||
| 95 | /** |
||
| 96 | * @return string |
||
| 97 | */ |
||
| 98 | public function getPublicId(): string { |
||
| 99 | return $this->id; |
||
| 100 | } |
||
| 101 | |||
| 102 | public function getUser(): string { |
||
| 103 | return $this->id; |
||
| 104 | } |
||
| 105 | |||
| 106 | public function getType(): string { |
||
| 107 | return $this->type; |
||
| 108 | } |
||
| 109 | |||
| 110 | public function getLanguage(): string { |
||
| 111 | return $this->language; |
||
| 112 | } |
||
| 113 | |||
| 114 | public function getDisplayName(): string { |
||
| 115 | return $this->displayName; |
||
| 116 | } |
||
| 117 | |||
| 118 | public function getDescription(): string { |
||
| 119 | return $this->description; |
||
| 120 | } |
||
| 121 | |||
| 122 | public function getIcon(): string { |
||
| 123 | return $this->icon; |
||
| 124 | } |
||
| 125 | |||
| 126 | public function getEmailAddress(): string { |
||
| 127 | return $this->emailAddress ? $this->emailAddress : ''; |
||
| 128 | } |
||
| 129 | |||
| 130 | public function getOrganisation(): string { |
||
| 131 | return $this->organisation; |
||
| 132 | } |
||
| 133 | |||
| 134 | /** |
||
| 135 | * @return string[] |
||
| 136 | * |
||
| 137 | * @psalm-return array<array-key, string> |
||
| 138 | */ |
||
| 139 | public function getCategories(): array { |
||
| 140 | return $this->categories; |
||
| 141 | } |
||
| 142 | |||
| 143 | public function getIsNoUser(): bool { |
||
| 145 | } |
||
| 146 | |||
| 147 | public function setType(string $type): string { |
||
| 148 | $this->type = $type; |
||
| 149 | return $this->type; |
||
| 150 | } |
||
| 151 | |||
| 152 | public function setDisplayName(string $displayName): string { |
||
| 155 | } |
||
| 156 | |||
| 157 | public function setDescription(string $description): string { |
||
| 158 | $this->description = $description; |
||
| 159 | return $this->description; |
||
| 160 | } |
||
| 161 | |||
| 162 | public function setEmailAddress(string $emailAddress) : string { |
||
| 163 | $this->emailAddress = $emailAddress; |
||
| 164 | return $this->emailAddress; |
||
| 165 | } |
||
| 166 | |||
| 167 | public function setLanguage(string $language): string { |
||
| 170 | } |
||
| 171 | |||
| 172 | public function setOrganisation($organisation): string { |
||
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * serach all possible sharees - use ISearch to respect autocomplete restrictions |
||
| 179 | * |
||
| 180 | * Undocumented function long description |
||
| 181 | * |
||
| 182 | * @param type var Description |
||
| 183 | * @return return type |
||
| 184 | */ |
||
| 185 | public static function search(string $query = ''): array { |
||
| 186 | $items = []; |
||
| 187 | $types = [ |
||
| 188 | IShare::TYPE_USER, |
||
| 189 | IShare::TYPE_GROUP |
||
| 190 | ]; |
||
| 191 | if (Circle::isEnabled() && class_exists('\OCA\Circles\ShareByCircleProvider')) { |
||
| 192 | $types[] = IShare::TYPE_CIRCLE; |
||
| 193 | } |
||
| 194 | |||
| 195 | list($result, $more) = self::getContainer()->query(ISearch::class)->search($query, $types, false, 200, 0); |
||
| 196 | |||
| 197 | foreach ($result['users'] as $item) { |
||
| 198 | $items[] = new User($item['value']['shareWith']); |
||
| 199 | } |
||
| 200 | |||
| 201 | foreach ($result['exact']['users'] as $item) { |
||
| 202 | $items[] = new User($item['value']['shareWith']); |
||
| 203 | } |
||
| 204 | |||
| 205 | foreach ($result['groups'] as $item) { |
||
| 206 | $items[] = new Group($item['value']['shareWith']); |
||
| 207 | } |
||
| 208 | |||
| 209 | foreach ($result['exact']['groups'] as $item) { |
||
| 210 | $items[] = new Group($item['value']['shareWith']); |
||
| 211 | } |
||
| 212 | |||
| 213 | $items = array_merge($items, Contact::search($query)); |
||
| 214 | $items = array_merge($items, ContactGroup::search($query)); |
||
| 215 | |||
| 216 | foreach ($result['circles'] as $item) { |
||
| 217 | $items[] = new Circle($item['value']['shareWith']); |
||
| 218 | } |
||
| 219 | |||
| 220 | foreach ($result['exact']['circles'] as $item) { |
||
| 221 | $items[] = new Circle($item['value']['shareWith']); |
||
| 222 | } |
||
| 223 | |||
| 224 | return $items; |
||
| 225 | } |
||
| 226 | |||
| 227 | /** |
||
| 228 | * @return array |
||
| 229 | */ |
||
| 230 | public function getMembers() { |
||
| 231 | return []; |
||
| 232 | } |
||
| 233 | |||
| 234 | protected static function getContainer() { |
||
| 235 | $app = \OC::$server->query(Application::class); |
||
| 236 | |||
| 237 | return $app->getContainer(); |
||
| 238 | } |
||
| 239 | |||
| 240 | /** |
||
| 241 | * @return Circle|Contact|ContactGroup|Email|GenericUser|Group|User |
||
| 242 | */ |
||
| 243 | public static function getUserGroupChild(string $type, string $id, string $displayName = '', string $emailAddress = '') { |
||
| 244 | switch ($type) { |
||
| 245 | case Group::TYPE: |
||
| 246 | return new Group($id); |
||
| 247 | case Circle::TYPE: |
||
| 248 | return new Circle($id); |
||
| 249 | case Contact::TYPE: |
||
| 250 | return new Contact($id); |
||
| 251 | case ContactGroup::TYPE: |
||
| 252 | return new ContactGroup($id); |
||
| 253 | case User::TYPE: |
||
| 254 | return new User($id); |
||
| 255 | case Email::TYPE: |
||
| 256 | return new Email($id); |
||
| 257 | case self::TYPE_PUBLIC: |
||
| 258 | return new GenericUser($id, self::TYPE_PUBLIC); |
||
| 259 | case self::TYPE_EXTERNAL: |
||
| 260 | return new GenericUser($id, self::TYPE_EXTERNAL, $displayName, $emailAddress); |
||
| 261 | default: |
||
| 262 | throw new InvalidShareTypeException('Invalid share type (' . $type . ')'); |
||
| 263 | } |
||
| 264 | } |
||
| 265 | |||
| 266 | public function jsonSerialize(): array { |
||
| 281 | ]; |
||
| 282 | } |
||
| 283 | } |
||
| 284 |
Loading history...
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths