random: Deprecate lcg_value() (#15211)

RFC: https://wiki.php.net/rfc/deprecations_php_8_4

Author: TimWolla

NEWS

@@ -14,6 +14,9 @@ PHP                                                                        NEWS
   . array out of bounds, stack overflow handled for segfault handler on windows.
     (David Carlier)
 
+- Random:
+  . lcg_value() is now deprecated. (timwolla)
+
 - Standard:
   . Unserializing the uppercase 'S' tag is now deprecated. (timwolla)
 

UPGRADING

@@ -434,6 +434,11 @@ PHP 8.4 UPGRADE NOTES
     3-parameter signature with a null $row parameter instead.
   . Added pg_result_memory_size to get the visibility the memory used by a query result.
 
+- Random:
+  . lcg_value() is deprecated, as the function is broken in multiple ways.
+    Use \Random\Randomizer::getFloat() instead.
+    RFC: https://wiki.php.net/rfc/deprecations_php_8_4
+
 - Reflection:
   . Calling ReflectionMethod::__construct() with 1 argument is deprecated.
     Use ReflectionMethod::createFromMethodName() instead.

ext/random/random.c

@@ -27,6 +27,7 @@
 
 #include "php.h"
 
+#include "Zend/zend_attributes.h"
 #include "Zend/zend_enum.h"
 #include "Zend/zend_exceptions.h"
 

ext/random/random.stub.php

@@ -15,6 +15,7 @@
      */
     const MT_RAND_PHP = UNKNOWN;
 
+    #[\Deprecated(since: '8.4', message: "use \\Random\\Randomizer::getFloat() instead")]
     function lcg_value(): float {}
 
     function mt_srand(?int $seed = null, int $mode = MT_RAND_MT19937): void {}

ext/random/random_arginfo.h

@@ -8,7 +8,7 @@ echo "MATHS test script started\n";
 
 echo "\n lcg_value tests...\n";
 for ($i = 0; $i < 100; $i++) {
-    $res = lcg_value();
+    $res = @lcg_value();
 
     if (!is_float($res) || $res < 0 || $res > 1) {
         break;

ext/random/tests/01_functions/lcg_value_basic.phpt

@@ -0,0 +1,11 @@
+--TEST--
+lcg_value() deprecation
+--FILE--
+<?php
+
+var_dump(lcg_value());
+
+?>
+--EXPECTF--
+Deprecated: Function lcg_value() is deprecated since 8.4, use \Random\Randomizer::getFloat() instead in %s on line %d
+float(%f)