13.6.3.16 Doc::getDocAnchor()

13.6.3.16.1 Description

string getDocAnchor (         int $id,
                           string $target = "_self" ,
                             bool $htmllink = true ,
                      bool|string $title = false ,
                             bool $js = true ,
                           string $docrev = "latest" ,
                             bool $viewIcon = false  )

Permet de générer un fragment HTML, qui pourra être inséré dans un document HTML, et qui contiendra une ancre HTML (<a href="…">…</a>) vers un document Dynacase.

13.6.3.16.1.1 Avertissements

Aucun.

13.6.3.16.2 Liste des paramètres

(int) id

L'identifiant du document pour lequel on souhaite générer le code de l'ancre HTML.

(string) target

Le nom du format du lien HTML. Les valeurs supportées sont :

• _self (par défaut),

• mail (pour un fragment HTML inséré dans un mail)

  Dans ce cas, l'URL de l'ancre est composée à partir de la valeur du paramètre CORE_MAILACTIONURL, lui-même composé à partir du paramètre CORE_MAILACTION.

  Cela permet d'effectuer des opérations spécifiques lorsqu'un document est accédé depuis un mail.

• ext (pour un fragment HTML inséré dans une interface ExtJS),

toute autre valeur est prise en compte comme l'attribut target de l'ancre HTML générée.

(bool) htmllink

Si false alors seul le fragment HTML contenant le titre, sans ancre, est généré.

(bool|string) title

Si une chaîne est spécifiée, alors elle est utilisée à la place du titre du document.

(bool) js

Si true alors du code JavaScript est inclus pour ouvrir le document dans une popup.

(string) docrev

Indique sur quelle révision du document pointera l'ancre HTML.

Les valeurs possibles sont :

• latest,
• fixed,
• state(<state>).

Se reporter à l'option docrev des attributs docid pour plus de précisions.

(bool) viewIcon

Si true l'icone de la famille du document est présentée dans l'ancre HTML. Dans ce cas l'ancre html aura la classe "relation" avec une image de fond :
<a class="relation" style="background-image:url("myicon.png")>myTitle</a> Sinon l'ancre html retournée est sans classe ni style particuliers.

13.6.3.16.3 Valeur de retour

La méthode retourne une chaîne contenant un fragment HTML avec une ancre vers le document.

13.6.3.16.4 Erreurs / Exceptions

Aucun.

13.6.3.16.5 Historique

Aucun.

13.6.3.16.6 Exemples

/* Générer une ancre HTML sans JS mais avec l'icône de la famille du document */
$htmlAnchor = $this->getDocAnchor($docId, "_self", true, false, false, "latest", true);
/* Retourne :
<a  documentId="7202" class="relation" style="background-image:url(resizeimg.php?img=Images/myicon.png&size=14)" target="_self" href="?&amp;app=FDL&amp;action=OPENDOC&amp;mode=view&amp;id=7202&amp;latest=Y">Mon Document</a>
*/
/* Insérer le fragment HTML dans le layout */
$this->lay->set('LINK_TO_DOCUMENT', $htmlAnchor);

13.6.3.16.7 Notes

Aucun.

13.6.3.16.8 Voir aussi

Aucun.