Merge "build: Lower default Karma logLevel during local development"
[lhc/web/wiklou.git] / includes / block / SystemBlock.php
index 029e0b8..494a7b9 100644 (file)
@@ -39,11 +39,11 @@ class SystemBlock extends AbstractBlock {
        /**
         * Create a new block with specified parameters on a user, IP or IP range.
         *
-        * @param array $options Parameters of the block:
-        *     systemBlock string   Indicate that this block is automatically
-        *                          created by MediaWiki rather than being stored
-        *                          in the database. Value is a string to return
-        *                          from self::getSystemBlockType().
+        * @param array $options Parameters of the block, with options supported by
+        *  `AbstractBlock::__construct`, and also:
+        *  - systemBlock: (string) Indicate that this block is automatically created by
+        *    MediaWiki rather than being stored in the database. Value is a string to
+        *    return from self::getSystemBlockType().
         */
        public function __construct( array $options = [] ) {
                parent::__construct( $options );
@@ -76,7 +76,8 @@ class SystemBlock extends AbstractBlock {
         */
        public function getPermissionsError( IContextSource $context ) {
                $params = $this->getBlockErrorParams( $context );
-               // TODO: Clean up error messages params so we don't have to do this
+
+               // TODO: Clean up error messages params so we don't have to do this (T227174)
                $params[ 4 ] = $this->getSystemBlockType();
 
                $msg = 'systemblockedtext';