1. class
  2. WHMCS
  3. Domain
  4. Registrar
  5. Domain

Domain

Store information regarding the domain that can be used within the product without requiring additional Registrar calls.

Where a get method returns null, no value has been set for the requested variable and the result should not be used.

class Domain

Constants

STATUS_ACTIVE

Domain Status Constants
STATUS_ARCHIVED

STATUS_DELETED

STATUS_EXPIRED

STATUS_INACTIVE

STATUS_SUSPENDED

STATUS_PENDING_DELETE

Properties summary

Type Property Description
protected null|string $domain
protected null|Carbon $expiryDate
protected null|string $registrationStatus
protected null|boolean $restorable
protected null|boolean $renewBeforeExpiration
protected null|boolean $idProtectionStatus
protected null|boolean $dnsManagementStatus
protected null|boolean $emailForwardingStatus
protected array|string[] $nameservers
protected null|boolean $transferLock
protected null|Carbon $transferLockExpiryDate
protected null|boolean $irtpOptOutStatus
protected null|boolean $irtpTransferLock
protected null|Carbon $irtpTransferLockExpiryDate
protected null|boolean $domainContactChangePending
protected null|Carbon $domainContactChangeExpiryDate
protected null|boolean $willDomainSuspend
protected null|boolean $isIrtpEnabled
protected array $irtpVerificationTriggerFields
protected null|string $registrantEmailAddress

Methods summary

Return Type Method Name Description
null|string getRegistrantEmailAddress() Retrieve the stored value for the registrant email address.
Domain setRegistrantEmailAddress(null|string $registrantEmailAddress) Set the registrant email address for the domain.
string|null getDomain() Get the stored value for the domain.
Domain setDomain(string $domain) Set the domain name.
Carbon|null getExpiryDate() Retrieve the expiry date of the domain
Domain setExpiryDate(Carbon $expiryDate = null) Set the expiry date value of the domain using a carbon object.
string|null getRegistrationStatus() Retrieve the stored registration status
Domain setRegistrationStatus(string $registrationStatus) Set the registration status of the domain using the status constants within this class:
boolean|null getRestorable() Retrieve if the domain is restorable.
Domain setRestorable(boolean $restorable) Set if the domain is currently restorable if the expiry date has passed.
boolean|null getRenewBeforeExpiration() Check if the domain can be renewed before expiry
Domain setRenewBeforeExpiration(boolean $renewBeforeExpiration) Set if the domain can be renewed before the expiry date.
boolean|null getIdProtectionStatus() Get if the domain currently has an active ID Protection product on it.
Domain setIdProtectionStatus(boolean $idProtectionStatus) Set if the domain currently has an active ID Protection poduct on it.
boolean getDnsManagementStatus() Get if DNS Management (A, AAAA, CNAME, etc., records) is active on this domain at the registrar.
Domain setDnsManagementStatus(boolean $dnsManagementStatus) Set if DNS Management (A, AAAA, CNAME, etc., records) is active on this domain at the registrar.
boolean getEmailForwardingStatus() Check if email forwarding is enabled on the domain at the registrar
Domain setEmailForwardingStatus(boolean $emailForwardingStatus) Set if email forwarding is enabled on the domain at the registrar.
boolean hasNameservers() Checks if the domain has more than zero nameservers associated with it that have been added using setNameservers
array getNameservers() Retrieve the array of nameservers associated with the domain.
Domain setNameservers(array $nameservers) Set the currently active nameservers for the domain.
boolean hasTransferLock() Check if the transfer lock state has been set on the domain.
boolean|null getTransferLock() Check if the transfer lock is enabled on the domain.
Domain setTransferLock(boolean $transferLock) Set the transfer lock status on the domain.
Carbon|null getTransferLockExpiryDate() Get the expiry date of the transfer lock.
Domain setTransferLockExpiryDate(Carbon $transferLockExpiryDate = null) Set the expiry date of the transfer lock using a Carbon object.
boolean|null getIrtpOptOutStatus() Get if IRTP has been opted out.
Domain setIrtpOptOutStatus(boolean $irtpOptOutStatus) Set if IRTP has been opted out of.
boolean|null getIrtpTransferLock() Get the status of the irtp transfer lock.
Domain setIrtpTransferLock(boolean $irtpTransferLock) Set the state of the irtp transfer lock.
Carbon|null getIrtpTransferLockExpiryDate() Get the expiry date of the transfer lock.
Domain setIrtpTransferLockExpiryDate(Carbon $irtpTransferLockExpiryDate) Set the expiry date of the transfer lock using a Carbon object.
boolean|null isContactChangePending() Check if a contact change is pending on the domain.
Domain setDomainContactChangePending(boolean $domainContactChangePending) Set if a contact change is pending on the domain.
Carbon|null getDomainContactChangeExpiryDate() Get the date that the contact change is to be confirmed by.
Domain setDomainContactChangeExpiryDate(Carbon $domainContactChangeExpiryDate = null) Set the confirmation deadline that the contact change is to be confirmed by using a Carbon object.
boolean|null getPendingSuspension() Check if the domain is pending suspension.
Domain setPendingSuspension(boolean $willDomainSuspend) Set if the domain is pending suspension.
$this setIsIrtpEnabled($isIrtpEnabled) Set if this domain is subject to IRTP policies.
bool|null getIsIrtpEnabled() Check if this domain is an ICANN tld and subject to IRTP policies.
bool|null isIrtpEnabled() Check if this domain is an ICANN tld and subject to IRTP policies.
$this setIrtpVerificationTriggerFields(array $fields = []) Set the fields that trigger IRTP verification when changed.
array getIrtpVerificationTriggerFields() Obtain the fields that trigger IRTP verification.

