13.6.3.39 Doc::viewattr()

13.6.3.39.1 Description

void viewattr ( string $target     = "_self", 
                  bool $ulink      = true, 
                  bool $abstract   = false, 
                  bool $viewhidden = false)

Cette méthode ajoute pour chaque attribut pouvant contenir une valeur :

• une clef contenant la valeur affichable de l'attribut,
• une clef pour le libellé de l'attribut.
• une clef pour indiquer si la valeur de l'attribut est vide ou non.

La clef de valeur est composée du préfixe V_ suivi de l'identifiant de l'attribut en majuscule. La valeur affichable est fournie par la méthode DocHtmlFormat::getHtmlValue(). Les attributs de type array ont aussi leur clef générée.

La clef de libellé est composée du préfixe L_ suivi de l'identifiant de l'attribut en majuscule. Le libellé est dépendant de la locale de l'utilisateur. La valeur du libellé est fournie par la méthode Doc::getLabel().

La clef de nullité de la valeur est composée du préfixe S_ suivi du nom de l'identifiant de l'attribut en majuscule. Cette clef vaut false si la valeur brute de l'attribut est vide (chaine ""). Elle vaut true dans le cas contraire.

13.6.3.39.1.1 Avertissements

Les attributs de type tab, frame et menu n'ont pas de clef générée.

13.6.3.39.2 Liste des paramètres

(string) target

Indique la cible des hyperliens pour les attributs qui en disposent.
Valeur spéciale :

• ooo : Si on utilise les clefs pour une composition de template ODT. Dans ce cas, les valeurs en XML sont retournées.

(bool) ulink

Indique si les hyperliens doivent être générés. Si target égal à ooo, aucun lien n'est généré quelque soit la valeur de ulink.
Si true, alors les hyperliens sont générés
Si false, alors les hyperliens ne sont pas générés

(bool) abstract

Si true, alors seuls les attributs "résumé" sont affichés
Si false, alors la caractéristique "résumé" n'est pas prise en compte.

(bool) viewhidden

Si true, les attributs en visibilité H sont affichés.

Si false, les attributs en visibilité H ne sont pas affichés.
Les attributs en visibilité I et O ne sont pas affichés. Leur clefs sont générés vides.

13.6.3.39.3 Valeur de retour

void.

13.6.3.39.4 Erreurs / Exceptions

Aucune.

13.6.3.39.5 Historique

Aucun.

13.6.3.39.6 Exemples

Soit la famille MY_ANIMAL qui possède les attributs suivants :

Fichier de la classe associées à la famille :

namespace MyTest;
class My_animal extends \Dcp\Family\Document
{
  /**
   * @templateController view original photo
   */
  public function viewPhoto($target="_self", $ulink=true, $abstract=false) {
    $this->viewAttr($target, $ulink, $abstract);
  } 
}

Template viewPhoto.html :

<h1>[TEXT:My name is] : [V_AN_NOM]</h1>
<p>[TEXT:My birthday date is] : <strong>[V_AN_NAISSANCE]</strong></p>
[IF S_AN_PHOTO]<img class="photo" src="[V_AN_PHOTO]"/>[ENDIF S_AN_PHOTO]
[IFNOT S_AN_PHOTO]<p>[TEXT:No photo]</p>[ENDIF S_AN_PHOTO]

Résultat :

<h1>My name is : Rotor</h1>
<p>My birthday date is : <strong>03/08/2012</strong></p>
<img class="photo" src="file/1419/41/an_photo/-1/1387_IMG_1684AFC2.jpg?cache=no&inline=no"/>

Rendu HTML :

Figure 85. Usage de Doc::viewAttr()

13.6.3.39.7 Notes

Exemple de retour pour les valeurs formatées en fonction du type de l'attribut.

13.6.3.39.8 Voir aussi

• Vue de document,
• Zone pour les cadres,
• Doc::editattr().