User
Table of Contents
Methods
- formatName() : mixed
- getCurrentUserId() : int
- Returns current user ID
- getUserNameFormat() : mixed
- isAdmin() : bool
- Check if a user with a given id is admin
- isCollaber() : bool
- isExternalUser() : bool
- isSuper() : mixed
Methods
formatName()
public
static formatName(mixed $data[, mixed $siteId = false ][, mixed $format = null ]) : mixed
Parameters
- $data : mixed
- $siteId : mixed = false
- $format : mixed = null
getCurrentUserId()
Returns current user ID
public
static getCurrentUserId() : int
Return values
intgetUserNameFormat()
public
static getUserNameFormat([mixed $siteId = '' ]) : mixed
Parameters
- $siteId : mixed = ''
isAdmin()
Check if a user with a given id is admin
public
static isAdmin([0 $userId = 0 ]) : bool
Parameters
- $userId : 0 = 0
Return values
boolisCollaber()
public
static isCollaber(int $userId) : bool
Parameters
- $userId : int
Return values
boolisExternalUser()
public
static isExternalUser(mixed $userID) : bool
Parameters
- $userID : mixed
Return values
boolisSuper()
public
static isSuper([mixed $userId = 0 ]) : mixed
Parameters
- $userId : mixed = 0