/**
* Get the component of an IP address which is certain to be the same between an IP
* address and a rangeblock containing that IP address.
- * @param $hex String Hexadecimal IP representation
+ * @param $hex String Hexadecimal IP representation
* @return String
*/
protected static function getIpFragment( $hex ) {
/**
* Create a new Block object from a database row
- * @param $row ResultWrapper row from the ipblocks table
+ * @param $row ResultWrapper row from the ipblocks table
* @return Block
*/
public static function newFromRow( $row ) {
/**
* Get/set whether the Block is a hardblock (affects logged-in users on a given IP/range
* @param $x Bool
- * @return Bool
+ * @return Bool
*/
public function isHardblock( $x = null ) {
wfSetVar( $this->isHardblock, $x );
protected $followRedirects = false;
/**
- * @var CookieJar
+ * @var CookieJar
*/
protected $cookieJar;
/**
* @param $title Title
- * @param $file File
+ * @param $file File
* @param array $frameParams
* @param array $handlerParams
* @param bool $time
/**
* @param $contextTitle Title
- * @param $target
- * @param $text
+ * @param $target
+ * @param $text
* @return string
*/
public static function normalizeSubpageLink( $contextTitle, $target, &$text ) {
}
/**
- * @param $text
+ * @param $text
* @return bool
*/
function matchStartAndRemove( &$text ) {
/**
* Set the highest level of CSS/JS untrustworthiness allowed
- * @param $type String ResourceLoaderModule TYPE_ constant
- * @param $level Int ResourceLoaderModule class constant
+ * @param $type String ResourceLoaderModule TYPE_ constant
+ * @param $level Int ResourceLoaderModule class constant
*/
public function setAllowedModules( $type, $level ) {
$this->mAllowedModules[$type] = $level;
/**
* As for setAllowedModules(), but don't inadvertently make the page more accessible
- * @param $type String
- * @param $level Int ResourceLoaderModule class constant
+ * @param $type String
+ * @param $level Int ResourceLoaderModule class constant
*/
public function reduceAllowedModules( $type, $level ) {
$this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
* Create a section edit link. This supersedes editSectionLink() and
* editSectionLinkForOther().
*
- * @param $nt Title The title being linked to (may not be the same as
+ * @param $nt Title The title being linked to (may not be the same as
* the current page, if the section is included from a template)
* @param string $section The designation of the section being pointed to,
* to be included in the link, like "§ion=$section"
* @param string $tooltip The tooltip to use for the link: will be escaped
* and wrapped in the 'editsectionhint' message
- * @param $lang string Language code
- * @return string HTML to use for edit link
+ * @param $lang string Language code
+ * @return string HTML to use for edit link
*/
public function doEditSectionLink( Title $nt, $section, $tooltip = null, $lang = false ) {
// HTML generated here should probably have userlangattributes
}
/**
- * @param $row
+ * @param $row
* @return void
*/
protected function setCurrent( $row ) {
* label => value
* label => ( label => value, label => value )
*
- * @param $options
+ * @param $options
*/
public function addOptions( $options ) {
$this->options[] = $options;
* label => value
* label => ( label => value, label => value )
*
- * @param $options
+ * @param $options
* @param bool $default
* @return string
*/
* Process the form on POST submission. If you return false from getFormFields(),
* this will obviously never be reached. If you don't want to do anything with the
* form, just return false here
- * @param $data Array
+ * @param $data Array
* @return Bool|Array true for success, false for didn't-try, array of errors on failure
*/
abstract public function onSubmit( $data );
/**
* Callback function used in requireOnlyOneParameter to check whether required parameters are set
*
- * @param $x object Parameter to check is not null/false
+ * @param $x object Parameter to check is not null/false
* @return bool
*/
private function parameterNotEmpty( $x ) {
/**
* Adds a warning to the output, else dies
*
- * @param $msg String Message to show as a warning, or error message if dying
- * @param $enforceLimits Boolean Whether this is an enforce (die)
+ * @param $msg String Message to show as a warning, or error message if dying
+ * @param $enforceLimits Boolean Whether this is an enforce (die)
*/
private function warnOrDie( $msg, $enforceLimits = false ) {
if ( $enforceLimits ) {
}
/**
- * @param $module ApiBase
- * @param $type String What type of request is this? e.g. action, query, list, prop, meta, format
+ * @param $module ApiBase
+ * @param $type String What type of request is this? e.g. action, query, list, prop, meta, format
* @return string
*/
private function buildModuleHelp( $module, $type ) {
/**
* @param Title $fromTitle
* @param Title $toTitle
- * @param $reason
- * @param $noredirect
+ * @param $reason
+ * @param $noredirect
* @return array
*/
public function moveSubpages( $fromTitle, $toTitle, $reason, $noredirect ) {
}
/**
- * @param $randstr
- * @param $limit
- * @param $namespace
+ * @param $randstr
+ * @param $limit
+ * @param $namespace
* @param $resultPageSet ApiPageSet
- * @param $redirect
+ * @param $redirect
* @return void
*/
protected function prepareQuery( $randstr, $limit, $namespace, &$resultPageSet, $redirect ) {
}
/**
- * @param $pageid
- * @param $title
+ * @param $pageid
+ * @param $title
* @param $rc RecentChange (optional)
* @return bool|string
*/
/**
* @throws DBUnexpectedError
- * @param string $table
- * @param string $field
+ * @param string $table
+ * @param string $field
* @return ORAField
*/
function fieldInfo( $table, $field ) {
/** @var bool Whether a transaction is open on this object (internal use only!) */
private $mHasTransaction;
- /** @var bool Whether this update should be wrapped in a transaction */
+ /** @var bool Whether this update should be wrapped in a transaction */
protected $mUseTransaction;
/**
/** @var Language */
protected $mDiffLang;
- /** @var Title */
+ /** @var Title */
public $mOldPage;
- /** @var Title */
+ /** @var Title */
public $mNewPage;
/** @var Revision */
public $mOldRev;
- /** @var Revision */
+ /** @var Revision */
public $mNewRev;
/** @var bool Have the revisions IDs been loaded */
* @since 1.20
*/
abstract class FileJournal {
- /** @var string */
+ /** @var string */
protected $backend;
/** @var int */
}
/**
- * @param $request WebRequest
+ * @param $request WebRequest
*
* @return String
*/
}
/**
- * @param $request WebRequest
+ * @param $request WebRequest
*
* @return String
*/
}
/**
- * @param $request WebRequest
+ * @param $request WebRequest
*
* @return Array("<overall message>","<select value>","<text field value>")
*/
}
/**
- * @param $request WebRequest
+ * @param $request WebRequest
*
* @return String
*/
/**
* @todo Document
- * @param string $type
- * @param Language|null $lang
- * @param Title $title
- * @param array $params
+ * @param string $type
+ * @param Language|null $lang
+ * @param Title $title
+ * @param array $params
* @return string
*/
protected static function getTitleLink( $type, $lang, $title, &$params ) {
class BitmapHandler_ClientOnly extends BitmapHandler {
/**
* @param $image File
- * @param $params
+ * @param $params
* @return bool
*/
function normaliseParams( $image, &$params ) {
/**
* Command statistics
*
- * @var array
- * @access public
+ * @var array
+ * @access public
*/
var $stats;
/**
* Cached Sockets that are connected
*
- * @var array
- * @access private
+ * @var array
+ * @access private
*/
var $_cache_sock;
/**
* Current debug status; 0 - none to 9 - profiling
*
- * @var boolean
- * @access private
+ * @var boolean
+ * @access private
*/
var $_debug;
/**
* Dead hosts, assoc array, 'host'=>'unixtime when ok to check again'
*
- * @var array
- * @access private
+ * @var array
+ * @access private
*/
var $_host_dead;
/**
* Is compression available?
*
- * @var boolean
- * @access private
+ * @var boolean
+ * @access private
*/
var $_have_zlib;
/**
* Do we want to use compression?
*
- * @var boolean
- * @access private
+ * @var boolean
+ * @access private
*/
var $_compress_enable;
/**
* At how many bytes should we compress?
*
- * @var integer
- * @access private
+ * @var integer
+ * @access private
*/
var $_compress_threshold;
/**
* Are we using persistent links?
*
- * @var boolean
- * @access private
+ * @var boolean
+ * @access private
*/
var $_persistent;
/**
* If only using one server; contains ip:port to connect to
*
- * @var string
- * @access private
+ * @var string
+ * @access private
*/
var $_single_sock;
/**
* Array containing ip:port or array(ip:port, weight)
*
- * @var array
- * @access private
+ * @var array
+ * @access private
*/
var $_servers;
/**
* Our bit buckets
*
- * @var array
- * @access private
+ * @var array
+ * @access private
*/
var $_buckets;
/**
* Total # of bit buckets we have
*
- * @var integer
- * @access private
+ * @var integer
+ * @access private
*/
var $_bucketcount;
/**
* # of total servers we have
*
- * @var integer
- * @access private
+ * @var integer
+ * @access private
*/
var $_active;
/**
* Stream timeout in seconds. Applies for example to fread()
*
- * @var integer
- * @access private
+ * @var integer
+ * @access private
*/
var $_timeout_seconds;
/**
* Stream timeout in microseconds
*
- * @var integer
- * @access private
+ * @var integer
+ * @access private
*/
var $_timeout_microseconds;
*
* @param array $args Associative array of settings
*
- * @return mixed
+ * @return mixed
*/
public function __construct( $args ) {
$this->set_servers( isset( $args['servers'] ) ? $args['servers'] : array() );
*
* @param string $sock socket to close
*
- * @access private
+ * @access private
*/
function _close_sock( $sock ) {
$host = array_search( $sock, $this->_cache_sock );
* @param $sock Integer: socket to connect
* @param string $host Host:IP to connect to
*
- * @return boolean
- * @access private
+ * @return boolean
+ * @access private
*/
function _connect_sock( &$sock, $host ) {
list( $ip, $port ) = preg_split( '/:(?=\d)/', $host );
*
* @param string $sock socket to mark as dead
*
- * @access private
+ * @access private
*/
function _dead_sock( $sock ) {
$host = array_search( $sock, $this->_cache_sock );
* @ingroup Parser
*/
class CacheTime {
- /** @var array|bool ParserOptions which have been taken into account to
+ /** @var array|bool ParserOptions which have been taken into account to
* produce output or false if not available.
*/
public $mUsedOptions;
/**
* @param $parser Parser
- * @param $date
+ * @param $date
* @param null $defaultPref
* @return mixed|string
*/
/**
* @param $parser Parser
- * @param $text
+ * @param $text
* @return string
*/
static function anchorencode( $parser, $text ) {
* @param $url String
* @return String
*
- * @todo This can merge genuinely required bits in the path or query string,
- * breaking legit URLs. A proper fix would treat the various parts of
- * the URL differently; as a workaround, just use the output for
- * statistical records, not for actual linking/output.
+ * @todo This can merge genuinely required bits in the path or query string,
+ * breaking legit URLs. A proper fix would treat the various parts of
+ * the URL differently; as a workaround, just use the output for
+ * statistical records, not for actual linking/output.
*/
static function replaceUnusualEscapes( $url ) {
return preg_replace_callback( '/%[0-9A-Fa-f]{2}/',
}
/**
- * @param $i
+ * @param $i
* @return bool
*/
function item( $i ) {
}
/**
- * @param $text
+ * @param $text
* @return mixed
*/
function unstripBoth( $text ) {
/**
* Update *_deleted bitfields in various tables to hide or unhide usernames
- * @param $name String username
- * @param $userId Int user id
- * @param $op String operator '|' or '&'
- * @param $dbw null|DatabaseBase, if you happen to have one lying around
+ * @param $name String username
+ * @param $userId Int user id
+ * @param $op String operator '|' or '&'
+ * @param $dbw null|DatabaseBase, if you happen to have one lying around
* @return bool
*/
private static function setUsernameBitfields( $name, $userId, $op, $dbw ) {
* so that this key can be used instead.
*
* @param $title Title
- * @param $revid
+ * @param $revid
* @return bool|mixed
*/
public static function checkRevisionExistence( $title, $revid ) {
/**
* Process the form on POST submission.
- * @param $data Array
+ * @param $data Array
* @return Bool|Array true for success, false for didn't-try, array of errors on failure
*/
abstract public function onSubmit( array $data );
/// @var Block::TYPE_ constant
protected $type;
- /// @var User|String the previous block target
+ /// @var User|String the previous block target
protected $previousTarget;
/// @var Bool whether the previous submission of the form asked for HideUser
/**
* Given the form data, actually implement a block
- * @param $data Array
- * @param $context IContextSource
+ * @param $data Array
+ * @param $context IContextSource
* @return Bool|String
*/
public static function processForm( array $data, IContextSource $context ) {
/**
* Process the form on POST submission.
- * @param $data Array
+ * @param $data Array
* @return Bool|Array true for success, false for didn't-try, array of errors on failure
*/
public function onSubmit( array $data ) {
* @param Title $title
* @param Title $origTitle
* @param int $revisionCount
- * @param $successCount
- * @param $pageInfo
+ * @param $successCount
+ * @param $pageInfo
* @return void
*/
function reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo ) {
}
/**
- * @param $group String: the name of the group to check
+ * @param $group String: the name of the group to check
* @return bool Can we remove the group?
*/
private function canRemove( $group ) {
}
/**
- * @param $image
+ * @param $image
* @return array|null
*/
function getImageFile( $image ) {
}
/**
- * @param $tog
+ * @param $tog
* @return string
*/
function getUserToggle( $tog ) {
}
/**
- * @param $dbw DatabaseBase
+ * @param $dbw DatabaseBase
* @return void
*/
private function insertData( $dbw ) {
}
/**
- * @param $dbw DatabaseBase
+ * @param $dbw DatabaseBase
* @return void
*/
private function delete( $dbw ) {
}
/**
- * @param $dbw DatabaseBase
+ * @param $dbw DatabaseBase
* @return void
*/
private function truncate( $dbw ) {
/**
* An error occurred.
*
- * @param PHPUnit_Framework_Test $test
- * @param Exception $e
- * @param float $time
+ * @param PHPUnit_Framework_Test $test
+ * @param Exception $e
+ * @param float $time
*/
public function addError( PHPUnit_Framework_Test $test, Exception $e, $time ) {
wfDebugLog( $this->logChannel, 'ERROR in ' . $this->getTestName( $test ) . ': ' . $this->getErrorName( $e ) );
/**
* A failure occurred.
*
- * @param PHPUnit_Framework_Test $test
- * @param PHPUnit_Framework_AssertionFailedError $e
- * @param float $time
+ * @param PHPUnit_Framework_Test $test
+ * @param PHPUnit_Framework_AssertionFailedError $e
+ * @param float $time
*/
public function addFailure( PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time ) {
wfDebugLog( $this->logChannel, 'FAILURE in ' . $this->getTestName( $test ) . ': ' . $this->getErrorName( $e ) );
/**
* Incomplete test.
*
- * @param PHPUnit_Framework_Test $test
- * @param Exception $e
- * @param float $time
+ * @param PHPUnit_Framework_Test $test
+ * @param Exception $e
+ * @param float $time
*/
public function addIncompleteTest( PHPUnit_Framework_Test $test, Exception $e, $time ) {
wfDebugLog( $this->logChannel, 'Incomplete test ' . $this->getTestName( $test ) . ': ' . $this->getErrorName( $e ) );
/**
* Skipped test.
*
- * @param PHPUnit_Framework_Test $test
- * @param Exception $e
- * @param float $time
+ * @param PHPUnit_Framework_Test $test
+ * @param Exception $e
+ * @param float $time
*
- * @since Method available since Release 3.0.0
+ * @since Method available since Release 3.0.0
*/
public function addSkippedTest( PHPUnit_Framework_Test $test, Exception $e, $time ) {
wfDebugLog( $this->logChannel, 'Skipped test ' . $this->getTestName( $test ) . ': ' . $this->getErrorName( $e ) );
/**
* A test suite started.
*
- * @param PHPUnit_Framework_TestSuite $suite
- * @since Method available since Release 2.2.0
+ * @param PHPUnit_Framework_TestSuite $suite
+ * @since Method available since Release 2.2.0
*/
public function startTestSuite( PHPUnit_Framework_TestSuite $suite ) {
wfDebugLog( $this->logChannel, 'START suite ' . $suite->getName() );
/**
* A test suite ended.
*
- * @param PHPUnit_Framework_TestSuite $suite
- * @since Method available since Release 2.2.0
+ * @param PHPUnit_Framework_TestSuite $suite
+ * @since Method available since Release 2.2.0
*/
public function endTestSuite( PHPUnit_Framework_TestSuite $suite ) {
wfDebugLog( $this->logChannel, 'END suite ' . $suite->getName() );
/**
* A test started.
*
- * @param PHPUnit_Framework_Test $test
+ * @param PHPUnit_Framework_Test $test
*/
public function startTest( PHPUnit_Framework_Test $test ) {
wfDebugLog( $this->logChannel, 'Start test ' . $this->getTestName( $test ) );
/**
* A test ended.
*
- * @param PHPUnit_Framework_Test $test
- * @param float $time
+ * @param PHPUnit_Framework_Test $test
+ * @param float $time
*/
public function endTest( PHPUnit_Framework_Test $test, $time ) {
wfDebugLog( $this->logChannel, 'End test ' . $this->getTestName( $test ) );
dépôts / lhc / web / wiklou.git / commitdiff