abstract function outputPage( OutputPage $out = null );
/**
- * @param $data
+ * @param $data array
* @return string
*/
static function makeVariablesScript( $data ) {
}
/**
- * @param $debugText
+ * @param $debugText string
* @return string
*/
private function formatDebugHTML( $debugText ) {
}
/**
- * @param string $type
+ * @param $type string
* @return string
*/
function getCopyright( $type = 'detect' ) {
}
/**
- * @param $id
+ * @param $id User|int
* @return bool
*/
function showEmailUser( $id ) {
}
/**
- * @param $name
+ * @param $name string
* @param $urlaction string
* @return String
*/
}
/**
- * @param $name
- * @param $subpage
+ * @param $name string
+ * @param $subpage string
* @param $urlaction string
* @return String
*/
}
/**
- * @param $name
+ * @param $name string
* @param $urlaction string
* @return String
*/
}
/**
- * @param $name
+ * @param $name string
* @param $urlaction string
* @return String
*/
* make sure we have some title to operate on
*
* @param $title Title
- * @param $name
+ * @param $name string
*/
static function checkTitle( &$title, $name ) {
if ( !is_object( $title ) ) {
* Any implementation of this function should *not* involve reusing
* sequence numbers created for rolled-back transactions.
* See http://bugs.mysql.com/bug.php?id=30767 for details.
- * @param $seqName
+ * @param $seqName string
* @return null
*/
function nextSequenceValue( $seqName ) {
* REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
* statement.
*
- * @param $table Table name
- * @param $rows Rows to insert
- * @param $fname Caller function name
+ * @param $table string Table name
+ * @param $rows array Rows to insert
+ * @param $fname string Caller function name
*
* @return ResultWrapper
*/
* don't allow simple quoted strings to be inserted. To insert into such
* a field, pass the data through this function before passing it to
* DatabaseBase::insert().
- * @param $b
- * @return
+ * @param $b string
+ * @return string
*/
function encodeBlob( $b ) {
return $b;
* Some DBMSs return a special placeholder object representing blob fields
* in result objects. Pass the object through this function to return the
* original string.
- * @param $b
- * @return
+ * @param $b string
+ * @return string
*/
function decodeBlob( $b ) {
return $b;
/**
* @param $db DatabaseBase
- * @param $error
- * @param $errno
- * @param $sql
- * @param $fname
+ * @param $error string
+ * @param $errno int|string
+ * @param $sql string
+ * @param $fname string
*/
function __construct( DatabaseBase &$db, $error, $errno, $sql, $fname ) {
$message = "A database error has occurred. Did you forget to run maintenance/update.php after upgrading? See: https://www.mediawiki.org/wiki/Manual:Upgrading#Run_the_update_script\n" .
}
/**
- * @param $sql
+ * @param $sql string
* @return resource
*/
protected function doQuery( $sql ) {
}
/**
- * @param $server
- * @param $user
- * @param $password
- * @param $dbName
+ * @param $server string
+ * @param $user string
+ * @param $password string
+ * @param $dbName string
* @return bool
* @throws DBConnectionError
*/
}
/**
- * @param $res
+ * @param $res ResultWrapper
* @throws DBUnexpectedError
*/
function freeResult( $res ) {
}
/**
- * @param $res
+ * @param $res ResultWrapper
* @return object|stdClass
* @throws DBUnexpectedError
*/
}
/**
- * @param $res
+ * @param $res ResultWrapper
* @return array
* @throws DBUnexpectedError
*/
/**
* @throws DBUnexpectedError
- * @param $res
+ * @param $res ResultWrapper
* @return int
*/
function numRows( $res ) {
}
/**
- * @param $res
+ * @param $res ResultWrapper
* @return int
*/
function numFields( $res ) {
}
/**
- * @param $res
- * @param $n
+ * @param $res ResultWrapper
+ * @param $n string
* @return string
*/
function fieldName( $res, $n ) {
}
/**
- * @param $res
+ * @param $res ResultWrapper
* @param $row
* @return bool
*/
}
/**
- * @param $table
+ * @param $table string
* @param $uniqueIndexes
- * @param $rows
+ * @param $rows array
* @param $fname string
* @return ResultWrapper
*/
* Get information about an index into an object
* Returns false if the index does not exist
*
- * @param $table
- * @param $index
+ * @param $table string
+ * @param $index string
* @param $fname string
* @return false|array
*/
}
/**
- * @param $lockName
- * @param $method
+ * @param $lockName string
+ * @param $method string
* @param $timeout int
* @return bool
*/
/**
* FROM MYSQL DOCS: http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
- * @param $lockName
+ * @param $lockName string
* @param $method string
- * @return
+ * @return bool
*/
public function unlock( $lockName, $method ) {
$lockName = $this->addQuotes( $lockName );
}
/**
- * @param $read
- * @param $write
- * @param $method
+ * @param $read array
+ * @param $write array
+ * @param $method string
* @param $lowPriority bool
*/
public function lockTables( $read, $write, $method, $lowPriority = true ) {
/**
* DELETE where the condition is a join. MySql uses multi-table deletes.
- * @param $delTable
- * @param $joinTable
- * @param $delVar
- * @param $joinVar
+ * @param $delTable string
+ * @param $joinTable string
+ * @param $delVar string
+ * @param $joinVar string
* @param $conds array|string
* @param $fname bool
- * @return bool|\ResultWrapper
+ * @return bool|ResultWrapper
*/
function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'DatabaseBase::deleteJoin' ) {
if ( !$conds ) {
/**
* Shut down, close connections and destroy the cached instance.
- *
*/
static function destroyInstance() {
if ( self::$instance ) {
* Execute a function for each tracked load balancer
* The callback is called with the load balancer as the first parameter,
* and $params passed as the subsequent parameters.
- * @param $callback
+ * @param $callback string|array
* @param array $params
*/
abstract function forEachLB( $callback, $params = array() );
/**
* Call a method of each tracked load balancer
- * @param $methodName
+ * @param $methodName string
* @param $args array
*/
function forEachLBCallMethod( $methodName, $args = array() ) {
/**
* Private helper for forEachLBCallMethod
* @param $loadBalancer
- * @param $methodName
+ * @param $methodName string
* @param $args
*/
function callMethod( $loadBalancer, $methodName, $args ) {
var $lastWiki, $lastSection;
/**
- * @param $conf
+ * @param $conf array
*/
function __construct( $conf ) {
$this->chronProt = new ChronologyProtector;
* Make a new load balancer object based on template and load array
*
* @param $template
- * @param $loads
+ * @param $loads array
* @param $groupLoads
* @return LoadBalancer
*/
* Make a server array as expected by LoadBalancer::__construct, using a template and load array
*
* @param $template
- * @param $loads
+ * @param $loads array
* @param $groupLoads
* @return array
*/
/**
* Get the database name and prefix based on the wiki ID
- * @param bool $wiki
+ * @param $wiki bool
* @return array
*/
function getDBNameAndPrefix( $wiki = false ) {
* Given an array of non-normalised probabilities, this function will select
* an element and return the appropriate key
*
- * @param $weights
+ * @param $weights array
*
* @return int
*/
}
/**
- * @param $loads
+ * @param $loads array
* @param $wiki bool
* @return bool|int|string
*/
/**
* Wait for a specified number of microseconds, and return the period waited
- * @param $t
- * @return
+ * @param $t int
+ * @return int
*/
function sleep( $t ) {
wfProfileIn( __METHOD__ );
* Set the master wait position
* If a DB_SLAVE connection has been opened already, waits
* Otherwise sets a variable telling it to wait if such a connection is opened
- * @param $pos
+ * @param $pos int
*/
public function waitFor( $pos ) {
wfProfileIn( __METHOD__ );
/**
* Set the master wait position and wait for ALL slaves to catch up to it
- * @param $pos
+ * @param $pos int
*/
public function waitForAll( $pos ) {
wfProfileIn( __METHOD__ );
* Get any open connection to a given server index, local or foreign
* Returns false if there is no connection open
*
- * @param $i
+ * @param $i int
* @return DatabaseBase|false
*/
function getAnyOpenConnection( $i ) {