13.11.6 ApplicationParameterManager::getParameters()

La méthode getParameters() permet de récupérer la définition de tous les paramètres d'une application.

13.11.6.1 Description

array[] static getParameters ( mixed $application )

Retourne une liste de array contenant la définition des paramètres de l'application.

13.11.6.1.1 Avertissements

Aucun.

13.11.6.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 définition de tous ses paramètres.

13.11.6.3 Valeur de retour

Retourne une liste de array de définition de paramètres :

array(
    0 => array(
        'name' => …,
        …
        ),
    1 => array(
        'name' => …,
        …
        ),
    …
)

Voir structure du array() de définition des paramètres dans valeur de retour de getParameter().

13.11.6.4 Erreurs / Exceptions

Si l'application n'est pas trouvée ou si aucun paramètre n'est trouvé, une exception \Dcp\ApplicationParameterManager\Exception est levée.

13.11.6.5 Historique

Aucun.

13.11.6.6 Exemples

try {
    $paramDefList = ApplicationParameterManager::getParameters('CORE');
} catch(\Dcp\ApplicationParameterManager\Exception $e) {
    printf("Application not found or no parameters found.");
    throw $e;
}
foreach ($paramDefList as $paramDef) {
    printf("name = '%s', isuser = '%s', kind = '%s'\n", $paramDef['name'], $paramDef['isuser'], $paramDef['kind']);
}

Sortie :

name = 'INIT', isuser = 'N', kind = 'text'
name = 'CORE_LOGLEVEL', isuser = 'N', kind = 'text'
name = 'VERSION', isuser = 'N', kind = 'static'
…
name = 'CORE_ALLOW_GUEST', isuser = 'N', kind = 'enum(yes|no)'
name = 'CORE_MAILACTION', isuser = 'N', kind = 'text'
name = 'CORE_LANG', isuser = 'Y', kind = 'enum(en_US|fr_FR)'

13.11.6.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.6.8 Voir aussi

×
nouveauté