Details

null|string getRegistrantEmailAddress ()

Retrieve the stored value for the registrant email address.

Return Value

null|string

Domain setRegistrantEmailAddress (null|string $registrantEmailAddress)

Set the registrant email address for the domain.

Parameters

null|string $registrantEmailAddress

Return Value

Domain

string|null getDomain ()

Get the stored value for the domain.

Return Value

string|null

Domain setDomain (string $domain)

Set the domain name.

Parameters

string $domain

Return Value

Domain

Carbon|null getExpiryDate ()

Retrieve the expiry date of the domain

Return Value

Carbon|null

Domain setExpiryDate (Carbon $expiryDate = null)

Set the expiry date value of the domain using a carbon object.

Example: Carbon::createFromFormat('Y-m-d', '2022-12-12')

Parameters

Carbon $expiryDate

Return Value

Domain

string|null getRegistrationStatus ()

Retrieve the stored registration status

Return Value

string|null

Domain setRegistrationStatus (string $registrationStatus)

Set the registration status of the domain using the status constants within this class:

STATUS_ACTIVE STATUS_ARCHIVED STATUS_DELETED STATUS_EXPIRED STATUS_INACTIVE STATUS_SUSPENDED STATUS_PENDING_DELETE

Parameters

string $registrationStatus

Return Value

Domain

boolean|null getRestorable ()

Retrieve if the domain is restorable.

Return Value

boolean|null

Domain setRestorable (boolean $restorable)

Set if the domain is currently restorable if the expiry date has passed.

Parameters

boolean $restorable

Return Value

Domain

boolean|null getRenewBeforeExpiration ()

Check if the domain can be renewed before expiry

Return Value

boolean|null

Domain setRenewBeforeExpiration (boolean $renewBeforeExpiration)

Set if the domain can be renewed before the expiry date.

Parameters

boolean $renewBeforeExpiration

Return Value

Domain

boolean|null getIdProtectionStatus ()

Get if the domain currently has an active ID Protection product on it.

Return Value

boolean|null

Domain setIdProtectionStatus (boolean $idProtectionStatus)

Set if the domain currently has an active ID Protection poduct on it.

Parameters

boolean $idProtectionStatus

Return Value

Domain

boolean getDnsManagementStatus ()

Get if DNS Management (A, AAAA, CNAME, etc., records) is active on this domain at the registrar.

Return Value

boolean

Domain setDnsManagementStatus (boolean $dnsManagementStatus)

Set if DNS Management (A, AAAA, CNAME, etc., records) is active on this domain at the registrar.

Parameters

boolean $dnsManagementStatus

Return Value

Domain

boolean getEmailForwardingStatus ()

Check if email forwarding is enabled on the domain at the registrar

Return Value

boolean

Domain setEmailForwardingStatus (boolean $emailForwardingStatus)

Set if email forwarding is enabled on the domain at the registrar.

Parameters

boolean $emailForwardingStatus

Return Value

Domain

boolean hasNameservers ()

