User/UserDataInterface.php at master · CommonApi/User · GitHub

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
54
55
56
57
58
59
60
61
62
63
64
65
66
<?php
/**
 * User Data Interface
 *
 * @package    User
 * @copyright  2014 Amy Stephen. All rights reserved.
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 */
namespace CommonApi\User;

/**
 * User Data Interface
 *
 * @package    User
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright  2014 Amy Stephen. All rights reserved.
 * @since      1.0
 */
interface UserDataInterface
{
    /**
     * Set User Data for id, username, email or Initialise User
     *
     * @param   null|string $key
     * @param   null|string $value
     *
     * @return  $this
     */
    public function load($key = 'username', $value = null);

    /**
     * Create User
     *
     * @param   array $data
     *
     * @return  $this
     * @since   1.0.0
     */
    public function createUser(array $data = array());

    /**
     * Return data for current user
     *
     * @return  object
     * @since   1.0.0
     */
    public function readUser();

    /**
     * Update Current User
     *
     * @param   array  $data
     *
     * @return  $this
     * @since   1.0.0
     */
    public function updateUser(array $data = array());

    /**
     * Delete Current User
     *
     * @return  object
     * @since   1.0.0
     */
    public function deleteUser();
}