Doc. BaseCall. Default params class. Docs added.

Author: alexandergull

lib/Cleantalk/ApbctWP/BaseCall/DefaultParams.php

@@ -18,6 +18,10 @@ public function __construct($auth_key, $sender_info = [])
         $this->sender_info = $sender_info;
     }
 
+    /**
+     * Get default params
+     * @return array
+     */
     public function get()
     {
         return [
@@ -28,26 +32,42 @@ public function get()
             'x_real_ip'       => $this->getXRealIP(),
             'js_on'           => $this->getJsOn(),
             'agent'           => $this->getAgent(),
-            'submit_time'     => $this->getSubmittime(),
+            'submit_time'     => $this->getSubmitTime(),
         ];
     }
 
+    /**
+     * Get sender IP
+     * @return string|null
+     */
     public function getSenderIP()
     {
         $test_ip = $this->getTestIp();
         return $test_ip ?? $this->ipGet('remote_addr');
     }
 
+    /**
+     * Get X-Forwarded-For
+     * @return string|null
+     */
     public function getXForwardedForIP()
     {
         return $this->ipGet('x_forwarded_for');
     }
 
+    /**
+     * Get X-Real-IP
+     * @return string|null
+     */
     public function getXRealIP()
     {
         return $this->ipGet('x_real_ip');
     }
 
+    /**
+     * Get JS on
+     * @return int|null
+     */
     public function getJsOn()
     {
         $cookieValue = Sanitize::cleanTextField(
@@ -59,25 +79,40 @@ public function getJsOn()
             : apbct_js_test(Post::getString('ct_checkjs'));
     }
 
-    public function getSubmittime()
+    /**
+     * @return int|null
+     */
+    public function getSubmitTime()
     {
         return SubmitTimeHandler::getFromRequest();
     }
 
     /**
-     * ---- Wrapper methods for testability ----
+     * Retrieves the IP address based on the specified type.
+     *
+     * @param string $type The type or format of the IP address to retrieve.
+     * @return string|null Returns the IP address as a string if available; otherwise, returns null.
      */
-
     public function ipGet($type)
     {
         return \Cleantalk\ApbctWP\Helper::ipGet($type, false);
     }
 
+    /**
+     * Retrieves the value of the constant APBCT_AGENT.
+     *
+     * @return string Returns the value of APBCT_AGENT.
+     */
     public function getAgent()
     {
         return APBCT_AGENT;
     }
 
+    /**
+     * Retrieves the value of the constant CT_TEST_IP if it is defined and not empty.
+     *
+     * @return string|null Returns the value of CT_TEST_IP if available; otherwise, returns null.
+     */
     public function getTestIp()
     {
         return defined('CT_TEST_IP') && !empty(CT_TEST_IP)

tests/ApbctWP/BaseCall/BaseCallDefaultParamsTest.php

@@ -19,7 +19,7 @@ private function createMockedInstance($authKey = 'test_key', $senderInfo = [])
                 'getXForwardedForIP',
                 'getXRealIP',
                 'getJsOn',
-                'getSubmittime',
+                'getSubmitTime',
                 'getAgent',
                 'getTestIp',
                 'ipGet',
@@ -128,11 +128,11 @@ public function testGetSubmittime()
         $obj = $this->getMockBuilder(DefaultParams::class)
             ->setConstructorArgs(['test_key', []])
             ->onlyMethods([
-                'getSubmittime',
+                'getSubmitTime',
             ])
             ->getMock();
 
-        $obj->method('getSubmittime')
+        $obj->method('getSubmitTime')
             ->willReturn(123);
 
         $this->assertEquals(123, $obj->get()['submit_time']);
@@ -163,7 +163,7 @@ public function testGetFullData()
                 'getXForwardedForIP',
                 'getXRealIP',
                 'getJsOn',
-                'getSubmittime',
+                'getSubmitTime',
                 'getAgent',
                 'getTestIp',
                 'ipGet',
@@ -173,11 +173,11 @@ public function testGetFullData()
         $obj->method('getTestIp')->willReturn(null);
         $obj->method('getSenderIP')->willReturn('1.2.3.4');
         $obj->method('getAgent')->willReturn('test-agent');
-        $obj->method('getSubmittime')->willReturn(999);
+        $obj->method('getSubmitTime')->willReturn(999);
         $obj->method('getXRealIP')->willReturn('10.0.0.2');
         $obj->method('getXForwardedForIP')->willReturn('10.0.0.1');
         $obj->method('getJsOn')->willReturn(1);
-        $obj->method('getSubmittime')->willReturn(true);
+        $obj->method('getSubmitTime')->willReturn(true);
 
         $result = $obj->get();