pm_DomainAlias
in package
Domain alias wrapper
Tags
Table of Contents
- __construct() : mixed
- Create new domain alias wrapper
- deleteSettings() : void
- Delete all domain alias custom settings
- getByDomain() : array<string|int, pm_DomainAlias>
- Retrieve domain aliases for the specified domain
- getByDomainAliasId() : pm_DomainAlias
- Retrieve domain alias by known id
- getByName() : pm_DomainAlias
- Retrieve domain alias by display name
- getDisplayName() : string
- Retrieves domain name as it is displayed in UI
- getDnsZone() : pm_Dns_Zone
- Return DNS zone of domain alias
- getDomain() : pm_Domain
- Retrieve primary domain of domain alias
- getId() : int
- Retrieve domain alias ID.
- getName() : string
- Retrieves domain alias name in ASCII format
- getProperty() : mixed
- Retrieve property of domain alias
- getSetting() : string|null
- Return value of domain alias custom setting by given name
- hasSeoRedirect() : bool
- Shows whether 301 redirect to HTTPS is enabled on the domain alias
- hasServiceDns() : bool
- Shows whether DNS service is enabled on the domain alias
- hasServiceMail() : bool
- Shows whether mail service is enabled on the domain alias
- hasServiceWeb() : bool
- Shows whether web hosting is enabled on the domain alias
- setSetting() : void
- Define value of domain alias custom setting
Methods
__construct()
Create new domain alias wrapper
public
__construct(int $domainAliasId) : mixed
Parameters
- $domainAliasId : int
Tags
Return values
mixed —deleteSettings()
Delete all domain alias custom settings
public
deleteSettings([string $prefix = '' ]) : void
Parameters
- $prefix : string = ''
-
Settings name prefix
Tags
Return values
void —getByDomain()
Retrieve domain aliases for the specified domain
public
static getByDomain(pm_Domain $domain) : array<string|int, pm_DomainAlias>
Parameters
- $domain : pm_Domain
Tags
Return values
array<string|int, pm_DomainAlias> —getByDomainAliasId()
Retrieve domain alias by known id
public
static getByDomainAliasId(int $domainAliasId) : pm_DomainAlias
Parameters
- $domainAliasId : int
Tags
Return values
pm_DomainAlias —getByName()
Retrieve domain alias by display name
public
static getByName(string $domainAliasName) : pm_DomainAlias
Parameters
- $domainAliasName : string
Tags
Return values
pm_DomainAlias —getDisplayName()
Retrieves domain name as it is displayed in UI
public
getDisplayName() : string
Tags
Return values
string —getDnsZone()
Return DNS zone of domain alias
public
getDnsZone() : pm_Dns_Zone
Tags
Return values
pm_Dns_Zone —getDomain()
Retrieve primary domain of domain alias
public
getDomain() : pm_Domain
Tags
Return values
pm_Domain —getId()
Retrieve domain alias ID.
public
getId() : int
Return values
int —getName()
Retrieves domain alias name in ASCII format
public
getName() : string
Tags
Return values
string —getProperty()
Retrieve property of domain alias
public
getProperty(string $name) : mixed
Parameters
- $name : string
Tags
Return values
mixed —getSetting()
Return value of domain alias custom setting by given name
public
getSetting(string $name[, string|null $default = null ]) : string|null
Parameters
- $name : string
-
Setting name
- $default : string|null = null
-
Default value of setting
Tags
Return values
string|null —hasSeoRedirect()
Shows whether 301 redirect to HTTPS is enabled on the domain alias
public
hasSeoRedirect() : bool
Tags
Return values
bool —hasServiceDns()
Shows whether DNS service is enabled on the domain alias
public
hasServiceDns() : bool
Tags
Return values
bool —hasServiceMail()
Shows whether mail service is enabled on the domain alias
public
hasServiceMail() : bool
Tags
Return values
bool —hasServiceWeb()
Shows whether web hosting is enabled on the domain alias
public
hasServiceWeb() : bool
Tags
Return values
bool —setSetting()
Define value of domain alias custom setting
public
setSetting(string $name, string|null $value) : void
Parameters
- $name : string
-
Setting name
- $value : string|null
-
Setting value or null to delete setting