iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

make required fields configurable

This commit is contained in:
xuwhite 2023-11-03 15:15:44 +01:00 committed by GitHub
parent 1397fe90ce
commit 27323bfba5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 132 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
config/config.default.php
View File

@ -233,6 +233,16 @@ return [
// Users are able to sign up
'registration_enabled' => (bool) env('REGISTRATION_ENABLED', true),
// Required fields on sign-up page
'signup_required_fields' => [
'pronoun' => (bool) env('PRONOUN_REQUIRED', false),
'firstname' => (bool) env('FIRSTNAME_REQUIRED', false),
'lastname' => (bool) env('LASTNAME_REQUIRED', false),
'tshirt_size' => (bool) env('TSHIRT_SIZE_REQUIRED', true),
'mobile' => (bool) env('MOBILE_REQUIRED', false),
'dect' => (bool) env('DECT_REQUIRED', false),
],
// Only arrived angels can sign up for shifts
'signup_requires_arrival' => (bool) env('SIGNUP_REQUIRES_ARRIVAL', false),

6
includes/view/User_view.php
View File

@ -952,7 +952,11 @@ function render_user_tshirt_hint()
{
$goodie = GoodieType::from(config('goodie_type'));
$goodie_tshirt = $goodie === GoodieType::Tshirt;
if ($goodie_tshirt && !auth()->user()->personalData->shirt_size) {
if (
$goodie_tshirt
&& config('signup_required_fields')['tshirt_size']
&& !auth()->user()->personalData->shirt_size
) {
$text = __('You need to specify a tshirt size in your settings!');
return render_profile_link($text);
}

20
resources/lang/de_DE/additional.po
View File

@ -23,20 +23,20 @@ msgstr "Das angegebene Passwort ist zu kurz."
msgid "validation.login.required"
msgstr "Bitte gib einen Loginnamen an."
msgid "validation.pronoun.optional"
msgstr "Das Pronomen, das Du eingegeben hast, ist zu lang. Verwende maximal 15 Zeichen."
msgid "validation.pronoun.required"
msgstr "Bitte gebe dein Pronomen an."
msgid "validation.firstname.optional"
msgstr "Der von dir eingegebene Vorname ist zu lang. Verwende maximal 64 Zeichen."
msgid "validation.firstname.required"
msgstr "Bitte gebe deinen Vornamen an."
msgid "validation.lastname.optional"
msgstr "Der von dir eingegebene Vorname ist zu lang. Verwende maximal 64 Zeichen."
msgid "validation.lastname.required"
msgstr "Bitte gebe deinen Nachnamen an."
msgid "validation.mobile.optional"
msgstr "Der von dir eingegebene Handynummer ist zu lang. Verwende maximal 40 Zeichen."
msgid "validation.mobile.required"
msgstr "Bitte gebe deine Handynummer an."
msgid "validation.dect.optional"
msgstr "Der von dir eingegebene DECT-Nummer ist zu lang. Verwende maximal 40 Zeichen."
msgid "validation.dect.required"
msgstr "Bitte gebe deine DECT-Nummer an."
msgid "validation.username.required"
msgstr "Bitte gebe deinen Nick an."

20
resources/lang/en_US/additional.po
View File

@ -21,20 +21,20 @@ msgstr "The password entered is too short."
msgid "validation.login.required"
msgstr "The login name is required."
msgid "validation.pronoun.length"
msgstr "The pronoun you have entered is too long. Use a maximum of 15 characters."
msgid "validation.pronoun.required"
msgstr "Please enter your pronoun."
msgid "validation.firstname.length"
msgstr "The first name you have entered is too long. Use a maximum of 64 characters."
msgid "validation.firstname.required"
msgstr "Please enter your first name."
msgid "validation.lastname.length"
msgstr "The last name you have entered is too long. Use a maximum of 64 characters."
msgid "validation.lastname.required"
msgstr "Please enter your last name."
msgid "validation.mobile.optional"
msgstr "The mobile number you have entered is too long. Use a maximum of 40 characters."
msgid "validation.mobile.required"
msgstr "Please enter your mobile number."
msgid "validation.dect.optional"
msgstr "The DECT number you have entered is too long. Use a maximum of 40 characters."
msgid "validation.dect.required"
msgstr "Please enter your DECT number."
msgid "validation.username.required"
msgstr "Please enter your nick."

14
resources/views/pages/settings/profile.twig
View File

@ -28,6 +28,8 @@
{{ f.input('pronoun', __('settings.profile.pronoun'), {
'value': user.personalData.pronoun,
'max_length': 15,
'required': isPronounRequired,
'required_icon': isPronounRequired,
}) }}
{{ m.info(__('settings.profile.pronoun.info')) }}
</div>
@ -40,12 +42,16 @@
{{ f.input('first_name', __('settings.profile.firstname'), {
'value': user.personalData.first_name,
'max_length': 64,
'required': isFirstnameRequired,
'required_icon': isFirstnameRequired,
}) }}
</div>
<div class="col-sm-6">
{{ f.input('last_name', __('settings.profile.lastname'), {
'value': user.personalData.last_name,
'max_length': 64,
'required': isLastnameRequired,
'required_icon': isLastnameRequired,
}) }}
</div>
</div>
@ -82,6 +88,8 @@
{{ f.input('dect', __('general.dect'), {
'value': user.contact.dect,
'max_length': 40,
'required': isDectRequired,
'required_icon': isDectRequired,
}) }}
</div>
{% endif %}
@ -89,6 +97,8 @@
{{ f.input('mobile', __('settings.profile.mobile'), {
'value': user.contact.mobile,
'max_length': 40,
'required': isMobileRequired,
'required_icon': isMobileRequired,
}) }}
{% if config('enable_mobile_show') %}
{{ f.checkbox('mobile_show', __('settings.profile.mobile_show'), {
@ -141,8 +151,8 @@
<div class="col-12">
{{ f.select('shirt_size', __('settings.profile.shirt_size'), config('tshirt_sizes'), {
'selected': user.personalData.shirt_size,
'required': true,
'required_icon': true,
'required': isTShirtSizeRequired,
'required_icon': isTShirtSizeRequired,
'default_option': __('form.select_placeholder'),
}) }}
</div>

14
resources/views/pages/sign-up.twig
View File

@ -31,6 +31,8 @@
__('settings.profile.pronoun'),
{
'max_length': 15,
'required': isPronounRequired,
'required_icon': isPronounRequired,
'value': f.formData('pronoun', ''),
}
) }}
@ -162,6 +164,8 @@
{
'autocomplete': 'given-name',
'max_length': 64,
'required': isFirstnameRequired,
'required_icon': isFirstnameRequired,
'value': f.formData('firstname', ''),
}
) }}
@ -173,6 +177,8 @@
{
'autocomplete': 'family-name',
'max_length': 64,
'required': isLastnameRequired,
'required_icon': isLastnameRequired,
'value': f.formData('lastname', ''),
}
) }}
@ -227,8 +233,8 @@
tShirtSizes,
{
'default_option': __('form.select_placeholder'),
'required': true,
'required_icon': true,
'required': isTShirtSizeRequired,
'required_icon': isTShirtSizeRequired,
'selected': f.formData('tshirt_size', ''),
}
) }}
@ -242,6 +248,8 @@
{
'type': 'tel-national',
'max_length': 40,
'required': isMobileRequired,
'required_icon': isMobileRequired,
'value': f.formData('mobile', ''),
}
) }}
@ -265,6 +273,8 @@
{
'type': 'tel-local',
'max_length': 40,
'required': isDectRequired,
'required_icon': isDectRequired,
'value': f.formData('dect', ''),
}
) }}

