Manuel:Article.php

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Article.php and the translation is 100% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎中文 • ‎日本語

La classe Article gère la présentation des pages MediaWiki et leur interaction avec les pages historiques. Elle est très liée à la classe WikiPage, qui fournit le modèle objet des pages.

Ce fichier contient par exemple une version de la fonction view() pour afficher une page, appelée de ViewAction.php (une autre version figure dans RawAction.php). Cette fonction va rechercher le texte wiki $mContent de la page dans la base de données en utilisant les fonctions getContent(), loadContent() et fetchContent(), et range l'ensemble dans $text. Puis elle appelle la fonction outputWikiText() pour traiter $text.

Avertissement Avertissement : Article est une classe d'IHM et non pas une Api pour interagir avec le contenu de la page. Veuillez utiliser WikiPage pour cela.

Créer un nouvel objet Article

Pour instancier un objet Article, appelez une des méthodes statiques de la fabrique ou bien utilisez le constructeur :

  • Article::newFromId( $id ) - où $id est l'ID d'un article (c'est la même chose que page_id ).
  • Article::newFromTitle( Title $title, IContextSource $context ) - crée un objet Article de classe appropriée pour le titre donné
  • Article::newFromWikiPage( WikiPage $page, IContextSource $context ) - crée un objet Article de classe appropriée pour la page donnée
  • new Article( Title $title ) - crée un objet Article à partir du titre donné

Méthodes

  • getContent(): fournit le texte de cette révision. Cette fonction a des effets de bord. Ne l'utilisez pas si vous voulez simplement le vrai texte de la révision s'il y en a.
  • getContext(): (depuis 1.18): fournit le contexte dans lequel cet Article s'exécute.
  • getOldID(): fournit le oldid de l'article qui doit être affiché, ou 0 pour la révision actuelle.
  • getPage() (depuis 1.19): fournit l'objet WikiPage de cette instance.
  • getParserOptions(): fournit les options d'analyse syntaxique utilisables pour la génération de l'article wikitext primaire.
  • getParserOutput([$oldid, User $user]): une méthode allégée pour obtenir la sortie de l'analyse syntaxique d'une page, en vérifiant le cache de l'analyseur et autres. Ne prend pas en compte la plupart du travail que WikiPage::view() est forcer de considérer.
  • getRevIdFetched(): fournit l'identifiant de révision (rev ID) utilisé lors de l'affichage des pages.
  • getRevisionFetched() (depuis 1.19): fournit l'objet Revision récupéré en fonction des paramètres de la requête ou null en cas d'échec.
  • getRobotPolicy(string $action, ParserOutput $pOutput): fournit la politique à utiliser pour l'affichage actuel concernant les robots. $action est une chaîne contenant le paramètre action= GET et $pOutput.
  • getTitle(): fournit l'objet Title associé à cette page.
  • isCurrent(): renvoie true si la révision actuellement référencée correspond à la modification actuelle de cette page (et qu'elle existe).
  • isFileCacheable(): retourne true si la page peut être mise en cache.
  • view(): cette méthode gère l'action (par défaut) de l'affichage d'une page. Les actions (telles que 'view' (afficher), 'revert' (annuler), 'delete' (supprimer), etc) sont gérées par les sous-classes de Action. La méthode show() de ViewAction appelle Article::view() pour réaliser le travail actuel.

Voir https://doc.wikimedia.org/mediawiki-core/master/php/classArticle.html pour une liste complète des méthodes.

Accroches

Les accoches appelées depuis ce fichier sont listées dans la catégorie Category:MediaWiki hooks included in Article.php .

Voir aussi