/
StorageInterface.php
53 lines (49 loc) · 1.32 KB
/
StorageInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Auth\Storage;
/**
* Describes the methods that any class representing an Auth data storage should
* comply with.
*/
interface StorageInterface
{
/**
* Read user record.
*
* @return array|null
*/
public function read();
/**
* Write user record.
*
* @param array|\ArrayAccess $user User record.
* @return void
*/
public function write($user);
/**
* Delete user record.
*
* @return void
*/
public function delete();
/**
* Get/set redirect URL.
*
* @param mixed $url Redirect URL. If `null` returns current URL. If `false`
* deletes currently set URL.
* @return mixed
*/
public function redirectUrl($url = null);
}