13.11.15 ApplicationParameterManager::setUserParameterValue()
La méthode setUserParameterValue()
permet d'écrire la valeur personnalisée
d'un paramètre utilisateur d'une application.
13.11.15.1 Description
void static setUserParameterValue ( mixed $application, string $parameterName, string $value, int $userid = null bool $check = true )
13.11.15.1.1 Avertissements
Aucun.
13.11.15.2 Liste des paramètres
- (string|int|Application)
application
- Le nom, l'identifiant ou l'objet
Application
de l'application dont on souhaite écrire la valeur personnalisée d'un de ses paramètres. - (string)
parameterName
- Le nom du paramètre dont on souhaite écrire la valeur personnalisée.
- (string)
value
- La valeur à inscrire comme valeur personnalisée pour ce paramètre.
- (int)
userId
- L'identifiant de l'utilisateur pour lequel on souhaite écrire 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é. - (bool)
check
- Permet de vérifier (
true
) ou non (false
) si le paramètre spécifié est bien un paramètre utilisateur.
13.11.15.3 Valeur de retour
La méthode ne retourne rien.
13.11.15.4 Erreurs / Exceptions
Si le paramètre n'existe pas, est incorrect, ou si le paramètre n'est pas un
paramètre utilisateur et que check
est à true
, alors une exception
(\Dcp\ApplicationParameterManager\Exception
) est levée.
13.11.15.5 Historique
Aucun.
13.11.15.6 Exemples
/* Changer la langue par défaut de l'utilisateur courant epar 'en_US' */ ApplicationParameterManager::setUserParameterValue('CORE', 'CORE_LANG', 'en_US');
13.11.15.7 Notes
- L'argument
application
peut aussi être la constanteApplicationParameterManager::CURRENT_APPLICATION
(pour l'application courante) ouApplicationParameterManager::GLOBAL_PARAMETER
pour adresser des paramètres globaux.
13.11.15.8 Voir aussi
Aucun.