ConcatenatedGzipHistoryBlob Class Reference

Concatenated gzip (CGZ) storage Improves compression ratio by concatenating like objects before gzipping. More...

Inheritance diagram for ConcatenatedGzipHistoryBlob:

Collaboration diagram for ConcatenatedGzipHistoryBlob:

Public Member Functions
	__construct ()
	__sleep ()
	__wakeup ()
	addItem ( $text)
	compress ()
	Compress the bulk data in the object.
	getItem ( $hash)
	getText ()
	isHappy ()
	Helper function for compression jobs Returns true until the object is "full" and ready to be committed.
	removeItem ( $hash)
	Remove an item.
	setText ( $text)
	uncompress ()
	Uncompress bulk data.

Public Attributes
	$mCompressed = false
	$mDefaultHash = ''
array string	$mItems = []
	@fixme Why are some methods treating it as an array, and others as a string, unconditionally?
	$mMaxCount = 100
	$mMaxSize = 10000000
	$mSize = 0
	$mVersion = 0

Detailed Description

Concatenated gzip (CGZ) storage Improves compression ratio by concatenating like objects before gzipping.

Definition at line 27 of file ConcatenatedGzipHistoryBlob.php.

Constructor & Destructor Documentation

__construct()

ConcatenatedGzipHistoryBlob::__construct

(

)

Definition at line 40 of file ConcatenatedGzipHistoryBlob.php.

Member Function Documentation

__sleep()

ConcatenatedGzipHistoryBlob::__sleep

(

)

Returns

array

Definition at line 124 of file ConcatenatedGzipHistoryBlob.php.

References compress().

__wakeup()

ConcatenatedGzipHistoryBlob::__wakeup

(

)

Definition at line 129 of file ConcatenatedGzipHistoryBlob.php.

References uncompress().

addItem()

ConcatenatedGzipHistoryBlob::addItem

(

$text

)

Parameters

string

$text

Returns

string

Implements HistoryBlob.

Definition at line 51 of file ConcatenatedGzipHistoryBlob.php.

References uncompress().

Referenced by setText().

compress()

ConcatenatedGzipHistoryBlob::compress

(

)

Compress the bulk data in the object.

Definition at line 104 of file ConcatenatedGzipHistoryBlob.php.

References serialize().

Referenced by __sleep().

getItem()

ConcatenatedGzipHistoryBlob::getItem

(

$hash

)

Parameters

string

$hash

Returns

array|bool

Implements HistoryBlob.

Definition at line 65 of file ConcatenatedGzipHistoryBlob.php.

References uncompress().

Referenced by getText().

getText()

ConcatenatedGzipHistoryBlob::getText

(

)

Returns

array|bool

Implements HistoryBlob.

Definition at line 86 of file ConcatenatedGzipHistoryBlob.php.

References getItem(), and uncompress().

isHappy()

ConcatenatedGzipHistoryBlob::isHappy

(

)

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

Returns

bool

Definition at line 139 of file ConcatenatedGzipHistoryBlob.php.

References $mMaxCount.

removeItem()

ConcatenatedGzipHistoryBlob::removeItem

(

$hash

)

Remove an item.

Parameters

string

$hash

Definition at line 96 of file ConcatenatedGzipHistoryBlob.php.

setText()

ConcatenatedGzipHistoryBlob::setText

(

$text

)

Parameters

string

$text

Returns

void

Implements HistoryBlob.

Definition at line 78 of file ConcatenatedGzipHistoryBlob.php.

References addItem(), and uncompress().

uncompress()

ConcatenatedGzipHistoryBlob::uncompress

(

)

Uncompress bulk data.

Definition at line 114 of file ConcatenatedGzipHistoryBlob.php.

References unserialize().

Referenced by __wakeup(), addItem(), getItem(), getText(), and setText().

Member Data Documentation

$mCompressed

ConcatenatedGzipHistoryBlob::$mCompressed = false

Definition at line 29 of file ConcatenatedGzipHistoryBlob.php.

$mDefaultHash

ConcatenatedGzipHistoryBlob::$mDefaultHash = ''

Definition at line 35 of file ConcatenatedGzipHistoryBlob.php.

$mItems

array string ConcatenatedGzipHistoryBlob::$mItems = []

@fixme Why are some methods treating it as an array, and others as a string, unconditionally?

Definition at line 34 of file ConcatenatedGzipHistoryBlob.php.

$mMaxCount

ConcatenatedGzipHistoryBlob::$mMaxCount = 100

Definition at line 38 of file ConcatenatedGzipHistoryBlob.php.

Referenced by isHappy().

$mMaxSize

ConcatenatedGzipHistoryBlob::$mMaxSize = 10000000

Definition at line 37 of file ConcatenatedGzipHistoryBlob.php.

$mSize

ConcatenatedGzipHistoryBlob::$mSize = 0

Definition at line 36 of file ConcatenatedGzipHistoryBlob.php.

$mVersion

ConcatenatedGzipHistoryBlob::$mVersion = 0

Definition at line 28 of file ConcatenatedGzipHistoryBlob.php.

---

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

• includes/historyblob/ConcatenatedGzipHistoryBlob.php