13.11.14 ApplicationParameterManager::setUserParameterDefaultValue()

La méthode setUserParameterDefaultValue() permet d'écrire la valeur principale d'un paramètre utilisateur d'une application.

13.11.14.1 Description

void static setUserParameterDefaultValue ( mixed $application,
                                          string $parameterName,
                                          string $value )

13.11.14.1.1 Avertissements

Aucun.

13.11.14.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 principale d'un de ses paramètres.
(string) parameterName
Le nom du paramètre dont on souhaite écrire la valeur principale.
(string) value
La valeur à inscrire comme valeur principale pour ce paramètre.

13.11.14.3 Valeur de retour

La méthode ne retourne rien.

13.11.14.4 Erreurs / Exceptions

Si le paramètre n'existe pas ou est incorrect, alors une exception (\Dcp\ApplicationParameterManager\Exception) est levée.

13.11.14.5 Historique

Aucun.

13.11.14.6 Exemples

/*
 * Change la langue par défaut à 'en_US' pour tous les utilisateurs qui
 * n'ont pas de valeur personnalisée.
 */
ApplicationParameterManager::setUserParameterDefaultValue('CORE', 'CORE_LANG', 'en_US');

13.11.14.7 Notes

  • L'argument application peut aussi être la constante ApplicationParameterManager::CURRENT_APPLICATION (pour l'application courante) ou ApplicationParameterManager::GLOBAL_PARAMETER pour adresser des paramètres globaux.

  • Cette méthode est équivalente à un appel à la méthode setCommonParameterValue().

13.11.14.8 Voir aussi

Aucun.

×
nouveauté