26
src/Controllers/SettingsController.php
View File

@ -35,6 +35,7 @@ class SettingsController extends BaseController
public function profile(): Response
{
$user = $this->auth->user();
$requiredFields = $this->config->get('signup_required_fields');
return $this->response->withView(
'pages/settings/profile',
@ -43,6 +44,12 @@ class SettingsController extends BaseController
'user' => $user,
'goodie_tshirt' => $this->config->get('goodie_type') === GoodieType::Tshirt->value,
'goodie_enabled' => $this->config->get('goodie_type') !== GoodieType::None->value,
'isPronounRequired' => $requiredFields['pronoun'],
'isFirstnameRequired' => $requiredFields['firstname'],
'isLastnameRequired' => $requiredFields['lastname'],
'isTShirtSizeRequired' => $requiredFields['tshirt_size'],
'isMobileRequired' => $requiredFields['mobile'],
'isDectRequired' => $requiredFields['dect'],
]
);
}
@ -359,6 +366,12 @@ class SettingsController extends BaseController
return true;
}
private function isRequired(string $key): string
{
$requiredFields = $this->config->get('signup_required_fields');
return $requiredFields[$key] ? 'required' : 'optional';
}
/**
* @return string[]
*/
@ -366,11 +379,12 @@ class SettingsController extends BaseController
{
$goodie_tshirt = $this->config->get('goodie_type') === GoodieType::Tshirt->value;
$rules = [
'pronoun' => 'optional|max:15',
'first_name' => 'optional|max:64',
'last_name' => 'optional|max:64',
'dect' => 'optional|length:0:40', // dect/mobile can be purely numbers. "max" would have
'mobile' => 'optional|length:0:40', // checked their values, not their character length.
'pronoun' => $this->isRequired('pronoun') . '|max:15',
'first_name' => $this->isRequired('firstname') . '|max:64',
'last_name' => $this->isRequired('lastname') . '|max:64',
'dect' => $this->isRequired('dect') . '|length:0:40',
// dect/mobile can be purely numbers. "max" would have checked their values, not their character length.
'mobile' => $this->isRequired('mobile') . '|length:0:40',
'mobile_show' => 'optional|checked',
'email' => 'required|email|max:254',
'email_shiftinfo' => 'optional|checked',
@ -384,7 +398,7 @@ class SettingsController extends BaseController
$rules['planned_departure_date'] = 'optional|date:Y-m-d';
}
if ($goodie_tshirt) {
$rules['shirt_size'] = 'required|shirt_size';
$rules['shirt_size'] = $this->isRequired('tshirt_size') . '|shirt_size';
}
return $rules;
}

