Complex classes like User 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 User, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 27 | class User |
||
| 28 | { |
||
| 29 | use AssertionTrait; |
||
| 30 | /** |
||
| 31 | * @var FieldLayout|null |
||
| 32 | */ |
||
| 33 | private $fieldLayout; |
||
| 34 | /** |
||
| 35 | * @var Field[] |
||
| 36 | */ |
||
| 37 | private $fields = []; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * @param SamlResponse $response |
||
| 41 | * @return UserElement |
||
| 42 | * @throws InvalidMessage |
||
| 43 | * @throws UserException |
||
| 44 | */ |
||
| 45 | public function getByResponse(SamlResponse $response, ProviderRecord $serviceProvider, Settings $settings) |
||
| 76 | |||
| 77 | /** |
||
| 78 | * @param ProviderIdentityRecord $identity |
||
| 79 | * @return bool |
||
| 80 | * @throws UserException |
||
| 81 | * @throws \Throwable |
||
| 82 | */ |
||
| 83 | public function login(\flipbox\saml\sp\records\ProviderIdentityRecord $identity) |
||
| 106 | |||
| 107 | /** |
||
| 108 | * @param UserElement $user |
||
| 109 | * @param SamlResponse $response |
||
| 110 | * @param ProviderRecord $idp |
||
| 111 | * @param Settings $settings |
||
| 112 | * @throws UserException |
||
| 113 | * @throws \Throwable |
||
| 114 | * @throws \craft\errors\ElementNotFoundException |
||
| 115 | * @throws \yii\base\Exception |
||
| 116 | */ |
||
| 117 | 3 | public function sync( |
|
| 137 | |||
| 138 | /** |
||
| 139 | * @param UserElement $user |
||
| 140 | * @return bool |
||
| 141 | * @throws UserException |
||
| 142 | * @throws \Throwable |
||
| 143 | * @throws \craft\errors\ElementNotFoundException |
||
| 144 | * @throws \yii\base\Exception |
||
| 145 | */ |
||
| 146 | 3 | protected function save(UserElement $user) |
|
| 157 | |||
| 158 | /** |
||
| 159 | * Response Based Methods |
||
| 160 | */ |
||
| 161 | |||
| 162 | /** |
||
| 163 | * @param UserElement $user |
||
| 164 | * @param SamlResponse $response |
||
| 165 | * @param ProviderRecord $idp |
||
| 166 | * @param Settings $settings |
||
| 167 | * @throws UserException |
||
| 168 | * @throws \Throwable |
||
| 169 | */ |
||
| 170 | 3 | protected function construct( |
|
| 210 | |||
| 211 | /** |
||
| 212 | * @param UserElement $user |
||
| 213 | * @param SamlResponse $response |
||
| 214 | * @return UserElement |
||
| 215 | */ |
||
| 216 | 3 | protected function transform( |
|
| 256 | |||
| 257 | /** |
||
| 258 | * @param UserElement $user |
||
| 259 | * @param $attributeName |
||
| 260 | * @param $attributeValue |
||
| 261 | * @param $craftProperty |
||
| 262 | */ |
||
| 263 | 3 | protected function assignProperty( |
|
| 299 | |||
| 300 | /** |
||
| 301 | * @param UserElement $user |
||
| 302 | * @return Field|null |
||
| 303 | */ |
||
| 304 | 3 | protected function getFieldLayoutField(UserElement $user, $fieldHandle) |
|
| 320 | |||
| 321 | /** |
||
| 322 | * @param UserElement $user |
||
| 323 | * @param string $name |
||
| 324 | * @param mixed $value |
||
| 325 | */ |
||
| 326 | 3 | private function setSimpleProperty(UserElement $user, $name, $value) |
|
| 345 | |||
| 346 | /************************************************** |
||
| 347 | * Craft User Methods |
||
| 348 | **************************************************/ |
||
| 349 | |||
| 350 | /** |
||
| 351 | * @param $username |
||
| 352 | * @return UserElement |
||
| 353 | * @throws UserException |
||
| 354 | */ |
||
| 355 | protected function find($username) |
||
| 359 | |||
| 360 | /** |
||
| 361 | * @param $username |
||
| 362 | * @return UserElement |
||
| 363 | * @throws UserException |
||
| 364 | */ |
||
| 365 | protected function forceGet($username) |
||
| 387 | |||
| 388 | /** |
||
| 389 | * @param $usernameOrEmail |
||
| 390 | * @param bool $archived |
||
| 391 | * @return array|bool|\craft\base\ElementInterface|UserElement|null |
||
| 392 | */ |
||
| 393 | protected function getByUsernameOrEmail($usernameOrEmail, $archived = false) |
||
| 408 | |||
| 409 | private function getAttributeValue($attributeValue) |
||
| 418 | } |
||
| 419 |
Since your code implements the magic setter
_set, this function will be called for any write access on an undefined variable. You can add the@propertyannotation to your class or interface to document the existence of this variable.Since the property has write access only, you can use the @property-write annotation instead.
Of course, you may also just have mistyped another name, in which case you should fix the error.
See also the PhpDoc documentation for @property.