Checks if the domain has more than zero nameservers associated with it that have been added using setNameservers

Return Value

boolean

array getNameservers ()

Retrieve the array of nameservers associated with the domain.

Return Value

array

Domain setNameservers (array $nameservers)

Set the currently active nameservers for the domain.

Example: array('ns1' => 'ns1.yourdomain.com', 'ns2' => 'ns2.yourdomain.com', 'ns3' => 'ns3.yourdomain.com')

Parameters

array $nameservers

Return Value

Domain

boolean hasTransferLock ()

Check if the transfer lock state has been set on the domain.

Return Value

boolean

boolean|null getTransferLock ()

Check if the transfer lock is enabled on the domain.

Return Value

boolean|null

Domain setTransferLock (boolean $transferLock)

Set the transfer lock status on the domain.

True for enabled, false for disabled.

Parameters

boolean $transferLock

Return Value

Domain

Carbon|null getTransferLockExpiryDate ()

Get the expiry date of the transfer lock.

Return Value

Carbon|null

Domain setTransferLockExpiryDate (Carbon $transferLockExpiryDate = null)

Set the expiry date of the transfer lock using a Carbon object.

Example: Carbon::createFromFormat('Y-m-d', '2018-12-12')

Parameters

Carbon $transferLockExpiryDate

Return Value

Domain

boolean|null getIrtpOptOutStatus ()

Get if IRTP has been opted out.

Return Value

boolean|null

Domain setIrtpOptOutStatus (boolean $irtpOptOutStatus)

Set if IRTP has been opted out of.

Parameters

boolean $irtpOptOutStatus

Return Value

Domain

boolean|null getIrtpTransferLock ()

Get the status of the irtp transfer lock.

Return Value

boolean|null

Domain setIrtpTransferLock (boolean $irtpTransferLock)

Set the state of the irtp transfer lock.

Parameters

boolean $irtpTransferLock

Return Value

Domain

Carbon|null getIrtpTransferLockExpiryDate ()

Get the expiry date of the transfer lock.

Return Value

Carbon|null

Domain setIrtpTransferLockExpiryDate (Carbon $irtpTransferLockExpiryDate)

Set the expiry date of the transfer lock using a Carbon object.

Example: Carbon::createFromFormat('Y-m-d', '2018-12-12')

Parameters

Carbon $irtpTransferLockExpiryDate

Return Value

Domain

boolean|null isContactChangePending ()

Check if a contact change is pending on the domain.

Return Value

boolean|null

Domain setDomainContactChangePending (boolean $domainContactChangePending)

Set if a contact change is pending on the domain.

Parameters

boolean $domainContactChangePending

Return Value

Domain

Carbon|null getDomainContactChangeExpiryDate ()

Get the date that the contact change is to be confirmed by.

Return Value

Carbon|null

Domain setDomainContactChangeExpiryDate (Carbon $domainContactChangeExpiryDate = null)

Set the confirmation deadline that the contact change is to be confirmed by using a Carbon object.

Example: Carbon::createFromFormat('Y-m-d', '2018-12-12')

Parameters

Carbon $domainContactChangeExpiryDate

Return Value

Domain

boolean|null getPendingSuspension ()

Check if the domain is pending suspension.

A domain will be pending suspension if a new registration has occurred and the registrant contact has not been confirmed.

Return Value

boolean|null

Domain setPendingSuspension (boolean $willDomainSuspend)

Set if the domain is pending suspension.

Parameters

boolean $willDomainSuspend

Return Value

Domain

$this setIsIrtpEnabled ($isIrtpEnabled)

Set if this domain is subject to IRTP policies.

Parameters

$isIrtpEnabled

Return Value

$this

bool|null getIsIrtpEnabled ()

Check if this domain is an ICANN tld and subject to IRTP policies.

Alias of self::isIrtpEnabled

Return Value

bool|null

bool|null isIrtpEnabled ()

Check if this domain is an ICANN tld and subject to IRTP policies.

Return Value

bool|null

$this setIrtpVerificationTriggerFields (array $fields = [])

Set the fields that trigger IRTP verification when changed.

Example: array('Registrant' => array('First Name', 'Last Name', 'Organisation Name', 'Email',))

Parameters

array $fields

Return Value

$this

array getIrtpVerificationTriggerFields ()

Obtain the fields that trigger IRTP verification.

Return Value

array