Api documentations update (Tue Dec 17 12:20:08 UTC 2024)

#apidocs

Author: sudo-robot

api-docs/phpstorm-stubs/AllowDynamicProperties.html

@@ -115,7 +115,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1125">at line 1125</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1149">at line 1149</a></div>
         <code>                    
     <strong>__construct</strong>()
         </code>

api-docs/phpstorm-stubs/Deprecated.html

@@ -138,7 +138,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1169">at line 1169</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1193">at line 1193</a></div>
         <code>                    
     <strong>__construct</strong>(string|null $message = null, string|null $since = null)
         </code>

api-docs/phpstorm-stubs/Ds/Map.html

@@ -271,7 +271,8 @@ <h2>Methods</h2>
                 <div class="col-md-8">
                     <a href="#method_toArray">toArray</a>()
 
-                                            <p><p>Converts the map to an array.</p></p>                </div>
+                                            <p class="no-description">No description</p>
+                                    </div>
                 <div class="col-md-2"></div>
             </div>
                     <div class="row">
@@ -1185,14 +1186,8 @@ <h3 id="method_toArray">
 
 
         <div class="method-description">
-                            <p><p>Converts the map to an array.</p></p>                <p><p><b>Note:</b> Casting to an array is not supported yet.</p>
-<p><b>Caution:</b> Maps where non-scalar keys are can't be converted to an
-array.
-</p>
-<p><b>Caution:</b> An array will treat all numeric keys as integers, eg.
-"1" and 1 as keys in the map will only result in 1 being included in
-the array.
-</p></p>        
+                            <p class="no-description">No description</p>
+                    
         </div>
         <div class="tags">
 

api-docs/phpstorm-stubs/Fiber.html

@@ -221,7 +221,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1015">at line 1015</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1039">at line 1039</a></div>
         <code>                    
     <strong>__construct</strong>(callable $callback)
         </code>
@@ -255,7 +255,7 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_start">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1027">at line 1027</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1051">at line 1051</a></div>
         <code>                    mixed
     <strong>start</strong>(mixed ...$args)
         </code>
@@ -310,7 +310,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_resume">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1040">at line 1040</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1064">at line 1064</a></div>
         <code>                    mixed
     <strong>resume</strong>(mixed $value = null)
         </code>
@@ -365,7 +365,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_throw">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1053">at line 1053</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1077">at line 1077</a></div>
         <code>                    mixed
     <strong>throw</strong>(<a href="Throwable.html">Throwable</a> $exception)
         </code>
@@ -420,7 +420,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_isStarted">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1058">at line 1058</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1082">at line 1082</a></div>
         <code>                    bool
     <strong>isStarted</strong>()
         </code>
@@ -453,7 +453,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_isSuspended">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1063">at line 1063</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1087">at line 1087</a></div>
         <code>                    bool
     <strong>isSuspended</strong>()
         </code>
@@ -486,7 +486,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_isRunning">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1068">at line 1068</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1092">at line 1092</a></div>
         <code>                    bool
     <strong>isRunning</strong>()
         </code>
@@ -519,7 +519,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_isTerminated">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1073">at line 1073</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1097">at line 1097</a></div>
         <code>                    bool
     <strong>isTerminated</strong>()
         </code>
@@ -552,7 +552,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getReturn">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1080">at line 1080</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1104">at line 1104</a></div>
         <code>                    mixed
     <strong>getReturn</strong>()
         </code>
@@ -594,7 +594,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getCurrent">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1085">at line 1085</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1109">at line 1109</a></div>
         <code>        static            <a href="Fiber.html">Fiber</a>|null
     <strong>getCurrent</strong>()
         </code>
@@ -627,7 +627,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_suspend">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1099">at line 1099</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1123">at line 1123</a></div>
         <code>        static            mixed
     <strong>suspend</strong>(mixed $value = null)
         </code>

api-docs/phpstorm-stubs/FiberError.html

@@ -259,7 +259,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1107">at line 1107</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1131">at line 1131</a></div>
         <code>                    
     <strong>__construct</strong>()
         </code>

