Merge pull request #9917 from creative-commoners/pulls/4/rememberloginhash-getset

API Methods to override logout_accross_devices
This commit is contained in:
Maxime Rainville 2021-04-20 09:49:36 +12:00 committed by GitHub
commit 37ee3a923f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 51 additions and 1 deletions

View File

@ -84,6 +84,42 @@ class RememberLoginHash extends DataObject
*/ */
private $token = null; private $token = null;
/**
* Used to override the config value of logout_across_devices
* Tri-state where null denotes an unset override value
*
* @internal
* @var bool|null
*/
protected static $logoutAcrossDevices = null;
/**
* @internal
* @return bool
*/
public static function getLogoutAcrossDevices(): bool
{
if (is_bool(static::$logoutAcrossDevices)) {
return static::$logoutAcrossDevices;
}
return static::config()->get('logout_across_devices');
}
/**
* Override the config value of logout_across_devices for the duration of the request
* Useful if an authenticator is causing the wrong number of devices to loose their tokens
* A value of false will prevent all devices from having their token removed when a single device logs out
* A value of true will remove all devices tokens when a single device logs out
* Use this public API instead of modifying the config value directly
*
* @internal
* @param bool $value
*/
public static function setLogoutAcrossDevices(bool $value): void
{
static::$logoutAcrossDevices = $value;
}
public function getToken() public function getToken()
{ {
return $this->token; return $this->token;
@ -181,7 +217,7 @@ class RememberLoginHash extends DataObject
return; return;
} }
if (static::config()->logout_across_devices) { if (static::getLogoutAcrossDevices()) {
self::get()->filter(['MemberID' => $member->ID])->removeAll(); self::get()->filter(['MemberID' => $member->ID])->removeAll();
} elseif ($alcDevice) { } elseif ($alcDevice) {
self::get()->filter([ self::get()->filter([

View File

@ -72,4 +72,18 @@ class RememberLoginHashTest extends SapphireTest
); );
} }
} }
public function testGetSetLogoutAcrossDevices()
{
// set config directly
RememberLoginHash::config()->set('logout_across_devices', true);
$this->assertTrue(RememberLoginHash::getLogoutAcrossDevices());
RememberLoginHash::config()->set('logout_across_devices', false);
$this->assertFalse(RememberLoginHash::getLogoutAcrossDevices());
// override using public API
RememberLoginHash::setLogoutAcrossDevices(true);
$this->assertTrue(RememberLoginHash::getLogoutAcrossDevices());
RememberLoginHash::setLogoutAcrossDevices(false);
$this->assertFalse(RememberLoginHash::getLogoutAcrossDevices());
}
} }