Fix AbstractBlock param types in documentation
authorThalia <thalia.e.chan@googlemail.com>
Tue, 14 May 2019 12:42:50 +0000 (13:42 +0100)
committerThalia <thalia.e.chan@googlemail.com>
Tue, 14 May 2019 12:42:50 +0000 (13:42 +0100)
Change-Id: I503375485956d3c05da445542419fb62684ae34a

includes/api/ApiBase.php
includes/api/ApiBlockInfoTrait.php
includes/block/BlockManager.php

index 25352f5..7cb2dbf 100644 (file)
@@ -2029,7 +2029,7 @@ abstract class ApiBase extends ContextSource {
         * error handler and die with an error message including block info.
         *
         * @since 1.27
-        * @param Block $block The block used to generate the ApiUsageException
+        * @param AbstractBlock $block The block used to generate the ApiUsageException
         * @throws ApiUsageException always
         */
        public function dieBlocked( AbstractBlock $block ) {
index d16cd21..587a51f 100644 (file)
@@ -28,7 +28,7 @@ trait ApiBlockInfoTrait {
 
        /**
         * Get basic info about a given block
-        * @param Block $block
+        * @param AbstractBlock $block
         * @return array Array containing several keys:
         *  - blockid - ID of the block
         *  - blockedby - username of the blocker
index ba4c569..7b665ae 100644 (file)
@@ -111,7 +111,7 @@ class BlockManager {
         * @param bool $fromReplica Whether to check the replica DB first.
         *  To improve performance, non-critical checks are done against replica DBs.
         *  Check when actually saving should be done against master.
-        * @return Block|null The most relevant block, or null if there is no block.
+        * @return AbstractBlock|null The most relevant block, or null if there is no block.
         */
        public function getUserBlock( User $user, $fromReplica ) {
                $isAnon = $user->getId() === 0;