PHP Class Pimcore\Model\User

Inheritance: extends Pimcore\Model\User\UserRole
Datei anzeigen Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$active boolean
$activePerspective string | null
$admin boolean
$allowDirtyClose boolean
$apiKey string | null
$closeWarning boolean
$contentLanguages string | null
$email string
$firstname string
$language string
$lastname string
$memorizeTabs boolean
$password string
$roles array
$type string
$welcomescreen boolean

Protected Properties

Property Type Description
$mergedPerspectives null | array
$mergedWebsiteTranslationLanguagesEdit null | array
$mergedWebsiteTranslationLanguagesView null | array

Public Methods

Method Description
getActive ( ) : boolean
getActivePerspective ( ) : null | string
getAdmin ( ) : boolean
getAllowDirtyClose ( ) : boolean
getAllowedLanguagesForEditingWebsiteTranslations ( ) : array | null Returns array of languages allowed for editing. If edit and view languages are empty all languages are allowed.
getAllowedLanguagesForViewingWebsiteTranslations ( ) : array | null Returns array of languages allowed for viewing. If view languages are empty all languages are allowed.
getApiKey ( ) : null | string
getCloseWarning ( ) : boolean
getContentLanguages ( ) : null | string
getEmail ( ) : string
getFirstAllowedPerspective ( ) : string Returns the first perspective name
getFirstname ( ) : string
getImage ( $width = null, $height = null ) : string
getLanguage ( ) : string
getLastname ( ) : string
getMemorizeTabs ( ) : boolean
getMergedPerspectives ( ) : array | string[] Returns array of perspectives names related to user and all related roles
getMergedWebsiteTranslationLanguagesEdit ( ) : array | null Returns array of website translation languages for editing related to user and all related roles
getMergedWebsiteTranslationLanguagesView ( ) : array | null Returns array of website translation languages for viewing related to user and all related roles
getPassword ( ) : string
getPermission ( string $permissionName ) : array
getRoles ( ) : array
getUsername ( ) : string Alias for getName()
getWelcomescreen ( ) : boolean
isActive ( ) : boolean
isAdmin ( ) : boolean
isAllowed ( String $key, $type = "permission" ) : boolean
setActive ( boolean $active ) : void
setActivePerspective ( null | string $activePerspective )
setAdmin ( boolean $admin ) : void
setAllowDirtyClose ( $allowDirtyClose )
setApiKey ( $apiKey )
setCloseWarning ( $closeWarning )
setContentLanguages ( null | string $contentLanguages )
setEmail ( $email )
setFirstname ( $firstname )
setImage ( $path )
setLanguage ( string $language ) : void
setLastname ( $lastname )
setMemorizeTabs ( $memorizeTabs )
setPassword ( string $password )
setRoles ( $roles )
setUsername ( $username )
setWelcomescreen ( $welcomescreen )

Method Details

getActive() public method

public getActive ( ) : boolean
return boolean

getActivePerspective() public method

public getActivePerspective ( ) : null | string
return null | string

getAdmin() public method

public getAdmin ( ) : boolean
return boolean

getAllowDirtyClose() public method

public getAllowDirtyClose ( ) : boolean
return boolean

getAllowedLanguagesForEditingWebsiteTranslations() public method

If only edit languages are empty (but view languages not) empty array is returned.
public getAllowedLanguagesForEditingWebsiteTranslations ( ) : array | null
return array | null

getAllowedLanguagesForViewingWebsiteTranslations() public method

Returns array of languages allowed for viewing. If view languages are empty all languages are allowed.
public getAllowedLanguagesForViewingWebsiteTranslations ( ) : array | null
return array | null

getApiKey() public method

public getApiKey ( ) : null | string
return null | string

getCloseWarning() public method

public getCloseWarning ( ) : boolean
return boolean

getContentLanguages() public method

public getContentLanguages ( ) : null | string
return null | string

getEmail() public method

public getEmail ( ) : string
return string

getFirstAllowedPerspective() public method

Returns the first perspective name
public getFirstAllowedPerspective ( ) : string
return string

getFirstname() public method

public getFirstname ( ) : string
return string

getImage() public method

public getImage ( $width = null, $height = null ) : string
return string

