summaryrefslogtreecommitdiff
path: root/www/wiki/docs/linkcache.txt
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/docs/linkcache.txt')
-rw-r--r--www/wiki/docs/linkcache.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/www/wiki/docs/linkcache.txt b/www/wiki/docs/linkcache.txt
new file mode 100644
index 00000000..13b69613
--- /dev/null
+++ b/www/wiki/docs/linkcache.txt
@@ -0,0 +1,24 @@
+linkcache.txt
+
+The LinkCache class maintains a list of article titles and the information about
+whether or not the article exists in the database. This is used to mark up links
+when displaying a page. If the same link appears more than once on any page,
+then it only has to be looked up once. In most cases, link lookups are done in
+batches with the LinkBatch class, or the equivalent in Parser::replaceLinkHolders(),
+so the link cache is mostly useful for short snippets of parsed text (such as
+the site notice), and for links in the navigation areas of the skin.
+
+The link cache was formerly used to track links used in a document for the
+purposes of updating the link tables. This application is now deprecated.
+
+To create a batch, you can use the following code:
+
+$pages = array( 'Main Page', 'Project:Help', /* ... */ );
+$titles = array();
+
+foreach( $pages as $page ){
+ $titles[] = Title::newFromText( $page );
+}
+
+$batch = new LinkBatch( $titles );
+$batch->execute();