summaryrefslogtreecommitdiffstats
path: root/src/Auth/User.php
blob: 3b368f32f0b9057510b5b5e8d8394e1ee136e962 (plain)
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
<?php

namespace Jasny\Auth;

/**
 * Entity used for authentication
 */
interface User
{
    /**
     * Get user id
     * 
     * @return int|string
     */
    public function getId();
    
    /**
     * Get user's username
     * 
     * @return string
     */
    public function getUsername();
    
    /**
     * Get user's hashed password
     * 
     * @return string
     */
    public function getHashedPassword();
    
    
    /**
     * Event called on login.
     * 
     * @return boolean  false cancels the login
     */
    public function onLogin();
    
    /**
     * Event called on logout.
     * 
     * @return void
     */
    public function onLogout();
}