getLanguage() public method

public getLanguage ( ) : string
return string

getLastname() public method

public getLastname ( ) : string
return string

getMemorizeTabs() public method

public getMemorizeTabs ( ) : boolean
return boolean

getMergedPerspectives() public method

Returns array of perspectives names related to user and all related roles
public getMergedPerspectives ( ) : array | string[]
return array | string[]

getMergedWebsiteTranslationLanguagesEdit() public method

Returns array of website translation languages for editing related to user and all related roles
public getMergedWebsiteTranslationLanguagesEdit ( ) : array | null
return array | null

getMergedWebsiteTranslationLanguagesView() public method

Returns array of website translation languages for viewing related to user and all related roles
public getMergedWebsiteTranslationLanguagesView ( ) : array | null
return array | null

getPassword() public method

public getPassword ( ) : string
return string

getPermission() public method

public getPermission ( string $permissionName ) : array
$permissionName string
return array

getRoles() public method

public getRoles ( ) : array
return array

getUsername() public method

Alias for getName()
Deprecation:
public getUsername ( ) : string
return string

getWelcomescreen() public method

public getWelcomescreen ( ) : boolean
return boolean

isActive() public method

public isActive ( ) : boolean
return boolean

isAdmin() public method

See also: getAdmin()
public isAdmin ( ) : boolean
return boolean

isAllowed() public method

public isAllowed ( String $key, $type = "permission" ) : boolean
$key String
return boolean

setActive() public method

public setActive ( boolean $active ) : void
$active boolean
return void

setActivePerspective() public method

public setActivePerspective ( null | string $activePerspective )
$activePerspective null | string

setAdmin() public method

public setAdmin ( boolean $admin ) : void
$admin boolean
return void

setAllowDirtyClose() public method

public setAllowDirtyClose ( $allowDirtyClose )
$allowDirtyClose

setApiKey() public method

public setApiKey ( $apiKey )
$apiKey

setCloseWarning() public method

public setCloseWarning ( $closeWarning )
$closeWarning

setContentLanguages() public method

public setContentLanguages ( null | string $contentLanguages )
$contentLanguages null | string

setEmail() public method

public setEmail ( $email )
$email

setFirstname() public method

public setFirstname ( $firstname )
$firstname

setImage() public method

public setImage ( $path )
$path

setLanguage() public method

public setLanguage ( string $language ) : void
$language string
return void

setLastname() public method

public setLastname ( $lastname )
$lastname

setMemorizeTabs() public method

public setMemorizeTabs ( $memorizeTabs )
$memorizeTabs

setPassword() public method

public setPassword ( string $password )
$password string

setRoles() public method

public setRoles ( $roles )
$roles

setUsername() public method

public setUsername ( $username )
$username

setWelcomescreen() public method

public setWelcomescreen ( $welcomescreen )
$welcomescreen

Property Details

$active public_oe property

public bool $active
return boolean

$activePerspective public_oe property

public string|null $activePerspective
return string | null

$admin public_oe property

public bool $admin
return boolean

$allowDirtyClose public_oe property

public bool $allowDirtyClose
return boolean

$apiKey public_oe property

public string|null $apiKey
return string | null

$closeWarning public_oe property

public bool $closeWarning
return boolean

$contentLanguages public_oe property

public string|null $contentLanguages
return string | null

$email public_oe property

public string $email
return string

$firstname public_oe property

public string $firstname
return string

$language public_oe property

public string $language
return string

$lastname public_oe property

public string $lastname
return string

$memorizeTabs public_oe property

public bool $memorizeTabs
return boolean

$mergedPerspectives protected_oe property

protected null|array $mergedPerspectives
return null | array

$mergedWebsiteTranslationLanguagesEdit protected_oe property

protected null|array $mergedWebsiteTranslationLanguagesEdit
return null | array

$mergedWebsiteTranslationLanguagesView protected_oe property

protected null|array $mergedWebsiteTranslationLanguagesView
return null | array

$password public_oe property

public string $password
return string

$roles public_oe property

public array $roles
return array

$type public_oe property

public string $type
return string

$welcomescreen public_oe property

public bool $welcomescreen
return boolean