Updated API for commit 9b14ad94fb8f1b28dffd36960ace0063c7af2b95

Author: actions-user

docs/classes/CodeIgniter-API-ResponseTrait.html

@@ -308,7 +308,7 @@ <h4 id="toc-properties">
             <dt class="phpdocumentor-table-of-contents__entry -property -protected">
     <a class="" href="classes/CodeIgniter-API-ResponseTrait.html#property_format">$format</a>
     <span>
-                        &nbsp;: string|null            </span>
+                        &nbsp;: "html"|"json"|"xml"|null            </span>
 </dt>
 <dd>How to format the response data.</dd>
 
@@ -555,7 +555,7 @@ <h4 class="phpdocumentor-element__name" id="property_format">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">75</span>
+    <span class="phpdocumentor-element-found-in__line">74</span>
 
     </aside>
 
@@ -564,7 +564,7 @@ <h4 class="phpdocumentor-element__name" id="property_format">
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">protected</span>
-        <span class="phpdocumentor-signature__type">string|null</span>
+        <span class="phpdocumentor-signature__type">"html"|"json"|"xml"|null</span>
     <span class="phpdocumentor-signature__name">$format</span>
      = <span class="phpdocumentor-signature__default-value">&#039;json&#039;</span></code>
 
@@ -574,22 +574,6 @@ <h4 class="phpdocumentor-element__name" id="property_format">
 
 
 
-    <h5 class="phpdocumentor-tag-list__heading" id="tags">
-        Tags
-        <a href="classes/CodeIgniter-API-ResponseTrait.html#property_format#tags" class="headerlink"><i class="fas fa-link"></i></a>
-
-    </h5>
-    <dl class="phpdocumentor-tag-list">
-                                    <dt class="phpdocumentor-tag-list__entry">
-                    <span class="phpdocumentor-tag__name">phpstan-var</span>
-                </dt>
-                <dd class="phpdocumentor-tag-list__definition">
-                                                                                
-                                                 <section class="phpdocumentor-description"><p>'html'|'json'|'xml'|null</p>
-</section>
-
-                                    </dd>
-                                            </dl>
 
 
 
@@ -611,7 +595,7 @@ <h4 class="phpdocumentor-element__name" id="property_formatter">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">82</span>
+    <span class="phpdocumentor-element-found-in__line">81</span>
 
     </aside>
 
@@ -653,7 +637,7 @@ <h4 class="phpdocumentor-element__name" id="method_fail">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">128</span>
+    <span class="phpdocumentor-element-found-in__line">127</span>
 
     </aside>
 
@@ -727,7 +711,7 @@ <h4 class="phpdocumentor-element__name" id="method_failForbidden">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">212</span>
+    <span class="phpdocumentor-element-found-in__line">211</span>
 
     </aside>
 
@@ -791,7 +775,7 @@ <h4 class="phpdocumentor-element__name" id="method_failNotFound">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">222</span>
+    <span class="phpdocumentor-element-found-in__line">221</span>
 
     </aside>
 
@@ -854,7 +838,7 @@ <h4 class="phpdocumentor-element__name" id="method_failResourceExists">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">244</span>
+    <span class="phpdocumentor-element-found-in__line">243</span>
 
     </aside>
 
@@ -917,7 +901,7 @@ <h4 class="phpdocumentor-element__name" id="method_failResourceGone">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">256</span>
+    <span class="phpdocumentor-element-found-in__line">255</span>
 
     </aside>
 
@@ -982,7 +966,7 @@ <h4 class="phpdocumentor-element__name" id="method_failServerError">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">278</span>
+    <span class="phpdocumentor-element-found-in__line">277</span>
 
     </aside>
 
@@ -1051,7 +1035,7 @@ <h4 class="phpdocumentor-element__name" id="method_failTooManyRequests">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">266</span>
+    <span class="phpdocumentor-element-found-in__line">265</span>
 
     </aside>
 
