Extensions API Documentation - Plesk 17.5
\

\pm_Session

Representation of panel session

Summary

Methods
Properties
Constants
isExist()
getClient()
isImpersonated()
getImpersonatedClientId()
getCurrentDomain()
getCurrentDomains()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A

Methods

isExist()

isExist() : boolean

Check if session is initialized or not

Returns

boolean

getClient()

getClient() : \pm_Client

Retrieve panel client for current session

Returns

\pm_Client

isImpersonated()

isImpersonated() : boolean

Check if admin/reseller is impersonated into client in hosting panel

Returns

boolean

getImpersonatedClientId()

getImpersonatedClientId() : integer

Retrieve id of client in which admin/reseller is impersonated into

Returns

integer

getCurrentDomain()

getCurrentDomain() : \pm_Domain

Retrieve domain which context is current

Returns

\pm_Domain

getCurrentDomains()

getCurrentDomains(boolean  $mainDomainsOnly = false) : array<mixed,\pm_Domain>

Retrieve domains that are in current context of Power User view

Parameters

boolean $mainDomainsOnly

[optional] Return only main domains. Default is false.

Returns

array<mixed,\pm_Domain>