Manuel de référence

# Classe ContextParameterManager

La classe ContextParameterManager permet de gérer les paramètres du contexte : récupérer ou positionner la valeur d'un paramètre.

# Liste des méthodes

# setValue

void setValue(string $ns,
              string $name,
              string|int $val,
              $type = Param::PARAM_GLB)

Cette méthode définit la valeur d'un paramètre du contexte.

# Liste des paramètres

ns (string)

espace de nommage dans lequel le paramètre est défini.

name (string)

nom du paramètre

val (string|int|array)

nouvelle valeur du paramètre

type

type du paramètre

# Erreurs / Exceptions

Si jamais le paramètre demandé n'existe pas, alors une exception de type Anakeen\Exception est levée. Si jamais la modification du paramètre demandé retourne une erreur, alors une exception de type Anakeen\Exception est levée.

# Exemple

use Anakeen\Core\Internal\ContextParameterManager;

ContextParameterManager::setValue("Core", self::CONFIGDIRECTORIES, json_encode(array_unique($configPath)));

# setUserValue

void setUserValue(string $ns, string $name, $val, int $accountId = 0)

Cette méthode définit la valeur d'un paramètre utilisateur

# Liste des paramètres

ns (string)

espace de nommage dans lequel le paramètre est défini.

name (string)

nom du paramètre.

val (string|int|array)

nouvelle valeur du paramètre. Note: si null, la valeur du paramètre utilisateur est supprimée.

accountId (int)

identifiant de l'utilisateur. Note : si accountId vaut 0, alors c'est l'utilisateur courant qui est désigné.

# Erreurs / Exceptions

Si jamais le paramètre demandé n'existe pas, alors une exception de type Anakeen\Exception est levée. Si jamais la modification du paramètre demandé retourne une erreur, alors une exception de type Anakeen\Exception est levée.

# Exemple

use Anakeen\Core\Internal\ContextParameterManager;
ContextParameterManager::setUserValue("Core", "CORE_LANG", "fr_FR");

# getNs

string getNs(string $name)

Cette méthode retourne l'espace de nommage d'un paramètre.

# Liste des paramètres

name (string)

Nom du paramètre à recherché.

# Valeur de retour

Si un paramètre est trouvé, et qu'il est unique, alors la méthode retourne l'espace de nommage. Sinon, la méthode renvoie une chaîne de caractère vide.

# Exemple

  • Récupérer l'espace de nommage du paramètre CORE_LANG:
use Anakeen\Core\Internal\ContextParameterManager;

$ns = ContextParameterManager::getNs("CORE_LANG");
print("namespace = %s", $ns);
  • Résultat:
namespace = Core

# getValue

string|int|array|null getValue(string $ns, string $name, $def = null)

Cette méthode récupère la valeur d'un paramètre dans un espace de nommage.

# Liste des paramètres

ns (string)

espace de nommage dans lequel le paramètre est défini.

name (string)

nom du paramètre.

def

valeur par défaut égal à null si le paramètre n'existe pas.

# Valeur de retour

Si jamais le paramètre demandé, n'existe pas ou n'est pas trouvé, alors la méthode retourne la valeur null définie par défaut.
Si jamais le paramètre est trouvé, la valeur du paramètre est alors retournée.

# Exemple

  • Récupérer la valeur du paramètre CORE_LANG dans l'espace de nommage Core:
use Anakeen\Core\Internal\ContextParameterManager;

$val = ContextParameterManager::getValue("Core","CORE_LANG");
print("valeur du paramètre = %s", $val);
  • Résultat
valeur du paramètre = fr_FR

# setVolatile

void setVolatile(string $ns, string $name, string|int|array $val)

Cette méthode permet de rendre un paramètre volatile.

# Liste des paramètres

ns (string)

espace de nommage dans lequel le paramètre est défini.

name (string)

nom du paramètre.

val (string|int|array)

valeur du paramètre.

# Exemple

use Anakeen\Core\Internal\ContextParameterManager;
ContextParameterManager::setVolatile("Core", "CORE_LANG", "fr_fr");
$val = ContextParameterManager::getValue("Core", "CORE_LANG");
print ("valeur du paramètre = %s", $val);
  • Résultat:
valeur du paramètre = fr_fr

← Classe SearchElements →