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 ()
	isCompatible ( $other)
	Check whether the domain $other meets the specifications of this domain.
	isUnspecified ()

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()
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, and Wikimedia\Rdbms\DatabaseDomain\$schema.

Member Function Documentation

__toString()

Wikimedia\Rdbms\DatabaseDomain::__toString

(

)

Returns

string

Definition at line 253 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\getId().

convertToString()

Wikimedia\Rdbms\DatabaseDomain::convertToString ( )

private

Returns

string

Definition at line 190 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 225 of file DatabaseDomain.php.

encode()

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

staticprivate

Definition at line 207 of file DatabaseDomain.php.

equals()

Wikimedia\Rdbms\DatabaseDomain::equals

(

$other

)

Parameters

DatabaseDomain | string

$other

Returns

bool Whether the domain instances are the same by value

Definition at line 105 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\getId().

getDatabase()

Wikimedia\Rdbms\DatabaseDomain::getDatabase

(

)

Returns

string|null Database name

Definition at line 158 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$database.

Referenced by Wikimedia\Rdbms\LoadBalancer\setLocalDomain().

getId()

Wikimedia\Rdbms\DatabaseDomain::getId

(

)

Returns

string

Definition at line 179 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 165 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$schema.

getTablePrefix()

Wikimedia\Rdbms\DatabaseDomain::getTablePrefix

(

)

Returns

string Table prefix

Definition at line 172 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$prefix.

isCompatible()

Wikimedia\Rdbms\DatabaseDomain::isCompatible

(

$other

)

Check whether the domain $other meets the specifications of this domain.

If this instance has a null database specifier, then $other can have any database specified, including the null, and likewise if the schema specifier is null. This is not transitive like equals() since a domain that explicitly wants a certain database or schema cannot be satisfied by one of another (nor null). If the prefix is empty and the DB and schema are both null, then the entire domain is considered unspecified, and any prefix of $other is considered compatible.

Parameters

DatabaseDomain | string

$other

Returns

bool

Since

1.32

Definition at line 131 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\isUnspecified(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

isUnspecified()

Wikimedia\Rdbms\DatabaseDomain::isUnspecified

(

)

Returns

bool

Since

1.32

Definition at line 149 of file DatabaseDomain.php.

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

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, and list.

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

newUnspecified()

static Wikimedia\Rdbms\DatabaseDomain::newUnspecified ( )

static

Returns

DatabaseDomain

Definition at line 97 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\LBFactory\__construct(), Wikimedia\Rdbms\Database\__construct(), Wikimedia\Rdbms\LoadBalancer\__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