Better docblocks for typecasting of variables

metaregistrar · Nov 18, 2019 · d720594 · d720594
1 parent b04f03a
commit d720594
Show file tree

Hide file tree

Showing 9 changed files with 60 additions and 30 deletions.
diff --git a/Examples/modifydomain.php b/Examples/modifydomain.php
@@ -67,7 +67,7 @@ function modifydomain($conn, $domainname, $registrant = null, $admincontact = nu
                         $del = new eppDomain($domainname);
                     }
                     foreach ($oldns as $ns) {
-                        $del->addHost($ns);
+                        $del->addHost(new eppHost($ns->getHostname()));
                     }
                 }
             }

diff --git a/Protocols/EPP/eppResponses/eppCreateContactResponse.php b/Protocols/EPP/eppResponses/eppCreateContactResponse.php
@@ -32,7 +32,7 @@ public function getContactCreateDate() {
 
     /**
      *
-     * @return eppContactHandle contacthandle
+     * @return null|eppContactHandle
      */
     public function getContactHandle() {
         if ($handle = $this->queryPath('/epp:epp/epp:response/epp:resData/contact:creData/contact:id')) {

diff --git a/Protocols/EPP/eppResponses/eppCreateDomainResponse.php b/Protocols/EPP/eppResponses/eppCreateDomainResponse.php
@@ -28,8 +28,7 @@ public function getDomainName() {
     }
 
     public function getDomain() {
-        $return = new eppDomain($this->getDomainName());
-        return $return;
+        return new eppDomain($this->getDomainName());
     }
 
 }
diff --git a/Protocols/EPP/eppResponses/eppInfoDomainResponse.php b/Protocols/EPP/eppResponses/eppInfoDomainResponse.php
@@ -41,7 +41,7 @@ public function getDomainId() {
     /**
      * Receive an array of statuses
      *
-     * @return string status
+     * @return null|string[]
      */
     public function getDomainStatuses() {
         $statuses = null;
@@ -93,7 +93,7 @@ public function getDomainContact($contacttype) {
     /**
      * Get the contacts associated with the domain name as eppContactHandle objects
      *
-     * @return array eppContactHandles
+     * @return null|eppContactHandle[]
      */
     public function getDomainContacts() {
         $xpath = $this->xPath();
@@ -191,7 +191,7 @@ public function getDomainUpdateClientId() {
      * This function returns the associated nameservers from a domain object
      * Please do not confuse this with getDomainHosts(), which is used for subordinate host objects
      *
-     * @return array of strings
+     * @return null|eppHost[]
      */
     public function getDomainNameservers() {
         $xpath = $this->xPath();
@@ -214,9 +214,8 @@ public function getDomainNameservers() {
                 }
             }
             return $ns;
-        } else {
-            return null;
         }
+        return null;
     }
 
     /**
@@ -251,14 +250,14 @@ public function getDomainAuthInfo() {
      * OBSOLETE, DO NOT USE THIS FUNCTION
      * If you need DNSSEC KeyData or DSData, see the extension SecDNS-1.1
      * ALL DNSSEC FUNCTIONS ARE IN THERE
-     * @return array|null
+     * @return null|eppSecdns[]
      */
     public function getKeydata() {
         // Check if dnssec is enabled on this interface
         if ($this->findNamespace('secDNS')) {
             $xpath = $this->xPath();
             $result = $xpath->query('/epp:epp/epp:response/epp:extension/secDNS:infData/*');
-            $keys = array();
+            $keys = [];
             if ($result->length > 0) {
                 foreach ($result as $keydata) {
                     /* @var $keydata \DOMElement */

diff --git a/Protocols/EPP/eppResponses/eppInfoHostResponse.php b/Protocols/EPP/eppResponses/eppInfoHostResponse.php
@@ -16,16 +16,16 @@ public function getHost() {
     }
 
     /**
-     *
-     * @return string hostname
+     * Get the hostname from the server response
+     * @return string
      */
     public function getHostName() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/host:infData/host:name');
     }
 
     /**
-     *
-     * @return array of host addresses
+     * Get Host IP addresses from the server response
+     * @return array
      */
     public function getHostAddresses() {
         $ip = null;
@@ -39,8 +39,8 @@ public function getHostAddresses() {
     }
 
     /**
-     *
-     * @return string status
+     * Get an array of statuses from the server response
+     * @return null|string[]
      */
     public function getHostStatuses() {
         $stat = null;
@@ -53,56 +53,56 @@ public function getHostStatuses() {
     }
 
     /**
-     *
-     * @return string statuses
+     * Get statuses as comma-separated values from the server response
+     * @return string
      */
     public function getHostStatusCSV() {
         return parent::arrayToCSV($this->getHostStatuses());
     }
 
     /**
      *
-     * @return string roid
+     * @return string
      */
     public function getHostRoid() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/host:infData/host:roid');
     }
 
     /**
      *
-     * @return string create_date
+     * @return string
      */
     public function getHostCreateDate() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/host:infData/host:crDate');
     }
 
     /**
      *
-     * @return string update_date
+     * @return string
      */
     public function getHostUpdateDate() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/host:infData/host:upDate');
     }
 
     /**
      *
-     * @return string client id
+     * @return string
      */
     public function getHostClientId() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/host:infData/host:clID');
     }
 
     /**
      *
-     * @return string client id
+     * @return string
      */
     public function getHostCreateClientId() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/host:infData/host:crID');
     }
 
     /**
      *
-     * @return string client id
+     * @return string
      */
     public function getHostUpdateClientId() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/host:infData/host:upID');

diff --git a/Protocols/EPP/eppResponses/eppPollResponse.php b/Protocols/EPP/eppResponses/eppPollResponse.php
@@ -94,6 +94,7 @@ public function getMessageCount() {
      * TYPE_CREATE
      * TYPE_UPDATE
      * TYPE_DELETE
+     * @return string
      */
     public function getMessageType() {
         if ($this->messageType) {
@@ -139,7 +140,7 @@ public function getDomainName() {
 
     /**
      * If present, retrieve the current status of the domain name in question
-     * @return string|null
+     * @return null|string
      */
     public function getDomainStatus() {
         $this->messageType = $this->getMessageType();

diff --git a/Protocols/EPP/eppResponses/eppRenewResponse.php b/Protocols/EPP/eppResponses/eppRenewResponse.php
@@ -14,10 +14,16 @@ function __destruct() {
     # DOMAIN RENEW RESPONSES
     #
 
+    /**
+     * @return null|string
+     */
     public function getDomainName() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:renData/domain:name');
     }
 
+    /**
+     * @return null|string
+     */
     public function getDomainExpirationDate() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:renData/domain:exDate');
     }

diff --git a/Protocols/EPP/eppResponses/eppResponse.php b/Protocols/EPP/eppResponses/eppResponse.php
@@ -212,7 +212,7 @@ public function getProblemtype() {
 
     /**
      *
-     * @return string|null
+     * @return null|string
      */
     public function getResultCode() {
         $result = $this->queryPath('/epp:epp/epp:response/epp:result/@code');
@@ -390,6 +390,9 @@ public function queryPath($path, $object = null) {
         }
     }
 
+    /**
+     * @param $exceptionhandler
+     */
     public function addException($exceptionhandler) {
         $this->exceptions[] = $exceptionhandler;
     }

diff --git a/Protocols/EPP/eppResponses/eppTransferResponse.php b/Protocols/EPP/eppResponses/eppTransferResponse.php
@@ -14,36 +14,58 @@ function __destruct() {
     # DOMAIN TRANSFER RESPONSES
     #
 
+    /**
+     * @return null|string
+     */
     public function getDomainName() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:trnData/domain:name');
     }
 
+    /**
+     * @return eppDomain
+     */
     public function getDomain() {
-        $return = new eppDomain($this->getDomainName());
-        return $return;
-
+        return new eppDomain($this->getDomainName());
     }
 
+    /**
+     * @return null|string
+     */
     public function getTransferStatus() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:trnData/domain:trStatus');
     }
 
+    /**
+     * @return null|string
+     */
     public function getTransferRequestClientId() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:trnData/domain:reID');
     }
 
+    /**
+     * @return null|string
+     */
     public function getTransferRequestDate() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:trnData/domain:reDate');
     }
 
+    /**
+     * @return null|string
+     */
     public function getTransferExpirationDate() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:trnData/domain:exDate');
     }
 
+    /**
+     * @return null|string
+     */
     public function getTransferActionDate() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:trnData/domain:acDate');
     }
 
+    /**
+     * @return null|string
+     */
     public function getTransferActionClientId() {
         return $this->queryPath('/epp:epp/epp:response/epp:resData/domain:trnData/domain:acID');
     }