13.11.12 ApplicationParameterManager::setCommonParameterValue()

13.11.12.1 Description

void setCommonParameterValue ( mixed $application,
                              string $parameterName,
                              string $value )

La valeur principale du paramètre $parameterName de l'application $application est positionnée avec la valeur $value fournie.

13.11.12.1.1 Avertissements

Aucun.

13.11.12.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.12.3 Valeur de retour

La méthode ne retourne rien.

13.11.12.4 Erreurs / Exceptions

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

13.11.12.5 Historique

Aucun.

13.11.12.6 Exemples

/* Affiche la valeur principale de CORE_LANG */
printf("CORE:CORE_LANG principal value = '%s'\n", ApplicationParameterManager::getCommonParameterValue('CORE', 'CORE_LANG'));
 
/* Positionne la valeur principale à 'en_US' */
try {
    ApplicationParameterManager::setCommonParameterValue('CORE', 'CORE_LANG', 'en_US');
} catch(\Dcp\ApplicationParameterManager\Exception $e) {
    printf("Error setting parameter's default value.");
    throw $e;
}
 
/* Affiche la valeur principale de CORE_LANG */
printf("CORE:CORE_LANG principal value = '%s'\n", ApplicationParameterManager::getCommonParameterValue('CORE', 'CORE_LANG'));

Sortie :

CORE:CORE_LANG principal value = 'fr_FR'
CORE:CORE_LANG principal value = 'en_US'

13.11.12.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.12.8 Voir aussi

Aucun.