Wikimedia\Rdbms\DatabaseDomain Class Reference

Class to handle database/prefix specification for IDatabase domains. More...

Collaboration diagram for Wikimedia\Rdbms\DatabaseDomain:

Public Member Functions
	__construct ( $database, $schema, $prefix)
	__toString ()
	equals ( $other)
	getDatabase ()
	getId ()
	getSchema ()
	getTablePrefix ()

Static Public Member Functions
static	newFromId ( $domain)
static	newUnspecified ()

Private Member Functions
	convertToString ()

Static Private Member Functions
static	decode ( $encoded)
static	encode ( $decoded)

Private Attributes
string null	$database
string	$equivalentString
	Cache of convertToString() More...
string	$prefix
string null	$schema

Detailed Description

Class to handle database/prefix specification for IDatabase domains.

Definition at line 28 of file DatabaseDomain.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\Rdbms\DatabaseDomain::__construct	(		$database,
			$schema,
			$prefix
	)

Parameters

string | null	$database	Database name
string | null	$schema	Schema name
string	$prefix	Table prefix

Definition at line 44 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$database, Wikimedia\Rdbms\DatabaseDomain\$prefix, Wikimedia\Rdbms\DatabaseDomain\$schema, and database.

Member Function Documentation

__toString()

Wikimedia\Rdbms\DatabaseDomain::__toString

(

)

Returns

string

Definition at line 206 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\getId().

convertToString()

Wikimedia\Rdbms\DatabaseDomain::convertToString ( )

private

Returns

string

Definition at line 148 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$database, Wikimedia\Rdbms\DatabaseDomain\$prefix, and Wikimedia\Rdbms\DatabaseDomain\$schema.

Referenced by Wikimedia\Rdbms\DatabaseDomain\getId().

decode()

static Wikimedia\Rdbms\DatabaseDomain::decode (   $encoded )

staticprivate

Definition at line 178 of file DatabaseDomain.php.

encode()

static Wikimedia\Rdbms\DatabaseDomain::encode (   $decoded )

staticprivate

Definition at line 160 of file DatabaseDomain.php.

equals()

Wikimedia\Rdbms\DatabaseDomain::equals

(

$other

)

Parameters

DatabaseDomain | string

$other

Returns

bool

Definition at line 101 of file DatabaseDomain.php.

References database, and Wikimedia\Rdbms\DatabaseDomain\getId().

getDatabase()

Wikimedia\Rdbms\DatabaseDomain::getDatabase

(

)

Returns

string|null Database name

Definition at line 116 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$database.

getId()

Wikimedia\Rdbms\DatabaseDomain::getId

(

)

Returns

string

Definition at line 137 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$equivalentString, and Wikimedia\Rdbms\DatabaseDomain\convertToString().

Referenced by Wikimedia\Rdbms\DatabaseDomain\__toString(), Wikimedia\Rdbms\DatabaseDomain\equals(), and Wikimedia\Rdbms\DBConnRef\getDomainID().

getSchema()

Wikimedia\Rdbms\DatabaseDomain::getSchema

(

)

Returns

string|null Database schema

Definition at line 123 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$schema.

getTablePrefix()

Wikimedia\Rdbms\DatabaseDomain::getTablePrefix

(

)

Returns

string Table prefix

Definition at line 130 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$prefix.

newFromId()

static Wikimedia\Rdbms\DatabaseDomain::newFromId (   $domain )

static

Parameters

DatabaseDomain | string

$domain

Result of DatabaseDomain::toString()

Returns

DatabaseDomain

Definition at line 63 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$database, Wikimedia\Rdbms\DatabaseDomain\$prefix, Wikimedia\Rdbms\DatabaseDomain\$schema, captcha-old\count, and list.

Referenced by Wikimedia\Rdbms\LBFactory\__construct(), Wikimedia\Rdbms\LoadBalancer\__construct(), Wikimedia\Rdbms\LBFactoryMulti\getDBNameAndPrefix(), and Wikimedia\Rdbms\LoadBalancer\openForeignConnection().

newUnspecified()

static Wikimedia\Rdbms\DatabaseDomain::newUnspecified ( )

static

Returns

DatabaseDomain

Definition at line 93 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\LBFactory\__construct(), Wikimedia\Rdbms\LoadBalancer\__construct(), Wikimedia\Rdbms\Database\__construct(), and Wikimedia\Rdbms\Database\tablePrefix().

Member Data Documentation

$database

string null Wikimedia\Rdbms\DatabaseDomain::$database

private

Definition at line 30 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\__construct(), Wikimedia\Rdbms\DatabaseDomain\convertToString(), Wikimedia\Rdbms\DatabaseDomain\getDatabase(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

$equivalentString

string Wikimedia\Rdbms\DatabaseDomain::$equivalentString

private

Cache of convertToString()

Definition at line 37 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\getId().

$prefix

string Wikimedia\Rdbms\DatabaseDomain::$prefix

private

Definition at line 34 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\__construct(), Wikimedia\Rdbms\DatabaseDomain\convertToString(), Wikimedia\Rdbms\DatabaseDomain\getTablePrefix(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

$schema

string null Wikimedia\Rdbms\DatabaseDomain::$schema

private

Definition at line 32 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\__construct(), Wikimedia\Rdbms\DatabaseDomain\convertToString(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

---

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

• includes/libs/rdbms/database/DatabaseDomain.php