MediaWiki  master
Wikimedia\Rdbms\Database\IDatabaseFlags Interface Reference
Inheritance diagram for Wikimedia\Rdbms\Database\IDatabaseFlags:

Public Member Functions

 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 

Detailed Description

Definition at line 25 of file IDatabaseFlags.php.

Member Function Documentation

◆ clearFlag()

Wikimedia\Rdbms\Database\IDatabaseFlags::clearFlag (   $flag,
  $remember = self::REMEMBER_NOTHING 
)

Clear a flag for this connection.

Parameters
int$flagOne of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX)
string$rememberIDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implemented in Wikimedia\Rdbms\DBConnRef, Wikimedia\Rdbms\Database\DatabaseFlags, and Wikimedia\Rdbms\Database.

◆ getFlag()

Wikimedia\Rdbms\Database\IDatabaseFlags::getFlag (   $flag)

Returns a boolean whether the flag $flag is set for this connection.

Parameters
int$flagOne of the class IDatabase::DBO_* constants
Returns
bool

Implemented in Wikimedia\Rdbms\DBConnRef, Wikimedia\Rdbms\Database\DatabaseFlags, and Wikimedia\Rdbms\Database.

◆ restoreFlags()

Wikimedia\Rdbms\Database\IDatabaseFlags::restoreFlags (   $state = self::RESTORE_PRIOR)

Restore the flags to their prior state before the last setFlag/clearFlag call.

Parameters
string$stateIDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]
Since
1.28

Implemented in Wikimedia\Rdbms\DBConnRef, Wikimedia\Rdbms\Database\DatabaseFlags, and Wikimedia\Rdbms\Database.

◆ setFlag()

Wikimedia\Rdbms\Database\IDatabaseFlags::setFlag (   $flag,
  $remember = self::REMEMBER_NOTHING 
)

Set a flag for this connection.

Parameters
int$flagOne of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX)
string$rememberIDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implemented in Wikimedia\Rdbms\DBConnRef, Wikimedia\Rdbms\Database\DatabaseFlags, and Wikimedia\Rdbms\Database.

Referenced by DatabaseUpdater\__construct().


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