PHP Interface Xpressengine\User\UserInterface

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: extends Xpressengine\User\Authenticatable, extends Illuminate\Contracts\Auth\CanResetPassword
Show file Open project: xpressengine/xpressengine Interface Usage Examples

Public Methods

Method Description
getAccountByProvider ( string $provider ) : Xpressengine\User\AccountInterface 회원이 소유한 계정 중에 주어진 provider를 가진 계정을 반환한다.
getDisplayName ( ) : string Get the name for display
getGroups ( ) : array Get groups a user belongs
getId ( ) : string Get the unique identifier
getPendingEmail ( ) : Xpressengine\User\EmailInterface Get Pending Email of current user
getProfileImage ( ) : string Get profile image URL of user
getRating ( ) : string Get the rating of user
getStatus ( ) : string Get the status of user
isAdmin ( ) : boolean Finds whether user has super rating.
isManager ( ) : boolean Finds whether user has manager or super rating.
joinGroups ( mixed $groups ) : static add this user to groups
leaveGroups ( array $groups ) : static leave groups

Method Details

getAccountByProvider() public method

회원이 소유한 계정 중에 주어진 provider를 가진 계정을 반환한다.
public getAccountByProvider ( string $provider ) : Xpressengine\User\AccountInterface
$provider string provider
return Xpressengine\User\AccountInterface

getDisplayName() public method

Get the name for display
public getDisplayName ( ) : string
return string

getGroups() public method

Get groups a user belongs
public getGroups ( ) : array
return array

getId() public method

Get the unique identifier
public getId ( ) : string
return string

getPendingEmail() public method

Get Pending Email of current user
public getPendingEmail ( ) : Xpressengine\User\EmailInterface
return Xpressengine\User\EmailInterface

getProfileImage() public method

Get profile image URL of user
public getProfileImage ( ) : string
return string

getRating() public method

Get the rating of user
public getRating ( ) : string
return string

getStatus() public method

Get the status of user
public getStatus ( ) : string
return string

isAdmin() public method

Finds whether user has super rating.
public isAdmin ( ) : boolean
return boolean

isManager() public method

Finds whether user has manager or super rating.
public isManager ( ) : boolean
return boolean

joinGroups() public method

add this user to groups
public joinGroups ( mixed $groups ) : static
$groups mixed groups
return static

leaveGroups() public method

leave groups
public leaveGroups ( array $groups ) : static
$groups array group names
return static