PHP Class Pimcore\Model\User

Inheritance: extends Pimcore\Model\User\UserRole
Afficher le fichier Open project: pimcore/pimcore Class Usage Examples

Méthodes publiques

Свойство 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

Свойство Type Description
$mergedPerspectives null | array
$mergedWebsiteTranslationLanguagesEdit null | array
$mergedWebsiteTranslationLanguagesView null | array

Méthodes publiques

Méthode 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 méthode

public getActive ( ) : boolean
Résultat boolean

getActivePerspective() public méthode

public getActivePerspective ( ) : null | string
Résultat null | string

getAdmin() public méthode

public getAdmin ( ) : boolean
Résultat boolean

getAllowDirtyClose() public méthode

public getAllowDirtyClose ( ) : boolean
Résultat boolean

getAllowedLanguagesForEditingWebsiteTranslations() public méthode

If only edit languages are empty (but view languages not) empty array is returned.

getAllowedLanguagesForViewingWebsiteTranslations() public méthode

Returns array of languages allowed for viewing. If view languages are empty all languages are allowed.

getApiKey() public méthode

public getApiKey ( ) : null | string
Résultat null | string

getCloseWarning() public méthode

public getCloseWarning ( ) : boolean
Résultat boolean

getContentLanguages() public méthode

public getContentLanguages ( ) : null | string
Résultat null | string

getEmail() public méthode

public getEmail ( ) : string
Résultat string

getFirstAllowedPerspective() public méthode

Returns the first perspective name
public getFirstAllowedPerspective ( ) : string
Résultat string

getFirstname() public méthode

public getFirstname ( ) : string
Résultat string

getImage() public méthode

public getImage ( $width = null, $height = null ) : string
Résultat string

getLanguage() public méthode

public getLanguage ( ) : string
Résultat string

getLastname() public méthode

public getLastname ( ) : string
Résultat string

getMemorizeTabs() public méthode

public getMemorizeTabs ( ) : boolean
Résultat boolean

getMergedPerspectives() public méthode

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

getMergedWebsiteTranslationLanguagesEdit() public méthode

Returns array of website translation languages for editing related to user and all related roles

getMergedWebsiteTranslationLanguagesView() public méthode

Returns array of website translation languages for viewing related to user and all related roles

getPassword() public méthode

public getPassword ( ) : string
Résultat string

getPermission() public méthode

public getPermission ( string $permissionName ) : array
$permissionName string
Résultat array

getRoles() public méthode

public getRoles ( ) : array
Résultat array

getUsername() public méthode

Alias for getName()
Deprecation:
public getUsername ( ) : string
Résultat string

getWelcomescreen() public méthode

public getWelcomescreen ( ) : boolean
Résultat boolean

isActive() public méthode

public isActive ( ) : boolean
Résultat boolean

isAdmin() public méthode

See also: getAdmin()
public isAdmin ( ) : boolean
Résultat boolean

isAllowed() public méthode

public isAllowed ( String $key, $type = "permission" ) : boolean
$key String
Résultat boolean

setActive() public méthode

public setActive ( boolean $active ) : void
$active boolean
Résultat void

setActivePerspective() public méthode

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

setAdmin() public méthode

public setAdmin ( boolean $admin ) : void
$admin boolean
Résultat void

setAllowDirtyClose() public méthode

public setAllowDirtyClose ( $allowDirtyClose )
$allowDirtyClose

setApiKey() public méthode

public setApiKey ( $apiKey )
$apiKey

setCloseWarning() public méthode

public setCloseWarning ( $closeWarning )
$closeWarning

setContentLanguages() public méthode

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

setEmail() public méthode

public setEmail ( $email )
$email

setFirstname() public méthode

public setFirstname ( $firstname )
$firstname

setImage() public méthode

public setImage ( $path )
$path

setLanguage() public méthode

public setLanguage ( string $language ) : void
$language string
Résultat void

setLastname() public méthode

public setLastname ( $lastname )
$lastname

setMemorizeTabs() public méthode

public setMemorizeTabs ( $memorizeTabs )
$memorizeTabs

setPassword() public méthode

public setPassword ( string $password )
$password string

setRoles() public méthode

public setRoles ( $roles )
$roles

setUsername() public méthode

public setUsername ( $username )
$username

setWelcomescreen() public méthode

public setWelcomescreen ( $welcomescreen )
$welcomescreen

Property Details

$active public_oe property

public bool $active
Résultat boolean

$activePerspective public_oe property

public string|null $activePerspective
Résultat string | null

$admin public_oe property

public bool $admin
Résultat boolean

$allowDirtyClose public_oe property

public bool $allowDirtyClose
Résultat boolean

$apiKey public_oe property

public string|null $apiKey
Résultat string | null

$closeWarning public_oe property

public bool $closeWarning
Résultat boolean

$contentLanguages public_oe property

public string|null $contentLanguages
Résultat string | null

$email public_oe property

public string $email
Résultat string

$firstname public_oe property

public string $firstname
Résultat string

$language public_oe property

public string $language
Résultat string

$lastname public_oe property

public string $lastname
Résultat string

$memorizeTabs public_oe property

public bool $memorizeTabs
Résultat boolean

$mergedPerspectives protected_oe property

protected null|array $mergedPerspectives
Résultat null | array

$mergedWebsiteTranslationLanguagesEdit protected_oe property

protected null|array $mergedWebsiteTranslationLanguagesEdit
Résultat null | array

$mergedWebsiteTranslationLanguagesView protected_oe property

protected null|array $mergedWebsiteTranslationLanguagesView
Résultat null | array

$password public_oe property

public string $password
Résultat string

$roles public_oe property

public array $roles
Résultat array

$type public_oe property

public string $type
Résultat string

$welcomescreen public_oe property

public bool $welcomescreen
Résultat boolean