Skip to content

feat: add Database::deleteUserSessions and Database::deleteAnonymousSessions #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rancoud merged 2 commits into from
Mar 28, 2026
+198 −52
Merged

feat: add Database::deleteUserSessions and Database::deleteAnonymousSessions #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d95594
feat: add Database::deleteUserSessions
rancoud Mar 26, 2026
b52cfa6
update README + add deleteAnonymousSessions
rancoud Mar 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 54 additions & 52 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ composer require rancoud/session
By default session is in read only (option read_and_close = 1).
You can specify it using `Session::setReadWrite()` or `Session::setReadOnly()`

Session::start() is not needed, but:
Session::start() is not needed, but:
* Session will automatically start in read only when using `get, has, hasKeyAndValue, getAll`
* Session will automatically start in write mode when using `set, remove, getAndRemove, keepFlash, gc, regenerate`

Expand Down Expand Up @@ -98,86 +98,88 @@ $value = Session::get('key');
```

## Session
### Static General Commands
* start([options: array = []]): void
* regenerate(): bool
* destroy(): bool
* commit(): void
* rollback(): bool
* unsaved(): bool
* hasStarted(): bool
* getId(): string
* setId(id: string): string
* gc(): void
* setReadOnly(): void
* setReadWrite(): void
### Static General Commands
* start([options: array = []]): void
* regenerate(): bool
* destroy(): bool
* commit(): void
* rollback(): bool
* unsaved(): bool
* hasStarted(): bool
* getId(): string
* setId(id: string): string
* gc(): void
* setReadOnly(): void
* setReadWrite(): void
* isReadOnly(): bool

### Static Variables $_SESSION access
* set(key: string, value: mixed): void
* get(key: string): mixed
* getAll(): array
* getAndRemove(key: string): mixed
* has(key: string): bool
* hasKeyAndValue(key: string, value: mixed): bool
* remove(key: string): void
* set(key: string, value: mixed): void
* get(key: string): mixed
* getAll(): array
* getAndRemove(key: string): mixed
* has(key: string): bool
* hasKeyAndValue(key: string, value: mixed): bool
* remove(key: string): void

### Static Variables flash access
Flash data are store in a separate variable.
They will dissapear at the end of the script execution or after `commit()` `unsaved()`.
You can use keepFlash for saving it in $_SESSION.
When flash data is restore, it will be delete in $_SESSION.
When flash data is restore, it will be delete in $_SESSION.

* setFlash(key: string, value: mixed): void
* getFlash(key: string): mixed
* getAllFlash(): array
* hasFlash(key: string): bool
* hasFlashKeyAndValue(key: string, value: mixed): bool
* keepFlash([keys: array = []]): void
* setFlash(key: string, value: mixed): void
* getFlash(key: string): mixed
* getAllFlash(): array
* hasFlash(key: string): bool
* hasFlashKeyAndValue(key: string, value: mixed): bool
* keepFlash([keys: array = []]): void

### Static Options
* setOption(key: string, value): void
* setOptions(options: array): void
* getOption(key: string): mixed
### Static Options
* setOption(key: string, value): void
* setOptions(options: array): void
* getOption(key: string): mixed

### Static Driver
* getDriver(): \SessionHandlerInterface
* getDriver(): \SessionHandlerInterface

#### Static PHP Session Default Driver
* useDefaultDriver(): void
* useDefaultEncryptionDriver(key: string, [method: string|null = null]): void
* setLengthSessionID(length: int): void
* getLengthSessionID(): int
* useDefaultDriver(): void
* useDefaultEncryptionDriver(key: string, [method: string|null = null]): void
* setLengthSessionID(length: int): void
* getLengthSessionID(): int

#### Static File Driver
* useFileDriver(): void
* useFileEncryptionDriver(key: string, [method: string|null = null]): void
* setPrefixForFile(prefix: string): void
* useFileDriver(): void
* useFileEncryptionDriver(key: string, [method: string|null = null]): void
* setPrefixForFile(prefix: string): void
* setLengthSessionID(length: int): void
* getLengthSessionID(): int

#### Static Database Driver
* useNewDatabaseDriver(configuration: \Rancoud\Database\Configurator|array): void
* useCurrentDatabaseDriver(databaseInstance: \Rancoud\Database\Database): void
* useNewDatabaseEncryptionDriver(configuration: \Rancoud\Database\Configurator|array, key: string, [method: string = null]): void
* useCurrentDatabaseEncryptionDriver(databaseInstance: \Rancoud\Database\Database, key: string, [method: string = null]): void
* setUserIdForDatabase(userId: int): void
* useNewDatabaseDriver(configuration: \Rancoud\Database\Configurator|array): void
* useCurrentDatabaseDriver(databaseInstance: \Rancoud\Database\Database): void
* useNewDatabaseEncryptionDriver(configuration: \Rancoud\Database\Configurator|array, key: string, [method: string = null]): void
* useCurrentDatabaseEncryptionDriver(databaseInstance: \Rancoud\Database\Database, key: string, [method: string = null]): void
* setUserIdForDatabase(userId: int): void
* setLengthSessionID(length: int): void
* getLengthSessionID(): int
* deleteUserSessions(int $userID): void
* deleteAnonymousSessions(): int

#### Static Redis Driver
* useNewRedisDriver(configuration: array|string): void
* useCurrentRedisDriver(redisInstance: \Predis\Client): void
* useNewRedisEncryptionDriver(configuration: array|string, key: string, [method: string = null]): void
* useCurrentRedisEncryptionDriver(redisInstance: \Predis\Client, key: string, [method: string = null]): void
* useNewRedisDriver(configuration: array|string): void
* useCurrentRedisDriver(redisInstance: \Predis\Client): void
* useNewRedisEncryptionDriver(configuration: array|string, key: string, [method: string = null]): void
* useCurrentRedisEncryptionDriver(redisInstance: \Predis\Client, key: string, [method: string = null]): void
* setLengthSessionID(length: int): void
* getLengthSessionID(): int
* getLengthSessionID(): int

#### Static Custom Driver
* useCustomDriver(customDriver: \SessionHandlerInterface): void
* useCustomDriver(customDriver: \SessionHandlerInterface): void

## Session options
List of session options you can change:
List of session options you can change:
* save_path
* name
* save_handler
Expand Down
23 changes: 23 additions & 0 deletions src/Database.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,29 @@ public function getLengthSessionID(): int
return $this->lengthSessionID;
}

/** @throws SessionException */
public function deleteUserSessions(int $userID): void
{
try {
$sql = 'DELETE FROM sessions WHERE id_user = :id_user';
$params = ['id_user' => $userID];
$this->db->delete($sql, $params);
} catch (DatabaseException $e) {
throw new SessionException('could not delete sessions: ' . $e->getMessage(), $e->getCode(), $e->getPrevious());
}
}

/** @throws SessionException */
public function deleteAnonymousSessions(): void
{
try {
$sql = 'DELETE FROM sessions WHERE id_user IS NULL';
$this->db->delete($sql);
} catch (DatabaseException $e) {
throw new SessionException('could not delete sessions: ' . $e->getMessage(), $e->getCode(), $e->getPrevious());
}
}

public function open(string $path, string $name): bool
{
return true;
Expand Down
121 changes: 121 additions & 0 deletions tests/DatabaseTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,4 +450,125 @@ public function testLengthSessionIDSessionException(): void
$database = new Database();
$database->setLengthSessionID(1);
}

/**
* @throws DatabaseException
* @throws SessionException
*/
public function testDeleteUserSessions(): void
{
$database = new Database();
$database->setCurrentDatabase(static::$db);

$data = 'azerty';

$database->setUserId(10);

static::assertTrue($database->write('session_id_10', $data));
static::assertTrue($database->write('session_id_20', $data));
static::assertTrue($database->write('session_id_30', $data));

$database->setUserId(20);

static::assertTrue($database->write('session_id_40', $data));
static::assertTrue($database->write('session_id_50', $data));
static::assertTrue($database->write('session_id_60', $data));

$sql = 'SELECT id FROM sessions WHERE id_user = :id_user';
$params = ['id_user' => 10];
$sessionsFromDatabase = static::$db->selectCol($sql, $params);
static::assertSame(['session_id_10', 'session_id_20', 'session_id_30'], $sessionsFromDatabase);

$sql = 'SELECT id FROM sessions WHERE id_user = :id_user';
$params = ['id_user' => 20];
$sessionsFromDatabase = static::$db->selectCol($sql, $params);
static::assertSame(['session_id_40', 'session_id_50', 'session_id_60'], $sessionsFromDatabase);

$database->deleteUserSessions(10);

$sql = 'SELECT id FROM sessions';
$sessionsFromDatabase = static::$db->selectCol($sql);
static::assertSame(['session_id_40', 'session_id_50', 'session_id_60'], $sessionsFromDatabase);
}

/**
* @throws DatabaseException
* @throws SessionException
*/
public function testDeleteUserSessionsSessionException(): void
{
$this->expectException(SessionException::class);
$this->expectExceptionMessage('could not delete sessions: Error Connecting Database');

$database = new Database();
$database->setNewDatabase([
'driver' => 'mysql',
'host' => 'mariadb',
'user' => 'invalid',
'password' => '',
'database' => 'test_database'
]);

$database->deleteUserSessions(1);
}

/**
* @throws DatabaseException
* @throws SessionException
*/
public function testDeleteAnonymousSessions(): void
{
$database = new Database();
$database->setCurrentDatabase(static::$db);

$data = 'azerty';

$database->setUserId(10);

static::assertTrue($database->write('session_id_10', $data));
static::assertTrue($database->write('session_id_20', $data));
static::assertTrue($database->write('session_id_30', $data));

$database->setUserId(null);

static::assertTrue($database->write('session_id_40', $data));
static::assertTrue($database->write('session_id_50', $data));
static::assertTrue($database->write('session_id_60', $data));

$sql = 'SELECT id FROM sessions WHERE id_user = :id_user';
$params = ['id_user' => 10];
$sessionsFromDatabase = static::$db->selectCol($sql, $params);
static::assertSame(['session_id_10', 'session_id_20', 'session_id_30'], $sessionsFromDatabase);

$sql = 'SELECT id FROM sessions WHERE id_user IS NULL';
$sessionsFromDatabase = static::$db->selectCol($sql);
static::assertSame(['session_id_40', 'session_id_50', 'session_id_60'], $sessionsFromDatabase);

$database->deleteAnonymousSessions(10);

$sql = 'SELECT id FROM sessions';
$sessionsFromDatabase = static::$db->selectCol($sql);
static::assertSame(['session_id_10', 'session_id_20', 'session_id_30'], $sessionsFromDatabase);
}

/**
* @throws DatabaseException
* @throws SessionException
*/
public function testDeleteAnonymousSessionsSessionException(): void
{
$this->expectException(SessionException::class);
$this->expectExceptionMessage('could not delete sessions: Error Connecting Database');

$database = new Database();
$database->setNewDatabase([
'driver' => 'mysql',
'host' => 'mariadb',
'user' => 'invalid',
'password' => '',
'database' => 'test_database'
]);

$database->deleteAnonymousSessions();
}
}
Loading