7
src/Controllers/SignUpController.php
View File

@ -79,6 +79,7 @@ class SignUpController extends BaseController
{
$goodieType = GoodieType::from($this->config->get('goodie_type'));
$preselectedAngelTypes = $this->determinePreselectedAngelTypes();
$requiredFields = $this->config->get('signup_required_fields');
// form-data-register-submit is a marker, that the form was submitted.
// It will be used for instance to use the default angel types or the user selected ones.
@ -101,6 +102,12 @@ class SignUpController extends BaseController
'isPronounEnabled' => $this->config->get('enable_pronoun'),
'isFullNameEnabled' => $this->config->get('enable_user_name'),
'isPlannedArrivalDateEnabled' => $this->config->get('enable_planned_arrival'),
'isPronounRequired' => $requiredFields['pronoun'],
'isFirstnameRequired' => $requiredFields['firstname'],
'isLastnameRequired' => $requiredFields['lastname'],
'isTShirtSizeRequired' => $requiredFields['tshirt_size'],
'isMobileRequired' => $requiredFields['mobile'],
'isDectRequired' => $requiredFields['dect'],
],
);
}

18
src/Factories/User.php
View File

@ -67,6 +67,12 @@ class User
return $this->config->get('buildup_start') ?? CarbonImmutable::now();
}
private function isRequired(string $key): string
{
$requiredFields = $this->config->get('signup_required_fields');
return $requiredFields[$key] ? 'required' : 'optional';
}
/**
* @param Array<string, mixed> $rawData
* @throws ValidationException
@ -82,7 +88,7 @@ class User
'email_news' => 'optional|checked',
'email_goody' => 'optional|checked',
// Using length here, because min/max would validate dect/mobile as numbers.
'mobile' => 'optional|length:0:40',
'mobile' => $this->isRequired('mobile') . '|length:0:40',
];
$isPasswordEnabled = $this->determineIsPasswordEnabled();
@ -96,14 +102,14 @@ class User
$isFullNameEnabled = $this->config->get('enable_user_name');
if ($isFullNameEnabled) {
$validationRules['firstname'] = 'optional|length:0:64';
$validationRules['lastname'] = 'optional|length:0:64';
$validationRules['firstname'] = $this->isRequired('firstname') . '|length:0:64';
$validationRules['lastname'] = $this->isRequired('lastname') . '|length:0:64';
}
$isPronounEnabled = $this->config->get('enable_pronoun');
if ($isPronounEnabled) {
$validationRules['pronoun'] = 'optional|max:15';
$validationRules['pronoun'] = $this->isRequired('pronoun') . '|max:15';
}
$isShowMobileEnabled = $this->config->get('enable_mobile_show');
@ -137,14 +143,14 @@ class User
if ($isDECTEnabled) {
// Using length here, because min/max would validate dect/mobile as numbers.
$validationRules['dect'] = 'optional|length:0:40';
$validationRules['dect'] = $this->isRequired('dect') . '|length:0:40';
}
$goodieType = GoodieType::from($this->config->get('goodie_type'));
$isGoodieTShirt = $goodieType === GoodieType::Tshirt;
if ($isGoodieTShirt) {
$validationRules['tshirt_size'] = 'required|shirt-size';
$validationRules['tshirt_size'] = $this->isRequired('tshirt_size') . '|shirt-size';
}
$data = $this->validate($rawData, $validationRules);

10
tests/Unit/Controllers/SettingsControllerTest.php
View File

@ -106,6 +106,7 @@ class SettingsControllerTest extends ControllerTest
/**
* @covers \Engelsystem\Controllers\SettingsController::saveProfile
* @covers \Engelsystem\Controllers\SettingsController::getSaveProfileRules
* @covers \Engelsystem\Controllers\SettingsController::isRequired
*/
public function testSaveProfile(): void
{
@ -934,12 +935,21 @@ class SettingsControllerTest extends ControllerTest
'de_DE' => 'Deutsch',
];
$tshirt_sizes = ['S' => 'Small'];
$requiredFields = [
'pronoun' => false,
'firstname' => false,
'lastname' => false,
'tshirt_size' => true,
'mobile' => false,
'dect' => false,
];
$this->config = new Config([
'min_password_length' => 6,
'themes' => $themes,
'locales' => $languages,
'tshirt_sizes' => $tshirt_sizes,
'goodie_type' => GoodieType::Goodie->value,
'signup_required_fields' => $requiredFields,
]);
$this->app->instance('config', $this->config);
$this->app->instance(Config::class, $this->config);

