From: addshore Date: Fri, 4 Aug 2017 14:51:21 +0000 (+0100) Subject: Various Block.php @since tags X-Git-Tag: 1.31.0-rc.0~2468 X-Git-Url: http://git.cyclocoop.org/%40spipnet%40?a=commitdiff_plain;h=38c00b2e0662ee13e360283784f38d02b3273860;p=lhc%2Fweb%2Fwiklou.git Various Block.php @since tags Followup to: I697e3eec2520792e98c193200c2b1c28c35bf382 Change-Id: I25a72f5f27023ec66939f1cd68fdd606658eac27 --- diff --git a/includes/Block.php b/includes/Block.php index 2a04879848..2ca56a5a90 100644 --- a/includes/Block.php +++ b/includes/Block.php @@ -958,6 +958,7 @@ class Block { /** * Get the system block type, if any + * @since 1.29 * @return string|null */ public function getSystemBlockType() { @@ -1450,6 +1451,8 @@ class Block { * Set the 'BlockID' cookie to this block's ID and expiry time. The cookie's expiry will be * the same as the block's, to a maximum of 24 hours. * + * @since 1.29 + * * @param WebResponse $response The response on which to set the cookie. */ public function setCookie( WebResponse $response ) { @@ -1472,6 +1475,8 @@ class Block { /** * Unset the 'BlockID' cookie. * + * @since 1.29 + * * @param WebResponse $response The response on which to unset the cookie. */ public static function clearCookie( WebResponse $response ) { @@ -1482,6 +1487,9 @@ class Block { * Get the BlockID cookie's value for this block. This is usually the block ID concatenated * with an HMAC in order to avoid spoofing (T152951), but if wgSecretKey is not set will just * be the block ID. + * + * @since 1.29 + * * @return string The block ID, probably concatenated with "!" and the HMAC. */ public function getCookieValue() { @@ -1500,7 +1508,11 @@ class Block { /** * Get the stored ID from the 'BlockID' cookie. The cookie's value is usually a combination of * the ID and a HMAC (see Block::setCookie), but will sometimes only be the ID. + * + * @since 1.29 + * * @param string $cookieValue The string in which to find the ID. + * * @return integer|null The block ID, or null if the HMAC is present and invalid. */ public static function getIdFromCookieValue( $cookieValue ) {