HistoryBlob Interface Reference

Base class for general text storage via the "object" flag in old_flags, or two-part external storage URLs. More...

Inherited by ConcatenatedGzipHistoryBlob, and DiffHistoryBlob.

List of all members.

Public Member Functions

 addItem ($text)
 Adds an item of text, returns a stub object which points to the item.
 getItem ($key)
 Get item by key, or false if the key is not present.
 setText ($text)
 Set the "default text" This concept is an odd property of the current DB schema, whereby each text item has a revision associated with it.
 getText ()
 Get default text.


Detailed Description

Base class for general text storage via the "object" flag in old_flags, or two-part external storage URLs.

Used for represent efficient concatenated storage, and migration-related pointer objects.

Definition at line 8 of file HistoryBlob.php.


Member Function Documentation

HistoryBlob::addItem ( text  ) 

Adds an item of text, returns a stub object which points to the item.

You must call setLocation() on the stub object before storing it to the database Returns the key for getItem()

Implemented in ConcatenatedGzipHistoryBlob, and DiffHistoryBlob.

HistoryBlob::getItem ( key  ) 

Get item by key, or false if the key is not present.

Implemented in ConcatenatedGzipHistoryBlob, and DiffHistoryBlob.

HistoryBlob::getText (  ) 

Get default text.

This is called from Revision::getRevisionText()

Implemented in ConcatenatedGzipHistoryBlob, and DiffHistoryBlob.

HistoryBlob::setText ( text  ) 

Set the "default text" This concept is an odd property of the current DB schema, whereby each text item has a revision associated with it.

The default text is the text of the associated revision. There may, however, be other revisions in the same object.

Default text is not required for two-part external storage URLs.

Implemented in ConcatenatedGzipHistoryBlob, and DiffHistoryBlob.


The documentation for this interface was generated from the following file:

Generated on Sat Sep 5 02:08:38 2009 for MediaWiki by  doxygen 1.5.9