CloneDatabase Class Reference

Collaboration diagram for CloneDatabase:

Public Member Functions
	__construct (DatabaseBase $db, array $tablesToClone, $newTablePrefix, $oldTablePrefix='', $dropCurrentTables=true)
	Constructor.
	cloneTableStructure ()
	Clone the table structure.
	destroy ( $dropTables=false)
	Change the prefix back to the original.
	useTemporaryTables ( $u=true)
	Set whether to use temporary tables or not.

Static Public Member Functions
static	changeDBPrefix ( $db, $prefix)
static	changeLBPrefix ( $lb, $prefix)
static	changePrefix ( $prefix)
	Change the table prefix on all open DB connections/.

Private Attributes
bool	$dropCurrentTables = true
	Should we DROP tables containing the new names?
string	$newTablePrefix = ''
	Table prefix for cloning.
string	$oldTablePrefix = ''
	Current table prefix.
array	$tablesToClone = []
	List of tables to be cloned.
bool	$useTemporaryTables = true
	Whether to use temporary tables or not.

Detailed Description

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 27 of file CloneDatabase.php.

Constructor & Destructor Documentation

__construct()

CloneDatabase::__construct	(	DatabaseBase	$db,
		array	$tablesToClone,
			$newTablePrefix,
			$oldTablePrefix = '',
			$dropCurrentTables = true
	)

Constructor.

Parameters

DatabaseBase	$db	A database subclass
array	$tablesToClone	An array of tables to clone, unprefixed
string	$newTablePrefix	Prefix to assign to the tables
string	$oldTablePrefix	Prefix on current tables, if not $wgDBprefix
bool	$dropCurrentTables

Definition at line 52 of file CloneDatabase.php.

References $dropCurrentTables, $newTablePrefix, $oldTablePrefix, $tablesToClone, and DatabaseBase\tablePrefix().

Member Function Documentation

changeDBPrefix()

static CloneDatabase::changeDBPrefix (   $db,   $prefix  )

static

Parameters

DatabaseBase	$db
string	$prefix

Returns

void

Definition at line 150 of file CloneDatabase.php.

changeLBPrefix()

static CloneDatabase::changeLBPrefix (   $lb,   $prefix  )

static

Parameters

LoadBalancer	$lb
string	$prefix

Returns

void

Definition at line 141 of file CloneDatabase.php.

changePrefix()

static CloneDatabase::changePrefix (   $prefix )

static

Change the table prefix on all open DB connections/.

Parameters

string

$prefix

Returns

void

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 130 of file CloneDatabase.php.

References $wgDBprefix, global, and wfGetLBFactory().

Referenced by cloneTableStructure(), destroy(), MediaWikiTestCase\setupDatabaseWithTestPrefix(), and MediaWikiTestCase\teardownTestDB().

cloneTableStructure()

CloneDatabase::cloneTableStructure

(

)

Clone the table structure.

Definition at line 73 of file CloneDatabase.php.

References $wgSharedDB, $wgSharedTables, as, changePrefix(), global, useTemporaryTables(), and wfDebug().

destroy()

CloneDatabase::destroy

(

$dropTables = false

)

Change the prefix back to the original.

Parameters

bool

$dropTables

Optionally drop the tables we created

Definition at line 114 of file CloneDatabase.php.

References as, and changePrefix().

useTemporaryTables()

CloneDatabase::useTemporaryTables

(

$u = true

)

Set whether to use temporary tables or not.

Parameters

bool

$u

Use temporary tables when cloning the structure

Definition at line 66 of file CloneDatabase.php.

References useTemporaryTables().

Referenced by cloneTableStructure(), and useTemporaryTables().

Member Data Documentation

$dropCurrentTables

bool CloneDatabase::$dropCurrentTables = true

private

Should we DROP tables containing the new names?

Definition at line 38 of file CloneDatabase.php.

Referenced by __construct().

$newTablePrefix

string CloneDatabase::$newTablePrefix = ''

private

Table prefix for cloning.

Definition at line 29 of file CloneDatabase.php.

Referenced by __construct().

$oldTablePrefix

string CloneDatabase::$oldTablePrefix = ''

private

Current table prefix.

Definition at line 32 of file CloneDatabase.php.

Referenced by __construct().

$tablesToClone

array CloneDatabase::$tablesToClone = []

private

List of tables to be cloned.

Definition at line 35 of file CloneDatabase.php.

Referenced by __construct().

$useTemporaryTables

bool CloneDatabase::$useTemporaryTables = true

private

Whether to use temporary tables or not.

Definition at line 41 of file CloneDatabase.php.

---

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

• includes/db/CloneDatabase.php