api-docs/phpstorm-stubs/IntBackedEnum.html

@@ -136,8 +136,9 @@ <h2>Methods</h2>
                 <div class="col-md-8">
                     <a href="#method_from">from</a>(int|string $value)
 
-                                            <p class="no-description">No description</p>
-                                    </div>
+                                            <p><p>Translates an int into the corresponding <code>Enum</code>
+case, if any. If there is no matching case defined, it will throw a
+<code>ValueError</code>.</p></p>                </div>
                 <div class="col-md-2"></div>
             </div>
                     <div class="row">
@@ -147,8 +148,8 @@ <h2>Methods</h2>
                 <div class="col-md-8">
                     <a href="#method_tryFrom">tryFrom</a>(int|string $value)
 
-                                            <p class="no-description">No description</p>
-                                    </div>
+                                            <p><p>Translates an int into the corresponding <code>Enum</code>
+case, if any. If there is no matching case defined, it will return null.</p></p>                </div>
                 <div class="col-md-2"></div>
             </div>
             </div>
@@ -193,7 +194,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_from">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L974">at line 974</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L979">at line 979</a></div>
         <code>        static            <a href="BackedEnum.html">BackedEnum</a>
     <strong>from</strong>(int|string $value)
         </code>
@@ -203,8 +204,9 @@ <h3 id="method_from">
 
 
         <div class="method-description">
-                            <p class="no-description">No description</p>
-                    
+                            <p><p>Translates an int into the corresponding <code>Enum</code>
+case, if any. If there is no matching case defined, it will throw a
+<code>ValueError</code>.</p></p>                        
         </div>
         <div class="tags">
                             <h4>Parameters</h4>
@@ -228,6 +230,15 @@ <h4>Return Value</h4>
     </table>
 
 
+                            <h4>Exceptions</h4>
+
+                    <table class="table table-condensed">
+                    <tr>
+                <td><a href="ValueError.html">ValueError</a></td>
+                <td></td>
+            </tr>
+            </table>
+
 
 
                     </div>
@@ -236,7 +247,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_tryFrom">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L981">at line 981</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L989">at line 989</a></div>
         <code>        static            <a href="BackedEnum.html">BackedEnum</a>|null
     <strong>tryFrom</strong>(int|string $value)
         </code>
@@ -246,8 +257,8 @@ <h3 id="method_tryFrom">
 
 
         <div class="method-description">
-                            <p class="no-description">No description</p>
-                    
+                            <p><p>Translates an int into the corresponding <code>Enum</code>
+case, if any. If there is no matching case defined, it will return null.</p></p>                        
         </div>
         <div class="tags">
                             <h4>Parameters</h4>

api-docs/phpstorm-stubs/Override.html

@@ -115,7 +115,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1157">at line 1157</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1181">at line 1181</a></div>
         <code>                    
     <strong>__construct</strong>()
         </code>

api-docs/phpstorm-stubs/ReturnTypeWillChange.html

@@ -115,7 +115,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1116">at line 1116</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1140">at line 1140</a></div>
         <code>                    
     <strong>__construct</strong>()
         </code>

api-docs/phpstorm-stubs/SensitiveParameter.html

@@ -115,7 +115,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1134">at line 1134</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1158">at line 1158</a></div>
         <code>                    
     <strong>__construct</strong>()
         </code>

api-docs/phpstorm-stubs/SensitiveParameterValue.html

@@ -137,7 +137,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1144">at line 1144</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1168">at line 1168</a></div>
         <code>                    
     <strong>__construct</strong>(mixed $value)
         </code>
@@ -171,7 +171,7 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getValue">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1146">at line 1146</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1170">at line 1170</a></div>
         <code>                    mixed
     <strong>getValue</strong>()
         </code>
@@ -204,7 +204,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method___debugInfo">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1148">at line 1148</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/Core/Core_c.php#L1172">at line 1172</a></div>
         <code>                    array
     <strong>__debugInfo</strong>()
         </code>