| Conditions | 1 |
| Paths | 1 |
| Total Lines | 71 |
| Code Lines | 48 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 26 | public function test() |
||
| 27 | { |
||
| 28 | // create a user with initial data and extra field values |
||
| 29 | $loginName = 'testUser'.time(); |
||
| 30 | $userId = UserManager::create_user( |
||
| 31 | 'Initial first name', |
||
| 32 | 'Initial last name', |
||
| 33 | 5, |
||
| 34 | 'initial.email@local', |
||
| 35 | $loginName, |
||
| 36 | 'xXxxXxxXX' |
||
| 37 | ); |
||
| 38 | |||
| 39 | // create an extra field and initialise its value for the user |
||
| 40 | $extraFieldModel = new ExtraField('user'); |
||
| 41 | $extraFieldName = 'extraUserField'.time(); |
||
| 42 | $extraFieldId = $extraFieldModel->save( |
||
| 43 | [ |
||
| 44 | 'field_type' => ExtraField::FIELD_TYPE_TEXT, |
||
| 45 | 'variable' => $extraFieldName, |
||
| 46 | 'display_text' => $extraFieldName, |
||
| 47 | 'visible_to_self' => 1, |
||
| 48 | 'visible_to_others' => 1, |
||
| 49 | 'changeable' => 1, |
||
| 50 | 'filter' => 1, |
||
| 51 | ] |
||
| 52 | ); |
||
| 53 | SessionManager::update_session_extra_field_value($userId, $extraFieldName, 'extra field initial value'); |
||
| 54 | |||
| 55 | // update user with new data and extra field data |
||
| 56 | $newFirstName = 'New first name'; |
||
| 57 | $newLastName = 'New last name'; |
||
| 58 | $newStatus = 1; |
||
| 59 | $newEmail = 'new.address@local'; |
||
| 60 | $parameters = [ |
||
| 61 | 'firstname' => $newFirstName, |
||
| 62 | 'lastname' => $newLastName, |
||
| 63 | 'status' => $newStatus, |
||
| 64 | 'email' => $newEmail, |
||
| 65 | ]; |
||
| 66 | $extraFieldNewValue = 'extra field new value'; |
||
| 67 | $parameters['extra'] = [ |
||
| 68 | ['field_name' => $extraFieldName, 'field_value' => $extraFieldNewValue], |
||
| 69 | ]; |
||
| 70 | $parameters['loginname'] = $loginName; |
||
| 71 | $updated = $this->boolean($parameters); |
||
| 72 | $this->assertTrue($updated); |
||
| 73 | |||
| 74 | // assert the webservice reports an error with a non-existent login name |
||
| 75 | $parameters['loginname'] = 'santaClaus'; |
||
| 76 | $this->assertSame(get_lang('UserNotFound'), $this->errorMessageString($parameters)); |
||
| 77 | |||
| 78 | // compare each saved value to the original |
||
| 79 | /** @var User $user */ |
||
| 80 | $userManager = UserManager::getManager(); |
||
| 81 | $user = $userManager->find($userId); |
||
| 82 | $userManager->reloadUser($user); |
||
| 83 | $this->assertSame($newFirstName, $user->getFirstname()); |
||
| 84 | $this->assertSame($newLastName, $user->getLastname()); |
||
| 85 | $this->assertSame($newStatus, $user->getStatus()); |
||
| 86 | $this->assertSame($newEmail, $user->getEmail()); |
||
| 87 | |||
| 88 | // assert extra field values have been updated |
||
| 89 | $extraFieldValueModel = new ExtraFieldValue('user'); |
||
| 90 | $extraFieldValue = $extraFieldValueModel->get_values_by_handler_and_field_variable($userId, $extraFieldName); |
||
| 91 | $this->assertNotFalse($extraFieldValue); |
||
| 92 | $this->assertSame($extraFieldNewValue, $extraFieldValue['value']); |
||
| 93 | |||
| 94 | // clean up |
||
| 95 | UserManager::delete_user($userId); |
||
| 96 | $extraFieldModel->delete($extraFieldId); |
||
| 97 | } |
||
| 99 |