User/RegistrationInterface.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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?php
/**
 * Registration Interface
 *
 * @package    User
 * @copyright  2014-2015 Amy Stephen. All rights reserved.
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 */
namespace CommonApi\User;

/**
 * Registration Interface
 *
 * @package    User
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright  2014-2015 Amy Stephen. All rights reserved.
 * @since      1.0
 */
interface RegistrationInterface
{
    /**
     * Register User and email activation code
     *
     * @param   array $options
     *
     * @return  $this
     * @since   1.0.0
     */
    public function register($options);

    /**
     * Determine if this user is registered
     *
     * @return  boolean
     * @since   1.0.0
     */
    public function isRegistered();

    /**
     * Activate Registration using Activation Code
     *
     * @param   array $options
     *
     * @return  $this
     * @since   1.0.0
     */
    public function activateRegistration($options);

    /**
     * Determine if this user registration has been activated
     *
     * @return  boolean
     * @since   1.0.0
     */
    public function isActivated();

    /**
     * Deactivate Registration
     *
     * @param   array $options
     *
     * @return  $this
     * @since   1.0.0
     */
    public function deactivateRegistration($options = array());

    /**
     * Suspend User
     *
     * @param   array $options
     *
     * @return  $this
     * @since   1.0.0
     */
    public function suspendUser($options);

    /**
     * Determine if this user was suspended
     *
     * @return  $this
     * @since   1.0.0
     */
    public function isSuspended();

    /**
     * Remove Suspension on this User
     *
     * @param   array $options
     *
     * @return  $this
     * @since   1.0.0
     */
    public function removeSuspension($options);
}