DiffHistoryBlob Class Reference

Diff-based history compression Requires xdiff 1.5+ and zlib. More...

Inheritance diagram for DiffHistoryBlob:

Collaboration diagram for DiffHistoryBlob:

Public Member Functions
	__construct ()
	__sleep ()
	__wakeup ()
	addItem ( $text)
	compress ()
	diff ( $t1, $t2)
	getItem ( $key)
	getText ()
	isHappy ()
	Helper function for compression jobs Returns true until the object is "full" and ready to be committed.
	patch ( $base, $diff)
	setText ( $text)
	uncompress ()
	xdiffAdler32 ( $s)
	Compute a binary "Adler-32" checksum as defined by LibXDiff, i.e.

Public Attributes
string	$mCompressed
	Compressed storage.
int	$mDefaultKey
	The key for getText()
array	$mDiffMap
	The diff map, see above.
array	$mDiffs
	Array of diffs.
bool	$mFrozen = false
	True if the object is locked against further writes.
array	$mItems = []
	Uncompressed item cache.
int	$mMaxCount = 100
	The maximum number of text items before the object becomes sad.
int	$mMaxSize = 10000000
	The maximum uncompressed size before the object becomes sad Should be less than max_allowed_packet.
int	$mSize = 0
	Total uncompressed size.
const	XDL_BDOP_CPY = 2
const	XDL_BDOP_INS = 1
	Constants from xdiff.h.
const	XDL_BDOP_INSB = 3

Detailed Description

Diff-based history compression Requires xdiff 1.5+ and zlib.

Definition at line 349 of file HistoryBlob.php.

Constructor & Destructor Documentation

__construct()

DiffHistoryBlob::__construct

(

)

Definition at line 393 of file HistoryBlob.php.

Member Function Documentation

__sleep()

DiffHistoryBlob::__sleep

(

)

Returns

array

Definition at line 628 of file HistoryBlob.php.

References $mDefaultKey, $mDiffs, compress(), and serialize().

__wakeup()

DiffHistoryBlob::__wakeup

(

)

Definition at line 656 of file HistoryBlob.php.

References uncompress(), and unserialize().

addItem()

DiffHistoryBlob::addItem

(

$text

)

Exceptions

MWException

Parameters

string

$text

Returns

int

Implements HistoryBlob.

Definition at line 404 of file HistoryBlob.php.

Referenced by setText().

compress()

DiffHistoryBlob::compress

(

)

Exceptions

MWException

Definition at line 440 of file HistoryBlob.php.

References diff, and patch().

Referenced by __sleep().

diff()

DiffHistoryBlob::diff	(		$t1,
			$t2 )

Parameters

string	$t1
string	$t2

Returns

string

Definition at line 519 of file HistoryBlob.php.

getItem()

DiffHistoryBlob::getItem

(

$key

)

Parameters

string

$key

Returns

string

Implements HistoryBlob.

Definition at line 419 of file HistoryBlob.php.

Referenced by getText().

getText()

DiffHistoryBlob::getText

(

)

Returns

string

Implements HistoryBlob.

Definition at line 433 of file HistoryBlob.php.

References getItem().

isHappy()

DiffHistoryBlob::isHappy

(

)

Helper function for compression jobs Returns true until the object is "full" and ready to be committed.

Returns

bool

Definition at line 696 of file HistoryBlob.php.

References $mMaxCount.

patch()

DiffHistoryBlob::patch	(		$base,
			$diff )

Parameters

string	$base
string	$diff

Returns

bool|string

Definition at line 533 of file HistoryBlob.php.

References $base, $header, $out, wfDebug(), xdiffAdler32(), XDL_BDOP_CPY, XDL_BDOP_INS, and XDL_BDOP_INSB.

Referenced by compress(), and uncompress().

setText()

DiffHistoryBlob::setText

(

$text

)

Parameters

string

$text

Implements HistoryBlob.

Definition at line 426 of file HistoryBlob.php.

References addItem().

uncompress()

DiffHistoryBlob::uncompress

(

)

Definition at line 611 of file HistoryBlob.php.

References patch().

Referenced by __wakeup().

xdiffAdler32()

DiffHistoryBlob::xdiffAdler32

(

$s

)

Compute a binary "Adler-32" checksum as defined by LibXDiff, i.e.

with the bytes backwards and initialised with 0 instead of 1. See T36428.

Parameters

string

$s

Returns

string|bool False if the hash extension is not available

Definition at line 595 of file HistoryBlob.php.

References $s.

Referenced by patch(), and DiffHistoryBlobTest\testXdiffAdler32().

Member Data Documentation

$mCompressed

string DiffHistoryBlob::$mCompressed

Compressed storage.

Definition at line 374 of file HistoryBlob.php.

$mDefaultKey

int DiffHistoryBlob::$mDefaultKey

The key for getText()

Definition at line 371 of file HistoryBlob.php.

Referenced by __sleep().

$mDiffMap

array DiffHistoryBlob::$mDiffMap

The diff map, see above.

Definition at line 367 of file HistoryBlob.php.

$mDiffs

array DiffHistoryBlob::$mDiffs

Array of diffs.

If a diff D from A to B is notated D = B - A, and Z is an empty string:

         { item[map[i]] - item[map[i-1]]   where i > 0

diff[i] = { { item[map[i]] - Z where i = 0

Definition at line 364 of file HistoryBlob.php.

Referenced by __sleep().

$mFrozen

bool DiffHistoryBlob::$mFrozen = false

True if the object is locked against further writes.

Definition at line 377 of file HistoryBlob.php.

$mItems

array DiffHistoryBlob::$mItems = []

Uncompressed item cache.

Definition at line 351 of file HistoryBlob.php.

$mMaxCount

int DiffHistoryBlob::$mMaxCount = 100

The maximum number of text items before the object becomes sad.

Definition at line 386 of file HistoryBlob.php.

Referenced by isHappy().

$mMaxSize

int DiffHistoryBlob::$mMaxSize = 10000000

The maximum uncompressed size before the object becomes sad Should be less than max_allowed_packet.

Definition at line 383 of file HistoryBlob.php.

$mSize

int DiffHistoryBlob::$mSize = 0

Total uncompressed size.

Definition at line 354 of file HistoryBlob.php.

XDL_BDOP_CPY

const DiffHistoryBlob::XDL_BDOP_CPY = 2

Definition at line 390 of file HistoryBlob.php.

Referenced by patch().

XDL_BDOP_INS

const DiffHistoryBlob::XDL_BDOP_INS = 1

Constants from xdiff.h.

Definition at line 389 of file HistoryBlob.php.

Referenced by patch().

XDL_BDOP_INSB

const DiffHistoryBlob::XDL_BDOP_INSB = 3

Definition at line 391 of file HistoryBlob.php.

Referenced by patch().

---

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

• includes/HistoryBlob.php