* This method is doing Q encoding inside encoded-words as defined by RFC 2047
* This is for email headers.
* The built in quoted_printable_encode() is for email bodies
+ * @param string $string
+ * @param string $charset
* @return string
*/
public static function quotedPrintable( $string, $charset = '' ) {
/**
* What language to render file in if none selected.
*
+ * @param File $file
* @return string Language code.
*/
public function getDefaultRenderLanguage( File $file ) {
/**
* We do not support making animated svg thumbnails
+ * @param File $file
+ * @return bool
*/
function canAnimateThumbnail( $file ) {
return false;
*
* Image magick doesn't support indexed xcf files as of current
* writing (as of 6.8.9-3)
+ * @param File $file
+ * @return bool
*/
public function canRender( $file ) {
wfSuppressWarnings();
/**
* Register core modules and runs registration hooks.
+ * @param Config|null $config
*/
public function __construct( Config $config = null ) {
global $IP;
/**
* Get the definition summary for this module.
*
+ * @param ResourceLoaderContext $context
* @return array
*/
public function getDefinitionSummary( ResourceLoaderContext $context ) {
*
* @since 1.23
*
+ * @param ResourceLoaderContext $context
* @return int UNIX timestamp or 0 if no definition summary was provided
* by getDefinitionSummary()
*/
*
* @since 1.23
*
+ * @param ResourceLoaderContext $context
* @return array|null
*/
public function getDefinitionSummary( ResourceLoaderContext $context ) {
/**
* Get the definition summary for this module.
*
+ * @param ResourceLoaderContext $context
* @return array
*/
public function getDefinitionSummary( ResourceLoaderContext $context ) {
* Returns true if the item is "current", and the operation to set the given
* bits can't be executed for that reason
* STUB
+ * @param int $newBits
* @return bool
*/
public function isHideCurrentOp( $newBits ) {
* If the update fails because it did not match, the function should return
* false. This prevents concurrency problems.
*
+ * @param int $newBits
* @return bool Success
*/
abstract public function setBits( $newBits );
* Transform search term in cases when parts of the query came as different
* GET params (when supported), e.g. for prefix queries:
* search=test&prefix=Main_Page/Archive -> test prefix:Main Page/Archive
+ * @param string $term
+ * @return string
*/
function transformSearchTerm( $term ) {
return $term;
/**
* Really find the title match.
+ * @param string $searchterm
* @return null|Title
*/
private static function getNearMatchInternal( $searchterm ) {
/**
* Basic wikitext removal
* @protected
+ * @param string $text
* @return mixed
*/
function removeWiki( $text ) {
* Does not do anything for generic search engine
* subclasses may define this though
*
+ * @param string $filteredTerm
+ * @param bool $fulltext
* @return string
*/
function queryRanking( $filteredTerm, $fulltext ) {
}
/** @todo document
+ * @param string $filteredText
+ * @param bool $fulltext
* @return string
*/
function parseQuery( $filteredText, $fulltext ) {
/**
* @since 1.18 (changed)
+ * @param string $filteredTerm
+ * @param bool $fulltext
* @return array
*/
function getCountQuery( $filteredTerm, $fulltext ) {
/**
* Converts some characters for MySQL's indexing to grok it correctly,
* and pads short words to overcome limitations.
+ * @param string $string
* @return mixed|string
*/
function normalizeText( $string ) {
* Armor a case-folded UTF-8 string to get through MySQL's
* fulltext search without being mucked up by funny charset
* settings or anything else of the sort.
+ * @param array $matches
* @return string
*/
protected function stripForSearchCallback( $matches ) {
* Does not do anything for generic search engine
* subclasses may define this though
*
+ * @param string $filteredTerm
+ * @param bool $fulltext
* @return string
*/
function queryRanking( $filteredTerm, $fulltext ) {
/**
* Parse a user input search string, and return an SQL fragment to be used
* as part of a WHERE clause
+ * @param string $filteredText
+ * @param bool $fulltext
* @return string
*/
function parseQuery( $filteredText, $fulltext ) {
* Parse the user's query and transform it into an SQL fragment which will
* become part of a WHERE clause
*
+ * @param string $filteredText
+ * @param bool $fulltext
* @return string
*/
function parseQuery( $filteredText, $fulltext ) {
/** @var Config $config */
protected $config;
+
/**
- * @var Config $config
+ * @param Config $config
*/
function __construct( Config $config = null ) {
$this->data = array();
/**
* Main execution point
+ * @param string|null $par
*/
function execute( $par ) {
$this->getOutput()->disallowUserJs();
}
/**
+ * @param string $oldpass
+ * @param string $newpass
+ * @param string $retype
* @throws PasswordError When cannot set the new password because requirements not met.
*/
protected function attemptReset( $oldpass, $newpass, $retype ) {
/**
* Show the special page
+ * @param string|null $subpage
*/
function execute( $subpage ) {
global $wgParser;
/**
* Execute
+ * @param string|null $par
*/
function execute( $par ) {
$this->setHeaders();
/**
* Show the special page
+ * @param string|null $par
*/
public function execute( $par ) {
global $wgImplicitGroups;
/**
* Set $mType and $mValue based on parsed value of $subpage.
+ * @param string $subpage
*/
function setParameter( $subpage ) {
// parse $subpage to pull out the parts
/**
* Suppress the submit button if there's nothing to do;
* provide additional message on it otherwise.
+ * @param HTMLForm $form
*/
protected function alterForm( HTMLForm $form ) {
if ( $this->getTokensList() ) {
/**
* Report that the submit operation failed
+ * @param Status $status
*/
protected function failure( $status ) {
// Messages: revdelete-failure, logdelete-failure
/**
* Add the JS
+ * @param string|null $par
*/
public function execute( $par ) {
parent::execute( $par );
}
/**
+ * @param string $msg
+ * @param string $msgtype
* @private
*/
function mainLoginForm( $msg, $msgtype = 'error' ) {
}
/**
+ * @param string $type
* @private
*/
function cookieRedirectCheck( $type ) {
}
/**
+ * @param string $type
* @private
*/
function onCookieRedirectCheck( $type ) {
/**
* main()
+ * @param string|null $par
*/
public function execute( $par ) {
global $IP, $wgExtensionCredits;
/**
* Find the index number of the plural rule appropriate for the given number
+ * @param int $number
* @return int The index number of the plural rule
*/
public function getPluralRuleIndexNumber( $number ) {
* For example, if the language is set to Arabic, getPluralType(5) should
* return 'few'.
* @since 1.22
+ * @param int $number
* @return string The name of the plural rule type, e.g. one, two, few, many
*/
public function getPluralRuleType( $number ) {
/**
* Private constructor.
+ * @param string $rule
*/
protected function __construct( $rule ) {
$this->rule = $rule;
/**
* Throw an error
+ * @param string $message
*/
protected function error( $message ) {
throw new CLDRPluralRuleError( $message );