24
tests/Utils/SignUpConfig.php
View File

@ -11,6 +11,14 @@ final class SignUpConfig
{
public static function setMaximumConfig(Config $config): void
{
$requiredFields = [
'pronoun' => false,
'firstname' => false,
'lastname' => false,
'tshirt_size' => true,
'mobile' => false,
'dect' => false,
];
$config->set('registration_enabled', true);
$config->set('enable_password', true);
$config->set('enable_pronoun', true);
@ -27,10 +35,25 @@ final class SignUpConfig
$config->set('enable_user_name', true);
$config->set('enable_mobile_show', true);
$config->set('enable_dect', true);
$config->set('signup_required_fields', $requiredFields);
}
public static function setMinimumConfig(Config $config): void
{
$requiredFields = [
'pronoun' => false,
'firstname' => false,
'lastname' => false,
'tshirt_size' => true,
'mobile' => false,
'dect' => false,
];
$requiredFields['pronoun'] = false;
$requiredFields['firstname'] = false;
$requiredFields['lastname'] = false;
$requiredFields['tshirt_size'] = true;
$requiredFields['mobile'] = false;
$requiredFields['dect'] = false;
$config->set('registration_enabled', true);
$config->set('enable_password', true);
$config->set('enable_pronoun', false);
@ -43,5 +66,6 @@ final class SignUpConfig
$config->set('enable_user_name', false);
$config->set('enable_mobile_show', false);
$config->set('enable_dect', false);
$config->set('signup_required_fields', $requiredFields);
}
}