Documentation

pm_DomainAlias
in package

Domain alias wrapper

Tags
since
18.0.33

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
throws
pm_Exception
Return values
mixed

deleteSettings()

Delete all domain alias custom settings

public deleteSettings([string $prefix = '' ]) : void
Parameters
$prefix : string = ''

Settings name prefix

Tags
since
18.0.60
Return values
void

getDisplayName()

Retrieves domain name as it is displayed in UI

public getDisplayName() : string
Tags
since
18.0.42
Return values
string

getId()

Retrieve domain alias ID.

public getId() : int
Return values
int

getName()

Retrieves domain alias name in ASCII format

public getName() : string
Tags
since
18.0.42
Return values
string

getProperty()

Retrieve property of domain alias

public getProperty(string $name) : mixed
Parameters
$name : string
Tags
throws
pm_Exception
since
18.0.60
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
since
18.0.60
Return values
string|null

hasSeoRedirect()

Shows whether 301 redirect to HTTPS is enabled on the domain alias

public hasSeoRedirect() : bool
Tags
since
18.0.42
Return values
bool

hasServiceDns()

Shows whether DNS service is enabled on the domain alias

public hasServiceDns() : bool
Tags
since
18.0.42
Return values
bool

hasServiceMail()

Shows whether mail service is enabled on the domain alias

public hasServiceMail() : bool
Tags
since
18.0.42
Return values
bool

hasServiceWeb()

Shows whether web hosting is enabled on the domain alias

public hasServiceWeb() : bool
Tags
since
18.0.42
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

Tags
since
18.0.60
Return values
void

Search results