whmcsDNSManager/modules/addons/DNSManager2/mgLibs/custom/dns/interfaces/SubmoduleInterface.php

<?php

namespace MGModule\DNSManager2\mgLibs\custom\dns\interfaces;

use MGModule\DNSManager2\mgLibs\custom\dns;

interface SubmoduleInterface {
    /**
     * 
     * @param string $domain Nazwa domeny, która będzie obsługiwana przez submoduł
     */
    public function setDomain($domain);
    
    /**
     * @return boolean TRUE jeżeli ip jest wymagane
     */
    public function isIPRequired();
    /**
     * @return boolean TRUE jeżeli dostępne jest TTL
     */
    public function isTTLEnabled();
    /**
     * @return boolean TRUE jeżeli rDNS jest wspierane
     */
    public function isRDNSSupported();
    
    /**
     * @throws \MGModule\DNSManager2\mgLibs\custom\dns\exceptions\DNSSubmoduleException rzuca wyjątkiem jak się nie uda
     */
    public function testConnection();
    
    /** 
     * @param string $name typy rekordów do pobrania, jeśli nie ustawione to zwraca wszystkie dostępne
     * @return dns\record\Record|array
     * @throws \MGModule\DNSManager2\mgLibs\custom\dns\exceptions\DNSSubmoduleException
     */
    public function getRecords($recordType = false);
    /**
     * dodawanie rekordu
     * @param \MGModule\DNSManager2\mgLibs\custom\dns\record\Record $record
     * @throws \MGModule\DNSManager2\mgLibs\custom\dns\exceptions\DNSSubmoduleException
     */
    public function addRecord(dns\record\Record $record);
    /**
     * Edycja rekordu
     * @param \MGModule\DNSManager2\mgLibs\custom\dns\record\Record $record
     * @throws \MGModule\DNSManager2\mgLibs\custom\dns\exceptions\DNSSubmoduleException
     */
    public function editRecord(dns\record\Record $record);
    /**
     * Usuwanie recordu
     * @param \MGModule\DNSManager2\mgLibs\custom\dns\record\Record $record
     * @throws \MGModule\DNSManager2\mgLibs\custom\dns\exceptions\DNSSubmoduleException
     */
    public function deleteRecord(dns\record\Record $record);
    
    /**
     * Sprawdzanie czy zone istnieje
     * @return boolean TRUE jeżeli istnieje
     * @throws \MGModule\DNSManager2\mgLibs\custom\dns\exceptions\DNSSubmoduleException
     */
    public function zoneExists();
    /**
     * Dodawanie zona
     * @throws \MGModule\DNSManager2\mgLibs\custom\dns\exceptions\DNSSubmoduleException rzuca wyjątkiem jak się nie uda
     */
    public function activateZone();
    /**
     * Usuwanie zona
     * @throws \MGModule\DNSManager2\mgLibs\custom\dns\exceptions\DNSSubmoduleException rzuca wyjątkiem jak się nie uda
     */
    public function terminateZone();
}