public $mParentBlockId;
/** @var int */
- protected $mId;
+ private $mId;
/** @var bool */
- protected $mFromMaster;
+ private $mFromMaster;
/** @var bool */
- protected $mBlockEmail;
+ private $mBlockEmail;
/** @var bool */
- protected $mDisableUsertalk;
+ private $mDisableUsertalk;
/** @var bool */
- protected $mCreateAccount;
+ private $mCreateAccount;
/** @var User|string */
- protected $target;
+ private $target;
/** @var int Hack for foreign blocking (CentralAuth) */
- protected $forcedTargetID;
+ private $forcedTargetID;
/** @var int Block::TYPE_ constant. Can only be USER, IP or RANGE internally */
- protected $type;
+ private $type;
/** @var User */
- protected $blocker;
+ private $blocker;
/** @var bool */
- protected $isHardblock;
+ private $isHardblock;
/** @var bool */
- protected $isAutoblocking;
+ private $isAutoblocking;
/** @var string|null */
- protected $systemBlockType;
+ private $systemBlockType;
# TYPE constants
const TYPE_USER = 1;
/**
* Get the system block type, if any
+ * @since 1.29
* @return string|null
*/
public function getSystemBlockType() {
* 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 ) {
/**
* Unset the 'BlockID' cookie.
*
+ * @since 1.29
+ *
* @param WebResponse $response The response on which to unset the cookie.
*/
public static function clearCookie( WebResponse $response ) {
* 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() {
return $id;
}
$hmac = MWCryptHash::hmac( $id, $secretKey, false );
- $cookieValue = $id . '!' . $hmac;
+ $cookieValue = $id . '!' . $hmac;
return $cookieValue;
}
/**
* 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.
+ *
+ * @return int|null The block ID, or null if the HMAC is present and invalid.
*/
public static function getIdFromCookieValue( $cookieValue ) {
// Extract the ID prefix from the cookie value (may be the whole value, if no bang found).