1. interface
  2. Poweradmin
  3. \
  4. Domain
  5. \
  6. Service
  7. \
  8. Dns
  9. \
  10. DomainManagerInterface

DomainManagerInterface

interface DomainManagerInterface (View source)

Zone creation, update and deletion.

Methods

ZoneWriteResult
addDomain(string $domain, int|null $owner, string $type, string $slave_master, int|string $zone_template, array $groupIds = [], string|null $soaEditApi = null)

Add a domain to the database

ZoneWriteResult
changeZoneType(string $type, int $id)

Change Zone Type

bool
retrieveZone(int $id)

Ask the backend to retrieve a slave zone from its master now

bool
notifyZone(int $id)

Ask the backend to send NOTIFY for a primary zone now

ZoneWriteResult
changeZoneSlaveMaster(int $zone_id, string $ip_slave_master)

Change Slave Zone's Master IP Address

ZoneWriteResult
addOwnerToZone(int $zone_id, int $user_id)

Add a user as an owner of a zone; an existing owner counts as success

ZoneWriteResult
handOverZone(int $zone_id, int $from_user_id, int $to_user_id)

Give a zone of a user being deleted to another user; where the user's row carries the zone (API backend) it changes owner, otherwise the new owner is added

ZoneWriteResult
updateZoneRecords(int $dns_ttl, int $zone_id, int $zone_template_id)

Apply a zone template to a zone, or unlink it with template id 0.

Details

at line 41
ZoneWriteResult addDomain(string $domain, int|null $owner, string $type, string $slave_master, int|string $zone_template, array $groupIds = [], string|null $soaEditApi = null)

Add a domain to the database

Parameters

string $domain

A domain name
int|null $owner

Owner ID for domain (null if only groups are assigned)
string $type

Type of domain ['NATIVE','MASTER','SLAVE']
string $slave_master

Master server hostname for domain
int|string $zone_template

ID of zone template ['none' or int]
array $groupIds

Group IDs for group ownership (assigned atomically within the same transaction)
string|null $soaEditApi

SOA-EDIT-API policy for the new zone; 'OFF' disables, null uses the dns.soa_edit_api config default

Return Value

ZoneWriteResult

at line 49
ZoneWriteResult changeZoneType(string $type, int $id)

Change Zone Type

Parameters

string $type

New Zone Type [NATIVE,MASTER,SLAVE]
int $id

Zone ID

Return Value

ZoneWriteResult

at line 58
bool retrieveZone(int $id)

Ask the backend to retrieve a slave zone from its master now

Parameters

int $id

Zone ID

Return Value

bool

true on success

at line 67
bool notifyZone(int $id)

Ask the backend to send NOTIFY for a primary zone now

Parameters

int $id

Zone ID

Return Value

bool

true on success

at line 75
ZoneWriteResult changeZoneSlaveMaster(int $zone_id, string $ip_slave_master)

Change Slave Zone's Master IP Address

Parameters

int $zone_id

Zone ID
string $ip_slave_master

Master IP Address

Return Value

ZoneWriteResult

at line 83
ZoneWriteResult addOwnerToZone(int $zone_id, int $user_id)

Add a user as an owner of a zone; an existing owner counts as success

Parameters

int $zone_id

Zone ID
int $user_id

User ID

Return Value

ZoneWriteResult

at line 89
ZoneWriteResult handOverZone(int $zone_id, int $from_user_id, int $to_user_id)

Give a zone of a user being deleted to another user; where the user's row carries the zone (API backend) it changes owner, otherwise the new owner is added

Parameters

int $zone_id
int $from_user_id
int $to_user_id

Return Value

ZoneWriteResult

at line 98
ZoneWriteResult updateZoneRecords(int $dns_ttl, int $zone_id, int $zone_template_id)

Apply a zone template to a zone, or unlink it with template id 0.

Parameters

int $dns_ttl

Default TTL
int $zone_id

Zone ID to update
int $zone_template_id

Zone Template ID to use for update

Return Value

ZoneWriteResult