13.11.10 ApplicationParameterManager::getUserParameterValue()

13.11.10.1 Description

string static getUserParameterValue ( mixed $application,
                                     string $parameterName,
                                     string $userId = null )

Retourne la valeur personnalisée du paramètre $parameterName appartenant à l'application $application.

Pour obtenir la valeur principale d'un paramètre : voir méthode getCommonParameterValue().

13.11.10.1.1 Avertissements

Aucun.

13.11.10.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 personnalisée d'un de ses paramètres.

(string) parameterName

Le nom du paramètre dont on souhaite avoir la valeur personnalisée.

(int) userId

L'identifiant de l'utilisateur pour lequel on souhaite avoir la valeur personnalisée du paramètre. Si l'identifiant n'est pas spécifié (ou si null est spécifié), alors c'est l'identifiant de l'utilisateur actuellement connecté qui est utilisé.

13.11.10.3 Valeur de retour

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

13.11.10.4 Erreurs / Exceptions

Aucune.

13.11.10.5 Historique

Aucun.

13.11.10.6 Exemples

/* Valeur principale de CORE_LANG */
printf("CORE:CORE_LANG principal value    = '%s'\n", ApplicationParameterManager::getCommonParameterValue('CORE', 'CORE_LANG'));
 
/* Valeur principale de CORE_LANG pour l'utilisateur courant */
printf("CORE:CORE_LANG personalized value = '%s'\n", ApplicationParameterManager::getUserParameterValue('CORE', 'CORE_LANG'));
 
/* Valeur appliquée de CORE_LANG pour l'utilisateur courant */
printf("CORE:CORE_LANG applied value      = '%s'\n", ApplicationParameterManager::getParameterValue('CORE', 'CORE_LANG'));

Sortie :

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

13.11.10.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).

13.11.10.8 Voir aussi

• ApplicationParameterManager::getCommonParameterValue
• ApplicationParameterManager::getParameterValue