1. interface
  2. Poweradmin
  3. \
  4. Domain
  5. \
  6. Port
  7. \
  8. CatalogBackendInterface

CatalogBackendInterface

interface CatalogBackendInterface (View source)

Catalog zone membership reads and writes against the DNS backend.

Methods

array
getCatalogMembers(string $catalogName)

Zones carrying the given catalog.

array
getZonesByKind(string $kind)

Zones of one kind, with the catalog each currently belongs to.

string
getZoneCatalog(int $domainId)

Catalog the zone belongs to, lowercase and without a trailing dot, or '' when it is not a member.

bool
updateZoneCatalog(int $domainId, string $catalogName)

Join $catalogName, or leave the current catalog when it is ''.

Details

at line 39
array getCatalogMembers(string $catalogName)

Zones carrying the given catalog.

PowerDNS only publishes a member whose kind is MASTER or PRODUCER and which has an enabled apex SOA, so the kind is returned for callers to flag the rest.

Parameters

string $catalogName

Producer zone name, lowercase and without a trailing dot

Return Value

array

at line 47
array getZonesByKind(string $kind)

Zones of one kind, with the catalog each currently belongs to.

Parameters

string $kind

A ZoneType constant

Return Value

array

at line 56
string getZoneCatalog(int $domainId)

Catalog the zone belongs to, lowercase and without a trailing dot, or '' when it is not a member.

Parameters

int $domainId

Domain ID

Return Value

string

at line 65
bool updateZoneCatalog(int $domainId, string $catalogName)

Join $catalogName, or leave the current catalog when it is ''.

Parameters

int $domainId

Domain ID
string $catalogName

Producer zone name in canonical form, or '' to clear

Return Value

bool