<exclude name="MediaWiki.Files.ClassMatchesFilename.WrongCase" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.VariableAnalysis.ForbiddenGlobalVariables.ForbiddenGlobal$wgTitle" />
- <exclude name="MediaWiki.Commenting.FunctionComment.SpacingDocStar" />
- <exclude name="MediaWiki.Commenting.FunctionComment.SpacingDocTag" />
<exclude name="Squiz.Scope.MethodScope.Missing" />
<exclude name="Squiz.Scope.MemberVarScope.Missing" />
<exclude name="MediaWiki.Commenting.MissingCovers.MissingCovers" />
*
* @param IDatabase $dbw If you have one available
* @return bool|array False on failure, assoc array on success:
- * ('id' => block ID, 'autoIds' => array of autoblock IDs)
+ * ('id' => block ID, 'autoIds' => array of autoblock IDs)
*/
public function insert( $dbw = null ) {
global $wgBlockDisablesLogin;
* @param string $format The format string (See php's docs)
* @param string $data A binary string of binary data
* @param int|bool $length The minimum length of $data or false. This is to
- * prevent reading beyond the end of $data. false to disable the check.
+ * prevent reading beyond the end of $data. false to disable the check.
*
* Also be careful when using this function to read unsigned 32 bit integer
* because php might make it negative.
* @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
*
* @param string $comment Text to format links in. WARNING! Since the output of this
- * function is html, $comment must be sanitized for use as html. You probably want
- * to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling
- * this function.
+ * function is html, $comment must be sanitized for use as html. You probably want
+ * to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling
+ * this function.
* @param Title|null $title An optional title object used to links to sections
* @param bool $local Whether section links should refer to local page
* @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
* Create a new Title from a prefixed DB key
*
* @param string $key The database key, which has underscores
- * instead of spaces, possibly including namespace and
- * interwiki prefixes
+ * instead of spaces, possibly including namespace and
+ * interwiki prefixes
* @return Title|null Title, or null on an error
*/
public static function newFromDBkey( $key ) {
* @param string $method HTTP method. Usually GET/POST
* @param string $url Full URL to act on. If protocol-relative, will be expanded to an http:// URL
* @param array $options Options to pass to MWHttpRequest object.
- * Possible keys for the array:
+ * Possible keys for the array:
* - timeout Timeout length in seconds
* - connectTimeout Timeout for connection, in seconds (curl only)
* - postData An array of key-value pairs or a url-encoded form data
* @param string $ikm The input keying material
* @param string $salt The salt to add to the ikm, to get the prk
* @param string $info Optional context (change the output without affecting
- * the randomness properties of the output)
+ * the randomness properties of the output)
* @param int $L Number of bytes to return
* @return string Cryptographically secure pseudorandom binary string
*/
* - error : Any cURL error string
* The map also stores integer-indexed copies of these values. This lets callers do:
* @code
- * list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $http->run( $req );
+ * list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $http->run( $req );
* @endcode
* @param array $req HTTP request array
* @param array $opts
* 'expansion-depth-exceeded-category')
* @param string|int|null $current Current value
* @param string|int|null $max Maximum allowed, when an explicit limit has been
- * exceeded, provide the values (optional)
+ * exceeded, provide the values (optional)
*/
public function limitationWarn( $limitationType, $current = '', $max = '' ) {
# does no harm if $current and $max are present but are unnecessary for the message
* * To implement hidden categories, hiding pages from category listings
* by storing a property.
*
- * * Overriding the displayed article title.
- * @see ParserOutput::setDisplayTitle()
+ * * Overriding the displayed article title (ParserOutput::setDisplayTitle()).
*
* * To implement image tagging, for example displaying an icon on an
* image thumbnail to indicate that it is listed for deletion on
* @param User $user who's policy we are checking
* @param string $password the password to check
* @return Status error to indicate the password didn't meet the policy, or fatal to
- * indicate the user shouldn't be allowed to login.
+ * indicate the user shouldn't be allowed to login.
*/
public function checkUserPassword( User $user, $password ) {
$effectivePolicy = $this->getPoliciesForUser( $user );
* @param string $password the password to check
* @param array $groups list of groups to which we assume the user belongs
* @return Status error to indicate the password didn't meet the policy, or fatal to
- * indicate the user shouldn't be allowed to login.
+ * indicate the user shouldn't be allowed to login.
*/
public function checkUserPasswordForGroups( User $user, $password, array $groups ) {
$effectivePolicy = self::getPoliciesForGroups(
* Optimize the dependency tree in $this->modules.
*
* The optimization basically works like this:
- * Given we have module A with the dependencies B and C
- * and module B with the dependency C.
- * Now we don't have to tell the client to explicitly fetch module
- * C as that's already included in module B.
+ * Given we have module A with the dependencies B and C
+ * and module B with the dependency C.
+ * Now we don't have to tell the client to explicitly fetch module
+ * C as that's already included in module B.
*
* This way we can reasonably reduce the amount of module registration
* data send to the client.
* @param string $ikm The input keying material
* @param string $salt The salt to add to the ikm, to get the prk
* @param string $info Optional context (change the output without affecting
- * the randomness properties of the output)
+ * the randomness properties of the output)
* @param int $L Number of bytes to return
* @return string Cryptographically secure pseudorandom binary string
*/
/**
* Get an array of language names, indexed by code.
* @param null|string $inLanguage Code of language in which to return the names
- * Use null for autonyms (native names)
+ * Use null for autonyms (native names)
* @param string $include One of:
- * 'all' all available languages
- * 'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
- * 'mwfile' only if the language is in 'mw' *and* has a message file
+ * 'all' all available languages
+ * 'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
+ * 'mwfile' only if the language is in 'mw' *and* has a message file
* @return array Language code => language name
* @since 1.20
*/
* @param int $length Maximum length (including ellipsis)
* @param string $ellipsis String to append to the truncated text
* @param bool $adjustLength Subtract length of ellipsis from $length.
- * $adjustLength was introduced in 1.18, before that behaved as if false.
+ * $adjustLength was introduced in 1.18, before that behaved as if false.
* @return string
*/
function truncate( $string, $length, $ellipsis = '...', $adjustLength = true ) {
* Parse the conversion table stored in the cache.
*
* The tables should be in blocks of the following form:
- * -{
- * word => word ;
- * word => word ;
- * ...
- * }-
+ * -{
+ * word => word ;
+ * word => word ;
+ * ...
+ * }-
*
* To make the tables more manageable, subpages are allowed
* and will be parsed recursively if $recursive == true.
* Word order is irrelevant.
*
* Possible values specifying the grammatical case are:
- * 1, Nominative
- * 2, Genitive
- * 3, Dative
- * 4, Accusative, -omitted-
+ * 1, Nominative
+ * 2, Genitive
+ * 3, Dative
+ * 4, Accusative, -omitted-
*
* Possible values specifying the article type are:
- * Betoont focussed or stressed article
- * -omitted- unstressed or unfocussed article
+ * Betoont focussed or stressed article
+ * -omitted- unstressed or unfocussed article
*
* Possible values for the type of genitive are:
- * Sing, Iehr prepositioned genitive = possessive dative
- * Vun, Fon, -omitted- postpositioned genitive = preposition "vun" with dative
+ * Sing, Iehr prepositioned genitive = possessive dative
+ * Vun, Fon, -omitted- postpositioned genitive = preposition "vun" with dative
*
* Values of case overrides & prepositions, in the order of preceedence:
- * Sing, Iehr possessive dative = prepositioned genitive
- * Vun, Fon preposition "vun" with dative = postpositioned genitive
- * En, em preposition "en" with dative
+ * Sing, Iehr possessive dative = prepositioned genitive
+ * Vun, Fon preposition "vun" with dative = postpositioned genitive
+ * En, em preposition "en" with dative
*
* Values for object gender specifiers of the possessive dative, or
* prepositioned genitive, evaluated with "Sing, Iehr" of above only:
- * Male a singular male object follows
- * -omitted- a non-male or plural object follows
+ * Male a singular male object follows
+ * -omitted- a non-male or plural object follows
*
* We currently handle definite articles of the singular only.
* There is a full set of test cases at:
* @param bool $collect Whether to collect logs. @see setCollect()
* @param callable $filter Filter logs before collecting/printing. Signature is
* string|null function ( string $message, string $level, array $context );
- * @param bool $collectContext Whether to keep the context passed to log.
- * @since 1.29 @see setCollectContext()
+ * @param bool $collectContext Whether to keep the context passed to log
+ * (since 1.29, @see setCollectContext()).
*/
public function __construct( $collect = false, $filter = null, $collectContext = false ) {
$this->collect = $collect;
dépôts / lhc / web / wiklou.git / commitdiff