13.6.3.24 Doc::getTitle()

13.6.3.24.1 Description

string getTitle (  mixed $id     = -1,
                  string $def    = "",
                    bool $latest = false )

La méthode getTitle permet de récupérer le titre

• du document courant,
• d'un document donné en spécifiant son identifiant (numérique ou logique),
• ou d'un ensemble de document en spécifiant leur identifiants (numérique ou logique).

13.6.3.24.1.1 Avertissements

Bien que la méthode getTitle accepte de travailler sur plusieurs documents, il est préférable d'utiliser la classe DocTitle pour travailler sur un grand nombre de documents.

13.6.3.24.2 Liste des paramètres

(mixed) id

id permet de spécifier le ou les documents dont on souhaite obtenir le titre.

Si id est égal à -1, alors le titre du document courant est retourné.

Si id est l'identifiant numérique ou le nom logique d'un document, alors le titre du document correspondant est retourné.

Si id est une chaîne de caractère contenant le caractère \n ou la séquence <BR>, alors id est traité comme étant une liste d'identifiants de documents (format issu de Doc::arrayToRawValue), et le résultat retourné est la concaténation avec le caractère de séparation \n des titres des documents correspondant à ces identifiants.

Attention : Dans le cas où id est un array, la valeur par défaut est retournée, sans erreur.

La valeur par défaut de id est -1.

(string) def

def permet de spécifier la valeur par défaut qui sera retournée si le document demandé n'existe pas.

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

(bool) latest

latest permet de spécifier si l'on souhaite obtenir le titre de la dernière révision du document.

Par défaut, latest est égal à false et donc c'est le titre du document référencé par l'identifiant qui est retourné (et non celui de la dernière révision).

13.6.3.24.3 Valeur de retour

La méthode retourne une chaîne de caractère contenant le titre du document demandé, ou les titres des documents demandés, séparés par le caractère \n.

13.6.3.24.4 Erreurs / Exceptions

Aucune.

13.6.3.24.5 Historique

Aucun.

13.6.3.24.6 Exemples

• Exemple #1

  var_dump($doc->getTitle());

  Résultat :

  string(22) "Titre document courant"

• Exemple #2

  var_dump($doc->getTitle(1234));

  Résultat :

  string(19) "Titre document 1234"

• Exemple #3

  var_dump($doc->getTitle($doc->arrayToRawValue(array(1234, 2345, 3456))));

  Résultat :

  string(59) "Titre document 1234
  Titre document 2345
  Titre document 3456"

13.6.3.24.7 Notes

Si le document, dont on souhaite obtenir le titre, est confidentiel, et que l'utilisateur courant n'a pas le droit confidential, alors la titre retourné est "document confidentiel".

13.6.3.24.8 Voir aussi

• Doc::arrayToRawValue
• Doc::getCustomTitle