Add SignalMap to map signal value to its name

symfony · fabpot · Jun 20, 2023 · Jun 14, 2023 · Jun 14, 2023 · 32b7dc88aaecc1f23938ae383fda62773d08f7de
commit 32b7dc88aaecc1f23938ae383fda62773d08f7de
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+ * Add `SignalMap` to map signal value to its name
+
 6.3
 ---
 

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\SignalRegistry;
+
+/**
+ * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ */
+class SignalMap
+{
+    private static array $map;
+
+    public static function getSignalName(int $signal): ?string
+    {
+        if (!\extension_loaded('pcntl')) {
+            return null;
+        }
+
+        if (!isset(self::$map)) {
+            $r = new \ReflectionExtension('pcntl');
+            $c = $r->getConstants();
+            $map = array_filter($c, fn ($k) => str_starts_with($k, 'SIG') && !str_starts_with($k, 'SIG_'), \ARRAY_FILTER_USE_KEY);
+            self::$map = array_flip($map);
+        }
+
+        return self::$map[$signal] ?? null;
+    }
+}
@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Tests\SignalRegistry;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\SignalRegistry\SignalMap;
+
+class SignalMapTest extends TestCase
+{
+    /**
+     * @requires extension pcntl
+     *
+     * @testWith [2, "SIGINT"]
+     *           [9, "SIGKILL"]
+     *           [15, "SIGTERM"]
+     */
+    public function testSignalExists(int $signal, string $expected)
+    {
+        $this->assertSame($expected, SignalMap::getSignalName($signal));
+    }
+
+    public function testSignalDoesNotExist()
+    {
+        $this->assertNull(SignalMap::getSignalName(999999));
+    }
+}