13.11.4 ApplicationParameterManager::getCommonParameterValue()

13.11.4.1 Description

string static getCommonParameterValue ( mixed $application,
                                       string $parameterName )

Retourne la valeur principale du paramètre $parameterName défini sur l'application $application.

Pour obtenir la valeur personnalisée d'un utilisateur : voir la méthode getUserParameterValue().

13.11.4.1.1 Avertissements

Aucun.

13.11.4.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.4.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é n'est pas trouvé.

13.11.4.4 Erreurs / Exceptions

Aucune.

13.11.4.5 Historique

Aucun.

13.11.4.6 Exemples

/* En utilisant le nom de l'application */
printf("CORE:CORE_START_APP = '%s'\n", ApplicationParameterManager::getCommonParameterValue('CORE', 'CORE_START_APP'));
 
/* ou en utilisant l'objet Application de l'action courante */
printf("CORE:CORE_START_APP = '%s'\n", ApplicationParameterManager::getCommonParameterValue($action->parent, 'CORE_START_APP'));

Sortie :

CORE:CORE_START_APP = 'APP_SWITCHER'
CORE:CORE_START_APP = 'APP_SWITCHER'

13.11.4.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.4.8 Voir aussi

• ApplicationParameterManager::getUserParameterValue()