Fix GH-269: Render union and intersection types in IDE formats

phpdotnet/phd/Package/IDE/Base.php

@@ -20,6 +20,7 @@ abstract class Package_IDE_Base extends Format {
         'tbody'                 => 'format_changelog_tbody',
         'tip'                   => 'format_notes',
         'warning'               => 'format_notes',
+        'type'                  => 'format_type',
     );
     protected $textmap    = array(
         'function'              => 'format_seealso_entry_text',
@@ -54,6 +55,8 @@ abstract class Package_IDE_Base extends Format {
     );
 
     protected $isFunctionRefSet;
+    /** Stack of the <type> elements being read, used to build union and intersection types */
+    protected $typeStack = [];
     protected $isChangelogRow = false;
     protected $role = false;
     protected $versions;
@@ -253,6 +256,7 @@ public function format_refentry($open, $name, $attrs, $props) {
         if ($open) {
             $this->function = $this->dfunction;
             $this->cchunk = $this->dchunk;
+            $this->typeStack = [];
 
             $this->function['manualid'] =  $attrs[Reader::XMLNS_XML]['id'];
             return;
@@ -292,16 +296,48 @@ public function format_refsect1($open, $name, $attrs, $props) {
         }
     }
 
+    public function format_type($open, $name, $attrs, $props) {
+        if (!$this->isFunctionRefSet || $this->role != 'description') {
+            return;
+        }
+        if ($open) {
+            if (!$props['empty']) {
+                $this->typeStack[] = [
+                    'class' => $attrs[Reader::XMLNS_DOCBOOK]['class'] ?? '',
+                    'parts' => [],
+                ];
+            }
+            return;
+        }
+        $frame = array_pop($this->typeStack);
+        if ($frame === null) {
+            return;
+        }
+        $type = match ($frame['class']) {
+            'union'        => implode('|', $frame['parts']),
+            'intersection' => implode('&', $frame['parts']),
+            default        => implode('', $frame['parts']),
+        };
+        if ($this->typeStack !== []) {
+            if ($frame['class'] === 'intersection') {
+                $type = '(' . $type . ')';
+            }
+            $this->typeStack[array_key_last($this->typeStack)]['parts'][] = $type;
+            return;
+        }
+        if (isset($this->cchunk['methodparam']) && !$this->cchunk['methodparam']) {
+            $this->function['return']['type'] = $type;
+            return;
+        }
+        $this->cchunk['param']['type'] = $type;
+    }
+
     public function format_type_text($value, $tag) {
         if (!$this->isFunctionRefSet) {
             return;
         }
-        if ($this->role == 'description') {
-            if (isset($this->cchunk['methodparam']) && !$this->cchunk['methodparam']) {
-                $this->function['return']['type'] = $value;
-                return;
-            }
-            $this->cchunk['param']['type'] = $value;
+        if ($this->role == 'description' && $this->typeStack !== []) {
+            $this->typeStack[array_key_last($this->typeStack)]['parts'][] = trim($value);
         }
     }
 

phpdotnet/phd/Package/IDE/XML.php

@@ -25,7 +25,7 @@ public function parseFunction() {
         foreach ((array)$this->function['params'] as $param) {
             $str .= '  <param>' . PHP_EOL;
             $str .= '    <name>' . $param['name'] . '</name>'  . PHP_EOL;
-            $str .= '    <type>' . $param['type'] . '</type>'  . PHP_EOL;
+            $str .= '    <type>' . $this->e($param['type'] ?? '') . '</type>'  . PHP_EOL;
             $str .= '    <optional>' . $param['optional'] . '</optional>'  . PHP_EOL;
             if (isset($param['initializer'])) {
                 $str .= '    <initializer>' . $param['initializer'] . '</initializer>'  . PHP_EOL;
@@ -37,7 +37,7 @@ public function parseFunction() {
 
         //Return
         $str .= '<return>' . PHP_EOL;
-        $str .= '  <type>' . $this->function['return']['type'] . '</type>' . PHP_EOL;
+        $str .= '  <type>' . $this->e($this->function['return']['type'] ?? '') . '</type>' . PHP_EOL;
         $str .= '  <description>' . $this->cdata_str($this->function['return']['description']) . '</description>' . PHP_EOL;
         $str .= '</return>' . PHP_EOL;
 

tests/package/ide/data/type_rendering.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<set xmlns="http://docbook.org/ns/docbook" xml:id="funcref">
+ <refentry xml:id="function.array-key-first">
+  <refnamediv>
+   <refname>array_key_first</refname>
+   <refpurpose>Gets the first key of an array</refpurpose>
+  </refnamediv>
+  <refsect1 role="description">
+   <methodsynopsis>
+    <type class="union"><type>int</type><type>string</type><type>null</type></type><methodname>array_key_first</methodname>
+    <methodparam><type>array</type><parameter>array</parameter></methodparam>
+   </methodsynopsis>
+  </refsect1>
+ </refentry>
+
+ <refentry xml:id="function.type-rendering">
+  <refnamediv>
+   <refname>type_rendering</refname>
+   <refpurpose>Function with union, intersection and DNF parameter types</refpurpose>
+  </refnamediv>
+  <refsect1 role="description">
+   <methodsynopsis>
+    <type>void</type><methodname>type_rendering</methodname>
+    <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>union</parameter></methodparam>
+    <methodparam><type class="intersection"><type>Countable</type><type>Traversable</type></type><parameter>intersection</parameter></methodparam>
+    <methodparam choice="opt"><type class="union"><type class="intersection"><type>Countable</type><type>Traversable</type></type><type>null</type></type><parameter>dnf</parameter><initializer>null</initializer></methodparam>
+   </methodsynopsis>
+  </refsect1>
+ </refentry>
+</set>

tests/package/ide/data/version.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<versions>
+ <function name="array_key_first" from="PHP 7 &gt;= 7.3.0, PHP 8"/>
+ <function name="type_rendering" from="PHP 8"/>
+</versions>

tests/package/ide/type_rendering_001.phpt

@@ -0,0 +1,49 @@
+--TEST--
+IDE type rendering 001 - Union, intersection and DNF types
+--CONFLICTS--
+all
+--FILE--
+<?php
+namespace phpdotnet\phd;
+
+require_once __DIR__ . "/../../setup.php";
+require_once __DIR__ . "/../../helpers.php";
+ensureOutputFolder();
+
+$config->xmlFile = __DIR__ . "/data/type_rendering.xml";
+$config->phpwebVersionFilename = __DIR__ . "/data/version.xml";
+$config->outputDir = dirname(__DIR__, 2) . "/output/";
+
+$render = new TestRender(new Reader($outputHandler), $config);
+$render->attach(new Package_IDE_JSON($config, $outputHandler));
+$render->attach(new Package_IDE_XML($config, $outputHandler));
+$render->run();
+
+foreach (["array_key_first", "type_rendering"] as $function) {
+    $json = json_decode(file_get_contents($config->outputDir . "ide-json/" . $function . ".json"), true);
+    echo $function, " return: ", $json["return"]["type"], "\n";
+    foreach ($json["params"] as $param) {
+        echo $function, " param ", $param["name"], ": ", $param["type"], "\n";
+    }
+}
+
+$xml = simplexml_load_file($config->outputDir . "ide-xml/type_rendering.xml");
+foreach ($xml->params->param as $param) {
+    echo "XML param ", $param->name, ": ", $param->type, "\n";
+}
+?>
+--CLEAN--
+<?php
+require_once __DIR__ . "/../../helpers.php";
+\phpdotnet\phd\removeOutputFolder();
+?>
+--EXPECT--
+array_key_first return: int|string|null
+array_key_first param array: array
+type_rendering return: void
+type_rendering param union: array|string
+type_rendering param intersection: Countable&Traversable
+type_rendering param dnf: (Countable&Traversable)|null
+XML param union: array|string
+XML param intersection: Countable&Traversable
+XML param dnf: (Countable&Traversable)|null