13.6.3.13 Doc::getAttribute()

13.6.3.13.1 Description

BasicAttribute|bool(false) & getAttribute ( string $idAttr,
                                           mixed & $oa = null )

La méthode getAttribute permet d'obtenir l'objet PHP (classe BasicAttribute) d'un attribut du document.

13.6.3.13.1.1 Avertissements

Aucun.

13.6.3.13.2 Liste des paramètres

(string) idAttr

Le nom de l'attribut dont on souhaite obtenir l'objet.

[out] (mixed) oa

oa permet de spécifier une variable qui contiendra une référence à la valeur retournée par la méthode.

Cet argument est présent pour compatibilité par rapport à l'historique de la méthode.

13.6.3.13.3 Valeur de retour

La méthode retourne un objet PHP de la classe BasicAttribute si l'attribut demandé existe ou le booléen false si l'attribut demandé n'existe pas.

13.6.3.13.4 Erreurs / Exceptions

Si l'attribut demandé n'existe pas, le booléen false est retourné.

13.6.3.13.5 Historique

Aucun.

13.6.3.13.6 Exemples

• Exemple #1

 /*
  * Obtenir le type de l'attribut `montant`
  */
$oa = $doc->getAttribute(\Dcp\AttributeIdentifiers\Facture::montant);
printf("L'attribut '%s' est de type '%s'.", $oa->id, $oa->type);

Résultat :

L'attribut 'montant' est de type 'money'.

13.6.3.13.7 Notes

L'attribut demandé peut-être un attribut déclaré sur la famille du document ou bien un attribut déclaré sur une famille mère. La famille d'origine de l'attribut est alors consultable via la propriété docid de l'objet de attribut qui contient l'identifiant de la famille qui déclare cet attribut.

Cette fonction permet entre autre de modifier les propriétés d'un attributs à la volée, ce qui permet de modifier :

• son libellé, s'il n'est pas traduit,
• sa visibilité,
• ses propriétés.

Généralement, ces modifications sont faites lors de la preEdition du document.

13.6.3.13.8 Voir aussi

• attribut