N°9661 - feat(Utils): Add validation to GetConfigurationValue

[Hipska]

Base information

Question	Answer
Related to a SourceForge thread / Another PR / Combodo ticket?	N/A
Type of change?	Enhancement

Objective

When retrieving settings, you sometimes need to additional type checking validation. The objective is to reduce this as much as possible.

Before:

$sStopOnError = Utils::GetConfigurationValue('stop_on_synchro_error', 'no');
if (($sStopOnError != 'yes') && ($sStopOnError != 'no')) {
	Utils::Log(LOG_WARNING, "Unexpected value '$sStopOnError' for the parameter 'stop_on_synchro_error'. Will NOT stop on error. The expected values for this parameter are 'yes' or 'no'.");
}
$bStopOnError = ($sStopOnError == 'yes');

After:

$bStopOnError = Utils::GetConfigurationValue('stop_on_synchro_error', 'no', FILTER_VALIDATE_BOOLEAN);

Proposed solution

Use php's integrated functionality to filter/validate variables by adding an optional filter flag to the GetConfigurationValue method. Current behaviour is not altered.

Checklist before requesting a review

• I have performed a self-review of my code, and that it's compliant with Combodo's guidelines
• I have tested all changes I made on an iTop instance
• I have added a unit test, otherwise I have explained why I couldn't
• I have made sure the PR is clear and detailled enough so anyone can understand the real purpose without digging in the code

[jf-cbd]

Hey @Hipska, thanks for this PR and its associated tests :) in case of invalid value, it doesn't seem to be error thrown (or logs), is it on purpose ?

[Hipska]

No, it returns the default value or null if default is left out or invalid.

Do you want it to log something when this happens? (didn't seem necessary to me)

[jf-cbd]

Thank you for your answer. If a user set a filter, he'll probably expect that an error is thrown in case of invalid value - rather than making a fallback on default value (not only a silent log) - and a log would also be appreciated.

[Hipska]

Okay, so throw exception on invalid value and only return default if no value set?

[jf-cbd]

Yep that's it (exception + log in case of invalid value) :)