Skip to content

Commit 34cac15

Browse files
committed
Minor: Update code documentation
1 parent 52ae100 commit 34cac15

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

main/inc/lib/api.lib.php

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9150,21 +9150,21 @@ function api_get_configuration_value($variable)
91509150
// Check if variable exists
91519151
if (isset($_configuration[$variable])) {
91529152
if (is_array($_configuration[$variable]) && api_is_multiple_url_enabled() && is_int(array_keys($_configuration[$variable])[0])) {
9153-
// It has been configured for at least one sub URL so we will not return the complete variable
9153+
// It has been configured for at least one sub URL, so we will not return the complete variable
91549154
/*
9155-
* The idea is that if the first level key of the configuration variable is an int
9156-
* then it is a multiURL configuration and if it's a string then it's a configuration that is not multiURL.
9157-
* For example if in app/config/configuration.php you have set :
9158-
* $_configuration['ticket_project_user_roles'] = [
9159-
* 'permissions' => [
9160-
* 1 => [17] // project_id = 1, STUDENT_BOSS = 17
9161-
* ]
9162-
* ];
9163-
* You do not want to enter in this bloc even if multiURL is activated because the option is configured globaly
9164-
* and you want to return the full array.
9165-
* The is_int is to consider only the option that are array and configured for multiURL
9166-
* which means there is an int as the first level key of the array.
9167-
*/
9155+
* The idea is that if the first level key of the configuration variable is an int
9156+
* then it is a multiURL configuration and if it's a string then it's a configuration that is not multiURL.
9157+
* For example if in app/config/configuration.php you have set :
9158+
* $_configuration['ticket_project_user_roles'] = [
9159+
* 'permissions' => [
9160+
* 1 => [17] // project_id = 1, STUDENT_BOSS = 17
9161+
* ]
9162+
* ];
9163+
* You do not want to enter this block even if multiURL is activated because the option is configured globally
9164+
* and you want to return the full array.
9165+
* The is_int is to consider only the option that are array and configured for multiURL
9166+
* which means there is an int as the first level key of the array.
9167+
*/
91689168
// Check if it exists for the sub portal
91699169
if (array_key_exists($urlId, $_configuration[$variable])) {
91709170
return $_configuration[$variable][$urlId];

0 commit comments

Comments
 (0)