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

DomainManager

final class DomainManager implements DomainManagerInterface (View source)

Creates, updates and deletes zones for the web UI, including template records and DNSSEC setup.

Methods

__construct(TransactionInterface $transaction, ConfigurationInterface $config, DomainRepositoryInterface $domainRepository, RepositoryFactoryInterface $repositoryFactory, DnsBackendProviderInterface $backendProvider, PermissionService $permissionService, UserLookupInterface $userRepository, RecordChangeWriterInterface $changeLogger, ZoneTemplateApplier $templateApplier, ZoneTemplateRepositoryInterface $zoneTemplateRepository, ZoneTemplatePlaceholders $placeholders, ZoneTemplateSyncRepositoryInterface $templateSync, TemplateRecordLinkRepositoryInterface $templateLinks, ZoneGroupRepositoryInterface $zoneGroups, ZoneAccountSyncService $accountSync, ActorInterface $actor, LoggerInterface|null $logger = null, ZoneCacheFlusherInterface|null $zoneCacheFlusher = null, ZoneOwnershipLimit|null $ownershipLimit = null)

Constructor

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

bool
retrieveZone(int $id)

Request an immediate AXFR transfer of a secondary zone from its master.

bool
notifyZone(int $id)

Ask PowerDNS to send NOTIFY for a primary zone now.

ZoneWriteResult
changeZoneType(string $type, int $id)

Change Zone Type

ZoneWriteResult
changeZoneSlaveMaster(int $zone_id, string $ip_slave_master)

Change Slave Zone's Master IP Address

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
addOwnerToZone(int $zone_id, int $user_id)

Add a user as an owner of a zone. An existing owner is left as is and reported as success.

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 105
__construct(TransactionInterface $transaction, ConfigurationInterface $config, DomainRepositoryInterface $domainRepository, RepositoryFactoryInterface $repositoryFactory, DnsBackendProviderInterface $backendProvider, PermissionService $permissionService, UserLookupInterface $userRepository, RecordChangeWriterInterface $changeLogger, ZoneTemplateApplier $templateApplier, ZoneTemplateRepositoryInterface $zoneTemplateRepository, ZoneTemplatePlaceholders $placeholders, ZoneTemplateSyncRepositoryInterface $templateSync, TemplateRecordLinkRepositoryInterface $templateLinks, ZoneGroupRepositoryInterface $zoneGroups, ZoneAccountSyncService $accountSync, ActorInterface $actor, LoggerInterface|null $logger = null, ZoneCacheFlusherInterface|null $zoneCacheFlusher = null, ZoneOwnershipLimit|null $ownershipLimit = null)

Constructor

Parameters

TransactionInterface $transaction

Wraps the native zone rows of a creation
ConfigurationInterface $config

Configuration manager
DomainRepositoryInterface $domainRepository

Domain repository
RepositoryFactoryInterface $repositoryFactory

Builds the zone repository
DnsBackendProviderInterface $backendProvider

DNS backend provider
PermissionService $permissionService

Permissions and zone ownership of the acting user
UserLookupInterface $userRepository

Resolves the users named as zone owners
RecordChangeWriterInterface $changeLogger

Receives the zone and record snapshots
ZoneTemplateApplier $templateApplier

Applies a template to an existing zone
ZoneTemplateRepositoryInterface $zoneTemplateRepository

Reads the template records seeded into a new zone
ZoneTemplatePlaceholders $placeholders

Expands the placeholders in those records
ZoneTemplateSyncRepositoryInterface $templateSync

Records which template a new zone was seeded from
TemplateRecordLinkRepositoryInterface $templateLinks

Links the seeded records back to their template
ZoneGroupRepositoryInterface $zoneGroups

Group ownership of the new zone
ZoneAccountSyncService $accountSync

Mirrors the owner into the backend account field
ActorInterface $actor

The user the ownership and permission checks are about
LoggerInterface|null $logger
ZoneCacheFlusherInterface|null $zoneCacheFlusher

Tells PowerDNS about a committed zone, null when it needs no telling
ZoneOwnershipLimit|null $ownershipLimit

Zone limit of an added owner; null enforces none

at line 223
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 576
bool retrieveZone(int $id)

Request an immediate AXFR transfer of a secondary zone from its master.

Parameters

int $id

Zone ID

Return Value

bool

true on success

at line 586
bool notifyZone(int $id)

Ask PowerDNS to send NOTIFY for a primary zone now.

Parameters

int $id

Zone ID

Return Value

bool

true on success

at line 597
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 641
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 670
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 691
ZoneWriteResult addOwnerToZone(int $zone_id, int $user_id)

Add a user as an owner of a zone. An existing owner is left as is and reported as success.

Parameters

int $zone_id

Zone ID
int $user_id

User ID

Return Value

ZoneWriteResult

at line 727
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