pm_Session
in package
Representation of panel session
Tags
Table of Contents
- getClient() : pm_Client
- Retrieve panel client for current session
- getCurrentDomain() : pm_Domain
- Retrieve domain which context is current
- getCurrentDomains() : array<string|int, pm_Domain>
- Retrieve domains that are in current context of Power User view
- getImpersonatedClientId() : null|int
- Retrieve id of admin/reseller which impersonated into a client
- isExist() : bool
- Check if session is initialized or not
- isImpersonated() : bool
- Check if admin/reseller is impersonated into client in hosting panel
Methods
getClient()
Retrieve panel client for current session
public
static getClient() : pm_Client
Return values
pm_Client —getCurrentDomain()
Retrieve domain which context is current
public
static getCurrentDomain() : pm_Domain
Tags
Return values
pm_Domain —getCurrentDomains()
Retrieve domains that are in current context of Power User view
public
static getCurrentDomains([bool $mainDomainsOnly = false ]) : array<string|int, pm_Domain>
Parameters
- $mainDomainsOnly : bool = false
-
[optional] Return only main domains. Default is false.
Tags
Return values
array<string|int, pm_Domain> —getImpersonatedClientId()
Retrieve id of admin/reseller which impersonated into a client
public
static getImpersonatedClientId() : null|int
Return values
null|int —isExist()
Check if session is initialized or not
public
static isExist() : bool
Tags
Return values
bool —isImpersonated()
Check if admin/reseller is impersonated into client in hosting panel
public
static isImpersonated() : bool