| 1 |
<?php |
| 2 |
// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure. |
| 3 |
|
| 4 |
namespace Yoast\WP\SEO\MyYoast_Client\Application\Ports; |
| 5 |
|
| 6 |
use Yoast\WP\SEO\MyYoast_Client\Application\Exceptions\Token_Storage_Exception; |
| 7 |
use Yoast\WP\SEO\MyYoast_Client\Domain\Token_Set; |
| 8 |
|
| 9 |
/** |
| 10 |
* Port for per-user token persistence. |
| 11 |
*/ |
| 12 |
interface User_Token_Storage_Interface { |
| 13 |
|
| 14 |
/** |
| 15 |
* Retrieves the stored token set for a user. |
| 16 |
* |
| 17 |
* @param int $user_id The user ID. |
| 18 |
* |
| 19 |
* @return Token_Set|null The token set, or null if not stored. |
| 20 |
*/ |
| 21 |
public function get( int $user_id ): ?Token_Set; |
| 22 |
|
| 23 |
/** |
| 24 |
* Stores a token set for a user. |
| 25 |
* |
| 26 |
* @param int $user_id The user ID. |
| 27 |
* @param Token_Set $token_set The token set to store. |
| 28 |
* |
| 29 |
* @return void |
| 30 |
* |
| 31 |
* @throws Token_Storage_Exception If storage fails. |
| 32 |
*/ |
| 33 |
public function store( int $user_id, Token_Set $token_set ): void; |
| 34 |
|
| 35 |
/** |
| 36 |
* Deletes the stored token set for a user. |
| 37 |
* |
| 38 |
* @param int $user_id The user ID. |
| 39 |
* |
| 40 |
* @return void |
| 41 |
*/ |
| 42 |
public function delete( int $user_id ): void; |
| 43 |
|
| 44 |
/** |
| 45 |
* Deletes all stored user token sets. |
| 46 |
* |
| 47 |
* @return void |
| 48 |
*/ |
| 49 |
public function delete_all(): void; |
| 50 |
} |
| 51 |
|
