Parse:...::page(3pm)

💖 Parse::MediaWikiDump::page — the manual page, bestie edition 🎀

okay so this is Parse::MediaWikiDump::page(3pm) from the User Contributed Perl Documentation collection, and it's giving "one specific revision of a MediaWiki page, as an object" energy. let's get into it 💅

---

✨ NAME ✨

Parse::MediaWikiDump::page — the object that represents one specific revision of a MediaWiki page. yeah. that's the whole vibe. 🦋

---

🌸 ABOUT 🌸

so basically, you do not go out here and make these yourself, bestie. this object is returned to you from the next method of Parse::MediaWikiDump::Pages and Parse::MediaWikiDump::Revisions. 😌

you most likely will not be creating instances of this particular object yourself. instead you use this object to access the information about a page in a MediaWiki instance. that's the whole point. main character object behavior. 👑

---

⭐ SYNOPSIS ⭐

the classic. look at her:

$pages = Parse::MediaWikiDump::Pages->new('pages-articles.xml');

#get all the records from the dump files, one record at a time
while(defined($page = $pages->next)) {
  print "title '", $page->title, "' id ", $page->id, "\n";
}

get all the records from the dump files, one record at a time. slay. 🔥

---

💀 STATUS 💀

okay, not to be dramatic but — This software is being RETIRED. 😭

MediaWiki::DumpFile is the official successor to Parse::MediaWikiDump, and it ships with a compatibility library called MediaWiki::DumpFile::Compat that is 100% API compatible and is a near perfect standin for this module. it's faster in all instances where it counts, and it is actively maintained. 🫶

and get this — any undocumented deviation of MediaWiki::DumpFile::Compat from Parse::MediaWikiDump is considered a bug and will be fixed. no cap. 💜

---

🧚 METHODS 🧚

one bullet-list-of-methods per method, no skipping, we eat the whole plate 🍓

• $page->redirect — returns an empty string (such as '') for the main namespace, or a string containing the name of the namespace. 🌀
• $page->categories — returns a reference to an array that contains a list of categories, or undef if there are no categories. heads up though: this method does not understand templates and may not return all the categories the article actually belongs in. 🙈
• $page->title — returns a string of the full article title, including the namespace if present. 📛
• $page->namespace — returns a string of the namespace of the article, or an empty string if the article is in the default namespace. 📂
• $page->id — returns a number that is the id for the page in the MediaWiki instance. 🔢
• $page->revision_id — returns a number that is the revision id for the page in the MediaWiki instance. 🧾
• $page->timestamp — returns a string in the following format: 2005-07-09T18:41:10Z. ⏰
• $page->username — returns a string of the username responsible for this specific revision of the article, or undef if the editor was anonymous. 🕵️
• $page->userid — returns a number that is the id for the user returned by $page->username, or undef if the editor was anonymous. 🆔
• $page->userip — returns a string of the IP of the editor if the edit was anonymous, or undef otherwise. 🌐
• $page->minor — returns 1 if this article was flaged as a minor edit, otherwise returns 0. ✏️
• $page->text — returns a reference to a string that contains the article title text. 📝

---

and that's the whole page, bestie, you ate that 💅✨

perl v5.36.0 · 2022-10-14 — mwah, go read the successor module, ily, bye 🎀🦋💖