13.6.3.18 Doc::getFamilyParameterValue()

13.6.3.18.1 Description

string getFamilyParameterValue ( string $idp,
                                 string $def = "" )

La méthode getFamilyParameterValue permet d'obtenir la valeur des paramètres de la famille du document courant.

13.6.3.18.1.1 Avertissements

Aucun.

13.6.3.18.2 Liste des paramètres

(string) idp

Le nom du paramètre dont on souhaite obtenir la valeur.

(string) def

def permet de spécifier la valeur par défaut retournée par la méthode si le nom du paramètre idp n'existe pas.

Par défaut, la valeur par défaut est une chaîne vide.

13.6.3.18.3 Valeur de retour

La méthode retourne la valeur du paramètre demandé, ou la valeur par défaut def si le paramètre demandé n'existe pas.

Dans le cas où le paramètre est défini sur une famille parente et que la valeur pour la famille est vide, alors la valeur de la famille parente sera retournée. La recherche de la valeur se fait sur toute l'ascendance jusqu'à trouver une valeur non vide. Si en définitive, la valeur des parents est aussi vide alors la valeur def sera retournée.

13.6.3.18.4 Erreurs / Exceptions

Si l'attribut demandé n'existe pas, la valeur par défaut def est retournée.

13.6.3.18.5 Historique

13.6.3.18.5.1 Release 3.2.5

La méthode getFamilyParameterValue remplace la méthode précédemment nommée getParamValue.

L'utilisation de getParamValue est obsolète depuis la version 3.2.5 de dynacase-core.

13.6.3.18.6 Exemples

• Exemple #1

La famille Facture comporte un paramètre qui permet de spécifier la valeur du taux de TVA :

/*
 * Lire le taux de TVA défini sur le paramètre TAUX_TVA de la famille
 * du document `$facture`.
 */
$tva = $facture->getFamilyParameterValue('TAUX_TVA', 0);
if ($tva <= 0) {
    throw new Exception(sprintf("Le taux de TVA doit être > 0 !"));
}

13.6.3.18.7 Notes

Aucune.

13.6.3.18.8 Voir aussi

• Pour trouver la valeur d'un paramètre applicatif getParameterValue