13.11.9 ApplicationParameterManager::getUserParameterDefaultValue()

La méthode getUserParameterDefaultValue() permet de récupérer la valeur principale d'un paramètre d'une application.

13.11.9.1 Description

string getUserParameterDefaultValue ( mixed $application,
                                     string $parameterName )

Retourne la valeur principale du paramètre $parameterName appartenant à l'application $application.

13.11.9.1.1 Avertissements

Aucun.

13.11.9.2 Liste des paramètres

(string|int|Application) application: Le nom, l'identifiant ou l'objet Application de l'application dont on souhaite avoir la valeur principale d'un de ses paramètres.
(string) parameterName: Le nom du paramètre dont on souhaite avoir la valeur principale.

13.11.9.3 Valeur de retour

Retourne une chaîne de caractères avec la valeur principale du paramètre, ou null si le paramètre ou l'application demandé ne sont pas trouvés.

13.11.9.4 Erreurs / Exceptions

Aucune.

13.11.9.5 Historique

Aucun.

13.11.9.6 Exemples

/* Valeur principale du paramètre CORE_LANG */
$paramVal = ApplicationParameterManager::getUserParameterDefaultValue('CORE', 'CORE_LANG');
printf("CORE:CORE_LANG principal value    = '%s'\n", $paramVal);
 
/* Valeur personnalisée de CORE_LANG pour l'utilisateur courant */
$paramVal = ApplicationParameterManager::getUserParameterValue('CORE', 'CORE_LANG');
printf("CORE:CORE_LANG personalized value = '%s'\n", $paramVal);
 
/* Valeur finale du paramètre CORE_LANG appliquée sur l'utilisateur */
$paramVal = ApplicationParameterManager::getParameterValue('CORE', 'CORE_LANG');
printf("CORE:CORE_LANG final value        = '%s'\n", $paramVal);

Sortie :

CORE:CORE_LANG principal value    = 'fr_FR'
CORE:CORE_LANG personalized value = ''
CORE:CORE_LANG final value        = 'fr_FR'

Cet exemple montre que la valeur finale appliquée sur l'utilisateur est la valeur principale, puisqu'il n'y a pas de valeur personnalisée explicitement déclarée sur l'utilisateur.

13.11.9.7 Notes

L'argument application peut aussi être la constante ApplicationParameterManager::CURRENT_APPLICATION (pour référencer l'application courante) ou ApplicationParameterManager::GLOBAL_PARAMETER (pour adresser des paramètres globaux).
Cette méthode est équivalente à un appel à la méthode getCommonParameterValue().

13.11.9.8 Voir aussi

Source : API/Class_ApplicationParameterManager/Method_getUserParameterDefaultValue.md Dynacase Platform 3.2 | Core Manuel de référence, version 3.2 édition 13, © Anakeen Labs <labs@anakeen.com>