@@ -1114,7 +1098,7 @@ <h4 class="phpdocumentor-element__name" id="method_failUnauthorized">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">201</span>
+    <span class="phpdocumentor-element-found-in__line">200</span>
 
     </aside>
 
@@ -1179,7 +1163,7 @@ <h4 class="phpdocumentor-element__name" id="method_failValidationErrors">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">234</span>
+    <span class="phpdocumentor-element-found-in__line">233</span>
 
     </aside>
 
@@ -1242,7 +1226,7 @@ <h4 class="phpdocumentor-element__name" id="method_format">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">295</span>
+    <span class="phpdocumentor-element-found-in__line">294</span>
 
     </aside>
 
@@ -1292,7 +1276,7 @@ <h4 class="phpdocumentor-element__name" id="method_respond">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">92</span>
+    <span class="phpdocumentor-element-found-in__line">91</span>
 
     </aside>
 
@@ -1356,7 +1340,7 @@ <h4 class="phpdocumentor-element__name" id="method_respondCreated">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">154</span>
+    <span class="phpdocumentor-element-found-in__line">153</span>
 
     </aside>
 
@@ -1412,7 +1396,7 @@ <h4 class="phpdocumentor-element__name" id="method_respondDeleted">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">166</span>
+    <span class="phpdocumentor-element-found-in__line">165</span>
 
     </aside>
 
@@ -1468,7 +1452,7 @@ <h4 class="phpdocumentor-element__name" id="method_respondNoContent">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">189</span>
+    <span class="phpdocumentor-element-found-in__line">188</span>
 
     </aside>
 
@@ -1518,7 +1502,7 @@ <h4 class="phpdocumentor-element__name" id="method_respondUpdated">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">178</span>
+    <span class="phpdocumentor-element-found-in__line">177</span>
 
     </aside>
 
@@ -1574,15 +1558,15 @@ <h4 class="phpdocumentor-element__name" id="method_setResponseFormat">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="system/API/ResponseTrait.php"><a href="files/system-api-responsetrait.html"><abbr title="system/API/ResponseTrait.php">ResponseTrait.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">356</span>
+    <span class="phpdocumentor-element-found-in__line">354</span>
 
     </aside>
 
         <p class="phpdocumentor-summary">Sets the format the response should be in.</p>
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">protected</span>
-                    <span class="phpdocumentor-signature__name">setResponseFormat</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$format</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</span></code>
+                    <span class="phpdocumentor-signature__name">setResponseFormat</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">"json"|"xml"&nbsp;</span><span class="phpdocumentor-signature__argument__name">$format</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">$this</span></code>
 
     <div class="phpdocumentor-label-line">
         </div>
@@ -1592,7 +1576,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$format</span>
-                : <span class="phpdocumentor-signature__argument__return-type">string|null</span>
+                : <span class="phpdocumentor-signature__argument__return-type">"json"|"xml"</span>
                  = <span class="phpdocumentor-signature__argument__default-value">null</span>            </dt>
             <dd class="phpdocumentor-argument-list__definition">
                     <section class="phpdocumentor-description"><p>Response format</p>
@@ -1602,22 +1586,6 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
             </dl>
 
 
-    <h5 class="phpdocumentor-tag-list__heading" id="tags">
-        Tags
-        <a href="classes/CodeIgniter-API-ResponseTrait.html#method_setResponseFormat#tags" class="headerlink"><i class="fas fa-link"></i></a>
-
-    </h5>
-    <dl class="phpdocumentor-tag-list">
-                                    <dt class="phpdocumentor-tag-list__entry">
-                    <span class="phpdocumentor-tag__name">phpstan-param</span>
-                </dt>
-                <dd class="phpdocumentor-tag-list__definition">
-                                                                                
-                                                 <section class="phpdocumentor-description"><p>'json'|'xml' $format</p>
-</section>
-
-                                    </dd>
-                                            </dl>