13.11.5 ApplicationParameterManager::getParameter()

13.11.5.1 Description

array static getParameter ( mixed $application,
                           string $parameterName )

Retourne un array contenant les propriétés de la définition du paramètre de l'application.

13.11.5.1.1 Avertissements

Cette méthode retourne la définition du paramètre et non la valeur (principale ou personnalisée) de celui-ci.

13.11.5.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 d'un de ses paramètres.

(string) parameterName

Le nom du paramètre dont on souhaite avoir la définition.

13.11.5.3 Valeur de retour

Retourne un array contenant les propriétés de la définition du paramètre.

array(
    'name'    => $paramName,        /* Nom du paramètre */
    'isuser'  => 'Y' | 'N',         /* Paramètre personnalisable ? */
    'isstyle' => 'Y' | 'N',         /* Paramètre de style ? */
    'isglob'  => 'Y' | 'N',         /* Paramètre global ? */
    'appid'   => $applicationId,    /* Id de l'application */
    'desc'    => $paramDescription, /* Description du paramètre */
    'kind'    => $paramKind         /* Type du paramètre */
)

13.11.5.4 Erreurs / Exceptions

Si le paramètre ou l'application spécifié n'est pas trouvé, alors une exception \Dcp\ApplicationParameterManager\Exception est levée.

13.11.5.5 Historique

Aucun.

13.11.5.6 Exemples

try {
    $paramDef = ApplicationParameterManager::getParameter('CORE', 'CORE_LANG');
} catch (\Dcp\ApplicationParameterManager\Exception $e) {
    printf("Parameter or application not found.\n");
    throw $e;
}
var_export($paramDef);

Sortie :

$ ./wsh.php --api=test
array (
  'name' => 'CORE_LANG',
  'isuser' => 'Y',
  'isstyle' => 'N',
  'isglob' => 'Y',
  'appid' => '1',
  'descr' => 'language',
  'kind' => 'enum(en_US|fr_FR)',
)

13.11.5.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.5.8 Voir aussi

Aucun.