PHP Класс Pimcore\Model\User

Наследование: extends Pimcore\Model\User\UserRole
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$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)

Свойство Тип Описание
$mergedPerspectives null | array
$mergedWebsiteTranslationLanguagesEdit null | array
$mergedWebsiteTranslationLanguagesView null | array

Открытые методы

Метод Описание
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 )

Описание методов

getActive() публичный Метод

public getActive ( ) : boolean
Результат boolean

getActivePerspective() публичный Метод

public getActivePerspective ( ) : null | string
Результат null | string

getAdmin() публичный Метод

public getAdmin ( ) : boolean
Результат boolean

getAllowDirtyClose() публичный Метод

public getAllowDirtyClose ( ) : boolean
Результат boolean

getAllowedLanguagesForEditingWebsiteTranslations() публичный Метод

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

getAllowedLanguagesForViewingWebsiteTranslations() публичный Метод

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

getApiKey() публичный Метод

public getApiKey ( ) : null | string
Результат null | string

getCloseWarning() публичный Метод

public getCloseWarning ( ) : boolean
Результат boolean

getContentLanguages() публичный Метод

public getContentLanguages ( ) : null | string
Результат null | string

getEmail() публичный Метод

public getEmail ( ) : string
Результат string

getFirstAllowedPerspective() публичный Метод

Returns the first perspective name
public getFirstAllowedPerspective ( ) : string
Результат string

getFirstname() публичный Метод

public getFirstname ( ) : string
Результат string

getImage() публичный Метод

public getImage ( $width = null, $height = null ) : string
Результат string

getLanguage() публичный Метод

public getLanguage ( ) : string
Результат string

getLastname() публичный Метод

public getLastname ( ) : string
Результат string

getMemorizeTabs() публичный Метод

public getMemorizeTabs ( ) : boolean
Результат boolean

getMergedPerspectives() публичный Метод

Returns array of perspectives names related to user and all related roles
public getMergedPerspectives ( ) : array | string[]
Результат array | string[]

getMergedWebsiteTranslationLanguagesEdit() публичный Метод

Returns array of website translation languages for editing related to user and all related roles
public getMergedWebsiteTranslationLanguagesEdit ( ) : array | null
Результат array | null

getMergedWebsiteTranslationLanguagesView() публичный Метод

Returns array of website translation languages for viewing related to user and all related roles
public getMergedWebsiteTranslationLanguagesView ( ) : array | null
Результат array | null

getPassword() публичный Метод

public getPassword ( ) : string
Результат string

getPermission() публичный Метод

public getPermission ( string $permissionName ) : array
$permissionName string
Результат array

getRoles() публичный Метод

public getRoles ( ) : array
Результат array

getUsername() публичный Метод

Alias for getName()
Устаревший:
public getUsername ( ) : string
Результат string

getWelcomescreen() публичный Метод

public getWelcomescreen ( ) : boolean
Результат boolean

isActive() публичный Метод

public isActive ( ) : boolean
Результат boolean

isAdmin() публичный Метод

См. также: getAdmin()
public isAdmin ( ) : boolean
Результат boolean

isAllowed() публичный Метод

public isAllowed ( String $key, $type = "permission" ) : boolean
$key String
Результат boolean

setActive() публичный Метод

public setActive ( boolean $active ) : void
$active boolean
Результат void

setActivePerspective() публичный Метод

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

setAdmin() публичный Метод

public setAdmin ( boolean $admin ) : void
$admin boolean
Результат void

setAllowDirtyClose() публичный Метод

public setAllowDirtyClose ( $allowDirtyClose )
$allowDirtyClose

setApiKey() публичный Метод

public setApiKey ( $apiKey )
$apiKey

setCloseWarning() публичный Метод

public setCloseWarning ( $closeWarning )
$closeWarning

setContentLanguages() публичный Метод

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

setEmail() публичный Метод

public setEmail ( $email )
$email

setFirstname() публичный Метод

public setFirstname ( $firstname )
$firstname

setImage() публичный Метод

public setImage ( $path )
$path

setLanguage() публичный Метод

public setLanguage ( string $language ) : void
$language string
Результат void

setLastname() публичный Метод

public setLastname ( $lastname )
$lastname

setMemorizeTabs() публичный Метод

public setMemorizeTabs ( $memorizeTabs )
$memorizeTabs

setPassword() публичный Метод

public setPassword ( string $password )
$password string

setRoles() публичный Метод

public setRoles ( $roles )
$roles

setUsername() публичный Метод

public setUsername ( $username )
$username

setWelcomescreen() публичный Метод

public setWelcomescreen ( $welcomescreen )
$welcomescreen

Описание свойств

$active публичное свойство

public bool $active
Результат boolean

$activePerspective публичное свойство

public string|null $activePerspective
Результат string | null

$admin публичное свойство

public bool $admin
Результат boolean

$allowDirtyClose публичное свойство

public bool $allowDirtyClose
Результат boolean

$apiKey публичное свойство

public string|null $apiKey
Результат string | null

$closeWarning публичное свойство

public bool $closeWarning
Результат boolean

$contentLanguages публичное свойство

public string|null $contentLanguages
Результат string | null

$email публичное свойство

public string $email
Результат string

$firstname публичное свойство

public string $firstname
Результат string

$language публичное свойство

public string $language
Результат string

$lastname публичное свойство

public string $lastname
Результат string

$memorizeTabs публичное свойство

public bool $memorizeTabs
Результат boolean

$mergedPerspectives защищенное свойство

protected null|array $mergedPerspectives
Результат null | array

$mergedWebsiteTranslationLanguagesEdit защищенное свойство

protected null|array $mergedWebsiteTranslationLanguagesEdit
Результат null | array

$mergedWebsiteTranslationLanguagesView защищенное свойство

protected null|array $mergedWebsiteTranslationLanguagesView
Результат null | array

$password публичное свойство

public string $password
Результат string

$roles публичное свойство

public array $roles
Результат array

$type публичное свойство

public string $type
Результат string

$welcomescreen публичное свойство

public bool $welcomescreen
Результат boolean