MediaWiki  1.28.1
DatabaseTestHelper Class Reference

Helper for testing the methods from the Database class. More...

Inheritance diagram for DatabaseTestHelper:
Collaboration diagram for DatabaseTestHelper:

Public Member Functions

 __construct ($testName, array $opts=[])
 
 addIdentifierQuotes ($s)
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 dataSeek ($res, $row)
 Change the position of the cursor in a result object. More...
 
 fetchObject ($res)
 Fetch the next row from the given result object, in object form. More...
 
 fetchRow ($res)
 Fetch the next row from the given result object, in associative array form. More...
 
 fieldInfo ($table, $field)
 mysql_fetch_field() wrapper Returns false if the field doesn't exist More...
 
 fieldName ($res, $n)
 Get a field name in a result object. More...
 
 forceNextResult ($res)
 
 getLastSqls ()
 Returns SQL queries grouped by '; ' Clear the list of queries that have been done so far. More...
 
 getServerInfo ()
 A string describing the current software version, and possibly other details in a user-friendly way. More...
 
 getServerVersion ()
 A string describing the current software version, like from mysql_get_server_info(). More...
 
 getSoftwareLink ()
 Returns a wikitext link to the DB's website, e.g., return "[http://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website. More...
 
 getType ()
 Get the type of the DBMS, as it appears in $wgDBtype. More...
 
 indexInfo ($table, $index, $fname= 'Database::indexInfo')
 
 insertId ()
 Get the inserted value of an auto-increment row. More...
 
 isOpen ()
 Is a connection to the database open? More...
 
 lastErrno ()
 Get the last error number. More...
 
 lastError ()
 Get a description of the last error. More...
 
 nativeReplace ($table, $rows, $fname)
 
 numFields ($res)
 Get the number of fields in a result object. More...
 
 numRows ($res)
 Get the number of rows in a result object. More...
 
 open ($server, $user, $password, $dbName)
 Open a connection to the database. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 query ($sql, $fname= '', $tempIgnore=false)
 Run an SQL query and return the result. More...
 
 setExistingTables ($tablesExists)
 
 strencode ($s)
 
 tableExists ($table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
- Public Member Functions inherited from Database
 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __construct (array $params)
 Constructor and database handle and attempt to connect to the DB server. More...
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 __toString ()
 
 addIdentifierQuotes ($s)
 Quotes an identifier using backticks or "double quotes" depending on the database type. More...
 
 addQuotes ($s)
 Adds quotes and backslashes. More...
 
 aggregateValue ($valuedata, $valuename= 'value')
 Return aggregated value alias. More...
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More...
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More...
 
 begin ($fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction. More...
 
 bitAnd ($fieldLeft, $fieldRight)
 
 bitNot ($field)
 
 bitOr ($fieldLeft, $fieldRight)
 
 bufferResults ($buffer=null)
 Turns buffering of SQL result sets on (true) or off (false). More...
 
 buildConcat ($stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ($delim, $table, $field, $conds= '', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildLike ()
 LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). More...
 
 buildStringCast ($field)
 
 clearFlag ($flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ()
 Closes a database connection. More...
 
 commit ($fname=__METHOD__, $flush= '')
 Commits a transaction previously started using begin(). More...
 
 conditional ($cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorLogger ($errno, $errstr)
 This method should not be used outside of Database classes. More...
 
 dbSchema ($schema=null)
 Get/set the db schema. More...
 
 deadlockLoop ()
 Perform a deadlock-prone transaction. More...
 
 decodeBlob ($b)
 Some DBMSs return a special placeholder object representing blob fields in result objects. More...
 
 decodeExpiry ($expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format. More...
 
 delete ($table, $conds, $fname=__METHOD__)
 DELETE query wrapper. More...
 
 deleteJoin ($delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join. More...
 
 doAtomicSection ($fname, callable $callback)
 Run a callback to do an atomic set of updates for this database. More...
 
 doneWrites ()
 Returns true if the connection may have been used for write queries. More...
 
 dropTable ($tableName, $fName=__METHOD__)
 Delete a table. More...
 
 duplicateTableStructure ($oldName, $newName, $temporary=false, $fname=__METHOD__)
 Creates a new table with structure copied from existing table Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. More...
 
 encodeBlob ($b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More...
 
 encodeExpiry ($expiry)
 Encode an expiry time into the DBMS dependent format. More...
 
 endAtomic ($fname=__METHOD__)
 Ends an atomic section of SQL statements. More...
 
 estimateRowCount ($table, $vars= '*', $conds= '', $fname=__METHOD__, $options=[])
 Estimate the number of rows in dataset. More...
 
 explicitTrxActive ()
 
 fieldExists ($table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 flushSnapshot ($fname=__METHOD__)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 freeResult ($res)
 Free a result object returned by query() or select(). More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 
 getFlag ($flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get replica DB lag. More...
 
 getLBInfo ($name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getMasterPos ()
 Get the position of this master. More...
 
 getProperty ($name)
 
 getReplicaPos ()
 Get the replication position of this replica DB. More...
 
 getScopedLockAndFlush ($lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getSearchEngine ()
 
 getServer ()
 Get the server hostname or IP address. More...
 
 getServerInfo ()
 A string describing the current software version, and possibly other details in a user-friendly way. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getWikiID ()
 Alias for getDomainID() More...
 
 ignoreIndexClause ($index)
 IGNORE INDEX clause. More...
 
 implicitGroupby ()
 Returns true if this database does an implicit sort when doing GROUP BY. More...
 
 implicitOrderby ()
 Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. More...
 
 indexExists ($table, $index, $fname=__METHOD__)
 Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. More...
 
 indexInfo ($table, $index, $fname=__METHOD__)
 Get information about an index into an object. More...
 
 indexUnique ($table, $index)
 Determines if a given index is unique. More...
 
 insert ($table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertSelect ($destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 Is a connection to the database open? More...
 
 isQuotedIdentifier ($name)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More...
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries. More...
 
 lastQuery ()
 Return the last query that went through IDatabase::query() More...
 
 limitResult ($sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset. More...
 
 listTables ($prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 listViews ($prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database. More...
 
 lock ($lockName, $method, $timeout=5)
 Acquire a named lock. More...
 
 lockIsFree ($lockName, $method)
 Check to see if a named lock is available (non-blocking) More...
 
 lockTables ($read, $write, $method, $lowPriority=true)
 Lock specific tables. More...
 
 makeList ($a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. More...
 
 makeWhereFrom2d ($data, $baseKey, $subKey)
 Build a partial where clause from a 2-d array such as used for LinkBatch. More...
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master position. More...
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited. More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues. More...
 
 nextSequenceValue ($seqName)
 Returns an appropriately quoted sequence value for inserting a new row. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ($type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 query ($sql, $fname=__METHOD__, $tempIgnore=false)
 Run an SQL query and return the result. More...
 
 replace ($table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 reportConnectionError ($error= 'Unknown error')
 
 reportQueryError ($error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error. More...
 
 restoreFlags ($state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ($fname=__METHOD__, $flush= '')
 Rollback a transaction previously started using begin(). More...
 
 runOnTransactionIdleCallbacks ($trigger)
 Actually run and consume any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually run and consume any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ($trigger)
 Actually run any "transaction listener" callbacks. More...
 
 select ($table, $vars, $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectDB ($db)
 Change the current database. More...
 
 selectField ($table, $var, $cond= '', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ($table, $var, $cond= '', $fname=__METHOD__, $options=[], $join_conds=[])
 
 selectRow ($table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ($tables, $vars= '*', $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 selectSQLText ($table, $vars, $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
 The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed. More...
 
 serverIsReadOnly ()
 
 setBigSelects ($value=true)
 Allow or deny "big selects" for this session only. More...
 
 setFlag ($flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setLazyMasterHandle (IDatabase $conn)
 Set a lazy-connecting DB handle to the master DB (for replication status purposes) More...
 
 setLBInfo ($name, $value=null)
 Set the LB info array, or a member of it. More...
 
 setLogger (LoggerInterface $logger)
 
 setSchemaVars ($vars)
 Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More...
 
 setSessionOptions (array $options)
 Override database's default behavior. More...
 
 setTableAliases (array $aliases)
 Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. More...
 
 setTransactionListener ($name, callable $callback=null)
 Run a callback each time any transaction commits or rolls back. More...
 
 setTrxEndCallbackSuppression ($suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks. More...
 
 sourceFile ($filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file. More...
 
 sourceStream ($fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle. More...
 
 startAtomic ($fname=__METHOD__)
 Begin an atomic section of statements. More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strencode ($s)
 Wrapper for addslashes() More...
 
 strreplace ($orig, $old, $new)
 Returns a comand for str_replace function in SQL query. More...
 
 tableExists ($table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableName ($name, $format= 'quoted')
 Format a table name ready for use in constructing an SQL query. More...
 
 tableNames ()
 Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More...
 
 tableNamesN ()
 Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More...
 
 tablePrefix ($prefix=null)
 Get/set the table prefix. More...
 
 textFieldSize ($table, $field)
 Returns the size of a text field, or -1 for "unlimited". More...
 
 timestamp ($ts=0)
 Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More...
 
 timestampOrNull ($ts=null)
 Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More...
 
 trxLevel ()
 Gets the current transaction level. More...
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionQueries ($sqls, $all)
 Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. More...
 
 unionSupportsOrderAndLimit ()
 Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More...
 
 unlock ($lockName, $method)
 Release a lock. More...
 
 unlockTables ($method)
 Unlock specific tables. More...
 
 update ($table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 upsert ($table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...
 
 useIndexClause ($index)
 USE INDEX clause. More...
 
 wasConnectionError ($errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...
 
 writesPending ()
 
- Public Member Functions inherited from IDatabase
 selectFieldValues ($table, $var, $cond= '', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 

Protected Member Functions

 addSql ($sql)
 
 checkFunctionName ($fname)
 
 closeConnection ()
 
 doQuery ($sql)
 
- Protected Member Functions inherited from Database
 assertOpen ()
 Make sure isOpen() returns true as a sanity check. More...
 
 closeConnection ()
 Closes underlying database connection. More...
 
 doBegin ($fname)
 Issues the BEGIN command to the database server. More...
 
 doCommit ($fname)
 Issues the COMMIT command to the database server. More...
 
 doQuery ($sql)
 The DBMS-dependent part of query() More...
 
 doRollback ($fname)
 Issues the ROLLBACK command to the database server. More...
 
 escapeLikeInternal ($s)
 
 fieldNamesWithAlias ($fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ($name, $alias=false)
 Get an aliased field name e.g. More...
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server. More...
 
 getBindingHandle ()
 Get the underlying binding handle, mConn. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getQueryVerb ($sql)
 
 getReadOnlyReason ()
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 ignoreErrors ($ignoreErrors=null)
 Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More...
 
 indexName ($index)
 Get the name of an index in a given table. More...
 
 installErrorHandler ()
 
 isTransactableQuery ($sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 isWriteQuery ($sql)
 Determine whether a query writes to the DB. More...
 
 makeGroupByWithHaving ($options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeInsertOptions ($options)
 Helper for Database::insert(). More...
 
 makeOrderBy ($options)
 Returns an optional ORDER BY. More...
 
 makeSelectOptions ($options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More...
 
 makeUpdateOptions ($options)
 Make UPDATE options for the Database::update function. More...
 
 makeUpdateOptionsArray ($options)
 Make UPDATE options array for Database::makeUpdateOptions. More...
 
 nativeInsertSelect ($destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 
 nativeReplace ($table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 pendingWriteAndCallbackCallers ()
 
 reconnect ()
 
 registerTempTableOperation ($sql)
 
 replaceVars ($ins)
 Database independent variable replacement. More...
 
 requiresDatabaseUser ()
 
 restoreErrorHandler ()
 
 resultObject ($result)
 Take the result from a query, and wrap it in a ResultWrapper if necessary. More...
 
 tableNamesWithAlias ($tables)
 Gets an array of aliased table names. More...
 
 tableNamesWithIndexClauseOrJOIN ($tables, $use_index=[], $ignore_index=[], $join_conds=[])
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. More...
 
 tableNameWithAlias ($name, $alias=false)
 Get an aliased table name e.g. More...
 

Protected Attributes

 $lastSqls = []
 Array of lastSqls passed to query(), This is an array since some methods in Database can do more than one query. More...
 
array $nextResult = []
 List of row arrays. More...
 
 $tablesExists
 Array of tables to be considered as existing by tableExist() Use setExistingTables() to alter. More...
 
 $testName = []
 CLASS of the test suite, used to determine, if the function name is passed every time to query() More...
 
- Protected Attributes inherited from Database
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 
callback $errorLogger
 Error logging callback. More...
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
float $lastPing = 0.0
 UNIX timestamp. More...
 
resource null $mConn = null
 Database connection. More...
 
string $mDBname
 
bool null $mDefaultBigSelects = null
 
integer $mFlags
 
string $mLastQuery = ''
 SQL query. More...
 
float bool $mLastWriteTime = false
 UNIX timestamp of last write query. More...
 
array $mLBInfo = []
 
bool $mOpened = false
 
string $mPassword
 
string bool $mPHPError = false
 
string $mSchema = ''
 
array bool $mSchemaVars = false
 
string $mServer
 
array $mSessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
array $mSessionVars = []
 
string $mTablePrefix = ''
 
array[] $mTrxEndCallbacks = []
 List of (callable, method name) More...
 
bool $mTrxEndCallbacksSuppressed = false
 Whether to suppress triggering of transaction end callbacks. More...
 
array[] $mTrxIdleCallbacks = []
 List of (callable, method name) More...
 
int $mTrxLevel = 0
 Either 1 if a transaction is active or 0 otherwise. More...
 
array[] $mTrxPreCommitCallbacks = []
 List of (callable, method name) More...
 
callable[] $mTrxRecurringCallbacks = []
 Map of (name => callable) More...
 
string $mTrxShortId = ''
 Either a short hexidecimal string if a transaction is active or "". More...
 
string $mUser
 
array null $preparedArgs
 
object string $profiler
 Class name or object With profileIn/profileOut methods. More...
 
LoggerInterface $queryLogger
 
BagOStuff $srvCache
 APC cache. More...
 
 $tableAliases = []
 
TransactionProfiler $trxProfiler
 

Additional Inherited Members

- Static Public Member Functions inherited from Database
static factory ($dbType, $p=[])
 Construct a Database subclass instance given a database type and parameters. More...
 
static getCacheSetOptions (IDatabase $db1)
 Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. More...
 
- Public Attributes inherited from Database
const DEADLOCK_DELAY_MAX = 1500000
 Maximum time to wait before retry. More...
 
const DEADLOCK_DELAY_MIN = 500000
 Minimum time to wait before retry, in microseconds. More...
 
const DEADLOCK_TRIES = 4
 Number of times to re-try an operation in case of deadlock. More...
 
const PING_QUERY = 'SELECT 1 AS ping'
 
const PING_TTL = 1.0
 How long before it is worth doing a dummy query to test the connection. More...
 
const SLOW_WRITE_SEC = .500
 
const SMALL_WRITE_ROWS = 100
 
const TINY_WRITE_SEC = .010
 
- Static Protected Member Functions inherited from Database
static generalizeSQL ($sql)
 Removes most variables from an SQL query and replaces them with X or N for numbers. More...
 

Detailed Description

Helper for testing the methods from the Database class.

Since
1.22

Definition at line 7 of file DatabaseTestHelper.php.

Constructor & Destructor Documentation

DatabaseTestHelper::__construct (   $testName,
array  $opts = [] 
)

Definition at line 31 of file DatabaseTestHelper.php.

References $e, $testName, DatabaseDomain\newUnspecified(), and wfWarn().

Member Function Documentation

DatabaseTestHelper::addIdentifierQuotes (   $s)

Definition at line 88 of file DatabaseTestHelper.php.

References $s.

DatabaseTestHelper::addSql (   $sql)
protected

Definition at line 67 of file DatabaseTestHelper.php.

Referenced by query().

DatabaseTestHelper::affectedRows ( )

Get the number of rows affected by the last write query.

See also
http://www.php.net/mysql_affected_rows
Returns
int

Implements IDatabase.

Definition at line 168 of file DatabaseTestHelper.php.

DatabaseTestHelper::checkFunctionName (   $fname)
protected

Definition at line 75 of file DatabaseTestHelper.php.

References $fname.

Referenced by query(), and tableExists().

DatabaseTestHelper::closeConnection ( )
protected

Definition at line 193 of file DatabaseTestHelper.php.

DatabaseTestHelper::dataSeek (   $res,
  $row 
)

Change the position of the cursor in a result object.

See also
http://www.php.net/mysql_data_seek
Parameters
mixed$resA SQL result
int$row

Implements IDatabase.

Definition at line 148 of file DatabaseTestHelper.php.

DatabaseTestHelper::doQuery (   $sql)
protected

Definition at line 197 of file DatabaseTestHelper.php.

References $nextResult, and $res.

DatabaseTestHelper::fetchObject (   $res)

Fetch the next row from the given result object, in object form.

Fields can be retrieved with $row->fieldname, with fields acting like member variables. If no more rows are available, false is returned.

Parameters
ResultWrapper | stdClass$resObject as returned from IDatabase::query(), etc.
Returns
stdClass|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements IDatabase.

Definition at line 124 of file DatabaseTestHelper.php.

DatabaseTestHelper::fetchRow (   $res)

Fetch the next row from the given result object, in associative array form.

Fields are retrieved with $row['fieldname']. If no more rows are available, false is returned.

Parameters
ResultWrapper$resResult object as returned from IDatabase::query(), etc.
Returns
array|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements IDatabase.

Definition at line 128 of file DatabaseTestHelper.php.

DatabaseTestHelper::fieldInfo (   $table,
  $field 
)

mysql_fetch_field() wrapper Returns false if the field doesn't exist

Parameters
string$tableTable name
string$fieldField name
Returns
Field

Implements IDatabase.

Definition at line 160 of file DatabaseTestHelper.php.

DatabaseTestHelper::fieldName (   $res,
  $n 
)

Get a field name in a result object.

See also
http://www.php.net/mysql_field_name
Parameters
mixed$resA SQL result
int$n
Returns
string

Implements IDatabase.

Definition at line 140 of file DatabaseTestHelper.php.

DatabaseTestHelper::forceNextResult (   $res)
Parameters
mixed$resUse an array of row arrays to set row result

Definition at line 63 of file DatabaseTestHelper.php.

References $res.

DatabaseTestHelper::getLastSqls ( )

Returns SQL queries grouped by '; ' Clear the list of queries that have been done so far.

Definition at line 49 of file DatabaseTestHelper.php.

References $lastSqls.

DatabaseTestHelper::getServerInfo ( )

A string describing the current software version, and possibly other details in a user-friendly way.

Will be listed on Special:Version, etc. Use getServerVersion() to get machine-friendly information.

Returns
string Version information from the database server

Implements IDatabase.

Definition at line 180 of file DatabaseTestHelper.php.

DatabaseTestHelper::getServerVersion ( )

A string describing the current software version, like from mysql_get_server_info().

Returns
string Version information from the database server.

Implements IDatabase.

Definition at line 176 of file DatabaseTestHelper.php.

DatabaseTestHelper::getSoftwareLink ( )

Returns a wikitext link to the DB's website, e.g., return "[http://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website.

Returns
string Wikitext of a link to the server software's web site

Implements IDatabase.

Definition at line 172 of file DatabaseTestHelper.php.

DatabaseTestHelper::getType ( )

Get the type of the DBMS, as it appears in $wgDBtype.

Returns
string

Implements IDatabase.

Definition at line 116 of file DatabaseTestHelper.php.

DatabaseTestHelper::indexInfo (   $table,
  $index,
  $fname = 'Database::indexInfo' 
)

Definition at line 164 of file DatabaseTestHelper.php.

DatabaseTestHelper::insertId ( )

Get the inserted value of an auto-increment row.

The value inserted should be fetched from nextSequenceValue()

Example: $id = $dbw->nextSequenceValue( 'page_page_id_seq' ); $dbw->insert( 'page', [ 'page_id' => $id ] ); $id = $dbw->insertId();

Returns
int

Implements IDatabase.

Definition at line 144 of file DatabaseTestHelper.php.

DatabaseTestHelper::isOpen ( )

Is a connection to the database open?

Returns
bool

Implements IDatabase.

Definition at line 184 of file DatabaseTestHelper.php.

DatabaseTestHelper::lastErrno ( )

Get the last error number.

See also
http://www.php.net/mysql_errno
Returns
int

Implements IDatabase.

Definition at line 152 of file DatabaseTestHelper.php.

DatabaseTestHelper::lastError ( )

Get a description of the last error.

See also
http://www.php.net/mysql_error
Returns
string

Implements IDatabase.

Definition at line 156 of file DatabaseTestHelper.php.

DatabaseTestHelper::nativeReplace (   $table,
  $rows,
  $fname 
)

Definition at line 112 of file DatabaseTestHelper.php.

References $fname.

DatabaseTestHelper::numFields (   $res)

Get the number of fields in a result object.

See also
http://www.php.net/mysql_num_fields
Parameters
mixed$resA SQL result
Returns
int

Implements IDatabase.

Definition at line 136 of file DatabaseTestHelper.php.

DatabaseTestHelper::numRows (   $res)

Get the number of rows in a result object.

Parameters
mixed$resA SQL result
Returns
int

Implements IDatabase.

Definition at line 132 of file DatabaseTestHelper.php.

DatabaseTestHelper::open (   $server,
  $user,
  $password,
  $dbName 
)

Open a connection to the database.

Usually aborts on failure

Parameters
string$serverDatabase server host
string$userDatabase user name
string$passwordDatabase user password
string$dbNameDatabase name
Returns
bool
Exceptions
DBConnectionError

Implements IDatabase.

Definition at line 120 of file DatabaseTestHelper.php.

DatabaseTestHelper::ping ( $rtt = null)

Ping the server and try to reconnect if it there is no connection.

Parameters
float | null&$rttValue to store the estimated RTT [optional]
Returns
bool Success or failure

Implements IDatabase.

Definition at line 188 of file DatabaseTestHelper.php.

DatabaseTestHelper::query (   $sql,
  $fname = '',
  $tempIgnore = false 
)

Run an SQL query and return the result.

Normally throws a DBQueryError on failure. If errors are ignored, returns false instead.

In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.

However, the query wrappers themselves should call this function.

Parameters
string$sqlSQL query
string$fnameName of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info)
bool$tempIgnoreWhether to avoid throwing an exception on errors... maybe best to catch the exception instead?
Exceptions
DBError
Returns
bool|ResultWrapper True for a successful write query, ResultWrapper object for a successful read query, or false on failure if $tempIgnore set

Implements IDatabase.

Definition at line 93 of file DatabaseTestHelper.php.

References $fname, addSql(), checkFunctionName(), and query.

DatabaseTestHelper::setExistingTables (   $tablesExists)

Definition at line 56 of file DatabaseTestHelper.php.

References $tablesExists, and array().

DatabaseTestHelper::strencode (   $s)

Definition at line 83 of file DatabaseTestHelper.php.

References $s.

DatabaseTestHelper::tableExists (   $table,
  $fname = __METHOD__ 
)

Query whether a given table exists.

Parameters
string$table
string$fname
Returns
bool

Implements IDatabase.

Definition at line 100 of file DatabaseTestHelper.php.

References $fname, array(), checkFunctionName(), and Database\tableName().

Member Data Documentation

DatabaseTestHelper::$lastSqls = []
protected

Array of lastSqls passed to query(), This is an array since some methods in Database can do more than one query.

Cleared when calling getLastSqls().

Definition at line 20 of file DatabaseTestHelper.php.

Referenced by getLastSqls().

array DatabaseTestHelper::$nextResult = []
protected

List of row arrays.

Definition at line 23 of file DatabaseTestHelper.php.

Referenced by doQuery().

DatabaseTestHelper::$tablesExists
protected

Array of tables to be considered as existing by tableExist() Use setExistingTables() to alter.

Definition at line 29 of file DatabaseTestHelper.php.

Referenced by setExistingTables().

DatabaseTestHelper::$testName = []
protected

CLASS of the test suite, used to determine, if the function name is passed every time to query()

Definition at line 13 of file DatabaseTestHelper.php.

Referenced by __construct().


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