PHP Class Xpressengine\User\Models\User

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: extends Xpressengine\Database\Eloquent\DynamicModel, implements Xpressengine\User\UserInterface
Show file Open project: xpressengine/xpressengine Class Usage Examples

Public Properties

Property Type Description
$displayField getDisplayName()메소드가 실행될 때 사용할 필드
$incrementing

Protected Properties

Property Type Description
$connection
$dates
$dynamic use dynamic query
$emailForPasswordReset 비밀번호 초기화 요청을 처리할 때, 입력된 이메일을 저장함
$fillable
$hidden
$profileImageResolver 회원의 프로필 이미지 Resolver. 프로필 이미지 아이디에 해당하는 프로필 이미지 URL을 반환한다.
$table

Public Methods

Method Description
__construct ( array $attributes = [] ) User constructor.
accounts ( ) : Illuminate\Database\Eloquent\Relations\HasMany set relationship with user accounts
emails ( ) : Illuminate\Database\Eloquent\Relations\HasMany set relationship with emails
getAccountByProvider ( string $provider ) : UserAccount 회원이 소유한 계정 중에 주어진 provider를 가진 계정을 반환한다.
getAuthIdentifier ( ) : mixed Get the unique identifier for the user.
getAuthPassword ( ) : string Get the password for the user.
getDisplayName ( ) : string Get the name for display
getEmailForPasswordReset ( ) : string Get the e-mail address where password reset links are sent.
getGroups ( ) : array Get groups a user belongs
getId ( ) : string Get the unique identifier
getPendingEmail ( ) : PendingEmail Get Pending Email of current user
getProfileImage ( ) : string Get profile image URL of user
getRating ( ) : string Get the rating of user
getRememberToken ( ) : string Get the token value for the "remember me" session.
getRememberTokenName ( ) : string Get the column name for the "remember me" token.
getStatus ( ) : string Get the status of user
groups ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany set relationship with user groups
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
pendingEmail ( ) : Illuminate\Database\Eloquent\Relations\HasOne set relationship with pendingEmail
setEmailForPasswordReset ( string $email ) : void setEmailForPasswordReset() 메소드에서 반환할 email 정보를 지정한다.
setProfileImageResolver ( Closure $callback ) : void setProfileImageResolver
setRememberToken ( string $value ) : void Set the token value for the "remember me" session.

Method Details

__construct() public method

User constructor.
public __construct ( array $attributes = [] )
$attributes array attributes

accounts() public method

set relationship with user accounts
public accounts ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

emails() public method

set relationship with emails
public emails ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

getAccountByProvider() public method

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

getAuthIdentifier() public method

Get the unique identifier for the user.
public getAuthIdentifier ( ) : mixed
return mixed

getAuthPassword() public method

Get the password for the user.
public getAuthPassword ( ) : string
return string

getDisplayName() public method

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

getEmailForPasswordReset() public method

Get the e-mail address where password reset links are sent.
public getEmailForPasswordReset ( ) : 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 ( ) : PendingEmail
return PendingEmail

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

getRememberToken() public method

Get the token value for the "remember me" session.
public getRememberToken ( ) : string
return string

getRememberTokenName() public method

Get the column name for the "remember me" token.
public getRememberTokenName ( ) : string
return string

getStatus() public method

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

groups() public method

set relationship with user groups
public groups ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
return Illuminate\Database\Eloquent\Relations\BelongsToMany

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 groups
return static

pendingEmail() public method

set relationship with pendingEmail
public pendingEmail ( ) : Illuminate\Database\Eloquent\Relations\HasOne
return Illuminate\Database\Eloquent\Relations\HasOne

setEmailForPasswordReset() public method

setEmailForPasswordReset() 메소드에서 반환할 email 정보를 지정한다.
public setEmailForPasswordReset ( string $email ) : void
$email string 지정할 email주소
return void

setProfileImageResolver() public static method

setProfileImageResolver
public static setProfileImageResolver ( Closure $callback ) : void
$callback Closure 회원의 프로필 이미지를 처리하기 위한 resolver
return void

setRememberToken() public method

Set the token value for the "remember me" session.
public setRememberToken ( string $value ) : void
$value string value
return void

Property Details

$connection protected property

protected $connection

$dates protected property

protected $dates

$displayField public static property

getDisplayName()메소드가 실행될 때 사용할 필드
public static $displayField

$dynamic protected property

use dynamic query
protected $dynamic

$emailForPasswordReset protected property

비밀번호 초기화 요청을 처리할 때, 입력된 이메일을 저장함
protected $emailForPasswordReset

$fillable protected property

protected $fillable

$hidden protected property

protected $hidden

$incrementing public property

public $incrementing

$profileImageResolver protected static property

회원의 프로필 이미지 Resolver. 프로필 이미지 아이디에 해당하는 프로필 이미지 URL을 반환한다.
protected static $profileImageResolver

$table protected property

protected $table