WHMCS\Domain\Registrar\Domain

Class

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.

public function getRegistrantEmailAddress()

Retrieve the stored value for the registrant email address.

Returns null\|string

public function setRegistrantEmailAddress($registrantEmailAddress)

Set the registrant email address for the domain.

Parameters

Returns self

public function getDomain()

Get the stored value for the domain.

Returns string\|null

public function setDomain($domain)

Set the domain name.

Parameters

Returns self

public function getExpiryDate()

Retrieve the expiry date of the domain

Returns Carbon\|null

public function 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

Returns self

public function getRegistrationStatus()

Retrieve the stored registration status

Returns string\|null

public function setRegistrationStatus($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

Returns self

public function getRestorable()

Retrieve if the domain is restorable.

Returns boolean\|null

public function setRestorable($restorable)

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

Parameters

Returns self

public function getRenewBeforeExpiration()

Check if the domain can be renewed before expiry

Returns boolean\|null

public function setRenewBeforeExpiration($renewBeforeExpiration)

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

Parameters

Returns self

public function getIdProtectionStatus()

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

Returns boolean\|null

public function setIdProtectionStatus($idProtectionStatus)

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

Parameters

Returns self

public function getDnsManagementStatus()

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

Returns boolean

public function setDnsManagementStatus($dnsManagementStatus)

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

Parameters

Returns self

public function getEmailForwardingStatus()

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

Returns boolean

public function setEmailForwardingStatus($emailForwardingStatus)

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

Parameters

Returns self

public function hasNameservers()

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

Returns boolean

public function getNameservers()

Retrieve the array of nameservers associated with the domain.

Returns array

public function setNameservers($nameservers)

Set the currently active nameservers for the domain.

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

Parameters

Returns self

public function hasTransferLock()

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

Returns boolean

public function getTransferLock()

Check if the transfer lock is enabled on the domain.

Returns boolean\|null

public function setTransferLock($transferLock)

Set the transfer lock status on the domain. True for enabled, false for disabled.

Parameters

Returns self

public function getTransferLockExpiryDate()

Get the expiry date of the transfer lock.

Returns Carbon\|null

public function 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

Returns self

public function getIrtpOptOutStatus()

Get if IRTP has been opted out.

Returns boolean\|null

public function setIrtpOptOutStatus($irtpOptOutStatus)

Set if IRTP has been opted out of.

Parameters

Returns self

public function getIrtpTransferLock()

Get the status of the irtp transfer lock.

Returns boolean\|null

public function setIrtpTransferLock($irtpTransferLock)

Set the state of the irtp transfer lock.

Parameters

Returns self

public function getIrtpTransferLockExpiryDate()

Get the expiry date of the transfer lock.

Returns Carbon\|null

public function 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

Returns self

public function isContactChangePending()

Check if a contact change is pending on the domain.

Returns boolean\|null

public function setDomainContactChangePending($domainContactChangePending)

Set if a contact change is pending on the domain.

Parameters

Returns self

public function getDomainContactChangeExpiryDate()

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

Returns Carbon\|null

public function 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

Returns self

public function 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.

Returns boolean\|null

public function setPendingSuspension($willDomainSuspend)

Set if the domain is pending suspension.

Parameters

Returns self

public function setIsIrtpEnabled($isIrtpEnabled)

Set if this domain is subject to IRTP policies.

Returns $this

public function getIsIrtpEnabled()

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

Alias of self::isIrtpEnabled

Returns bool\|null

public function isIrtpEnabled()

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

Returns bool\|null

public function setIrtpVerificationTriggerFields(array $fields = [])

Set the fields that trigger IRTP verification when changed.

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

Parameters

Returns $this

public function getIrtpVerificationTriggerFields()

Obtain the fields that trigger IRTP verification.

Returns array