Merge branch 'master' into refactor/add-typed-class-constants

Author: lacatoire

.github/workflows/ci.yml

@@ -4,11 +4,11 @@ jobs:
   ubuntu:
     strategy:
       matrix:
-          version: ['8.1', '8.2', '8.3']
+          version: ['8.1', '8.2', '8.3', '8.4', '8.5']
     runs-on: ubuntu-latest
     steps:
       - name: Checkout PhD
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

.github/workflows/full_render_doc-en_test.yml

@@ -6,18 +6,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout PhD
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           path: "phd"
 
       - name: "Checkout php/doc-en"
-        uses: "actions/checkout@v5"
+        uses: "actions/checkout@v6"
         with:
           path: "en"
           repository: "php/doc-en"
 
       - name: "Checkout php/doc-base"
-        uses: "actions/checkout@v5"
+        uses: "actions/checkout@v6"
         with:
           path: "doc-base"
           repository: "php/doc-base"

.github/workflows/test.yml

@@ -5,11 +5,12 @@ jobs:
     name: test
     strategy:
       matrix:
-        version: ['8.1', '8.2', '8.3']
+        version: ['8.1', '8.2', '8.3', '8.4', '8.5']
+    continue-on-error: ${{ matrix.version == '8.5' }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout PhD
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

composer.json

@@ -27,8 +27,13 @@
         "easybook/geshi": "For using GeSHi as code highlighter"
     },
     "autoload": {
-        "psr-0": {
-            "phpdotnet\\": "."
+        "psr-4": {
+            "phpdotnet\\phd\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "phpdotnet\\phd\\Tests\\": "tests/"
         }
     }
 }

docs/phd-guide/phd-guide.xml

@@ -97,10 +97,10 @@ install ok: channel://doc.php.net/PhD-1.0.1
 install ok: channel://doc.php.net/PhD_Generic-1.0.1
 install ok: channel://doc.php.net/PhD_PHP-1.0.1
 install ok: channel://doc.php.net/PhD_PEAR-1.0.1
-bjori@jessica:/usr/src/php/svn/phd/trunk$
 
+$ cd phd
 $ phd --version
-PhD Version: phd-from-svn
+PhD Version: phd-from-git
 PHP Version: 5.3.3-dev
 Copyright(c) 2007-2010 The PHP Documentation Group
 ]]>
@@ -113,20 +113,22 @@ Copyright(c) 2007-2010 The PHP Documentation Group
 
   <chapter xml:id="using-phd">
     <title>Using PhD to render documentation</title>
-
+      <note>
+          <para>
+              Earlier versions of the PHP documentation infrastructure used Subversion (SVN).
+              All PHP documentation repositories are now maintained using Git.
+          </para>
+      </note>
     <section xml:id="render-phpdoc">
       <title>Rendering the PHP Documentation Sources</title>
 
       <sidebar>
         <title>Getting the PHP Documentation Sources</title>
-
-        <para>To get the PHP documentation sources, simply <link
-        xlink:href="http://wiki.php.net/doc/scratchpad/howto/checkout">check them out from SVN</link>
-        with the following command.</para>
-
+        <para>To get the PHP documentation sources, simply clone them from the
+            official Git repository with the following command.</para>
         <screen>
 <![CDATA[
-$ svn co http://svn.php.net/repository/phpdoc/modules/doc-en phpdoc
+$ git clone https://github.com/php/doc-en.git phpdoc
 ... output
 ]]>
         </screen>
@@ -142,7 +144,7 @@ $ svn co http://svn.php.net/repository/phpdoc/modules/doc-en phpdoc
       </sidebar>
 
       <para>To quickly become familiar with using PhD, you can download the
-      PHP documentation sources and render those.Running PhD to render the
+      PHP documentation sources and render those. Running PhD to render the
       docs is surprisingly simple, so we'll start with that.</para>
 
       <screen>
@@ -300,8 +302,8 @@ Supported packages:
 
       <screen>
 <![CDATA[
-$ svn checkout http://svn.php.net:/repository/phd/trunk/docs/phd-guide
-U phd/docs/phd-guide/phd-guide.xml
+$ git clone https://github.com/php/phd.git
+$ cd phd/docs/phd-guide
 ]]>
       </screen>
 
@@ -677,12 +679,6 @@ $ pear install mediawiki/geshi]]></screen>
     <para>Some other articles for further reading. Latest are on top.</para>
 
     <itemizedlist>
-      <listitem>
-        <para><link
-        xlink:href="http://elizabethmariesmith.com/2009/02/setting-up-phd-on-windows/">Setting
-        up PhD on Windows</link> by Elizabeth Marie Smith (PhD 0.4.5)</para>
-      </listitem>
-
       <listitem>
         <para><link
         xlink:href="http://bjori.blogspot.com/2007/10/phd-php-based-docbook-renderer-rc1.html">PhD

phpdotnet/phd/Autoloader.php

@@ -26,7 +26,7 @@ public static function autoload(string $name): void
 
                 return;
             }
-            trigger_error(vsprintf('Cannot find file for %s: %s', [$name, $file ?? $filename]), E_USER_ERROR);
+            throw new \Error(vsprintf('Cannot find file for %s: %s', [$name, $file ?? $filename]));
         }
     }
 

phpdotnet/phd/Format/Factory.php

@@ -49,7 +49,7 @@ public final function createFormat($format, ...$formatParams) {
              }
             return $obj;
         }
-        trigger_error("This format is not supported by this package", E_USER_ERROR);
+        throw new \Error('This format is not supported by this package');
     }
 
     public static final function createFactory($package) {

phpdotnet/phd/ObjectStorage.php

@@ -3,19 +3,20 @@
 
 class ObjectStorage extends \SplObjectStorage
 {
-	public function attach(object $object, mixed $info = array()): void {
+	public function attach(object $object, mixed $info = []): void {
 		if (!($object instanceof Format)) {
 			throw new \InvalidArgumentException(
                 'Only classess inheriting ' . __NAMESPACE__ . '\\Format supported'
             );
 		}
 		if (empty($info)) {
-			$info = array(
+			$info = [
 				\XMLReader::ELEMENT => $object->getElementMap(),
 				\XMLReader::TEXT    => $object->getTextMap(),
-			);
+            ];
 		}
-		parent::attach($object, $info);
+
+        $this->offsetSet($object, $info);
 	}
 }
 

phpdotnet/phd/Options/Handler.php

@@ -184,10 +184,10 @@ public function option_d(string $k, mixed $v): array
     public function option_docbook(string $k, mixed $v): array
     {
         if (is_array($v)) {
-            trigger_error("Can only parse one file at a time", E_USER_ERROR);
+            throw new \Error('Can only parse one file at a time');
         }
         if (!file_exists($v) || is_dir($v) || !is_readable($v)) {
-            trigger_error(sprintf("'%s' is not a readable docbook file", $v), E_USER_ERROR);
+            throw new \Error(sprintf("'%s' is not a readable docbook file", $v));
         }
         return [
             'xmlRoot' => dirname($v),
@@ -209,19 +209,19 @@ public function option_o(string $k, mixed $v): array
     public function option_output(string $k, mixed $v): array
     {
         if (is_array($v)) {
-            trigger_error("Only a single output location can be supplied", E_USER_ERROR);
+            throw new \Error('Only a single output location can be supplied');
         }
         if (!file_exists($v)) {
             $this->outputHandler->v("Creating output directory..", VERBOSE_MESSAGES);
             if (!mkdir($v, 0777, true)) {
-                trigger_error(vsprintf("Can't create output directory : %s", [$v]), E_USER_ERROR);
+                throw new \Error(vsprintf("Can't create output directory : %s", [$v]));
             }
             $this->outputHandler->v("Output directory created", VERBOSE_MESSAGES);
         } elseif (!is_dir($v)) {
-            trigger_error("Output directory is a file?", E_USER_ERROR);
+            throw new \Error('Output directory is a file?');
         }
         if (!is_dir($v) || !is_readable($v)) {
-            trigger_error(sprintf("'%s' is not a valid directory", $v), E_USER_ERROR);
+            throw new \Error(sprintf("'%s' is not a valid directory", $v));
         }
         $v = (substr($v, strlen($v) - strlen(DIRECTORY_SEPARATOR)) === DIRECTORY_SEPARATOR) ? $v : ($v . DIRECTORY_SEPARATOR);
 
@@ -234,7 +234,7 @@ public function option_output(string $k, mixed $v): array
     public function option_outputfilename(string $k, mixed $v): array
     {
         if (is_array($v)) {
-            trigger_error("Only a single output location can be supplied", E_USER_ERROR);
+            throw new \Error('Only a single output location can be supplied');
         }
         $file = basename($v);
 
@@ -281,7 +281,7 @@ public function option_package(string $k, mixed $v): array
         foreach((array)$v as $package) {
             if (!in_array($package, $this->config->getSupportedPackages())) {
                 $supported = implode(', ', $this->config->getSupportedPackages());
-                trigger_error("Invalid Package (Tried: '$package' Supported: '$supported')", E_USER_ERROR);
+                throw new \Error("Invalid Package (Tried: '$package' Supported: '$supported')");
             }
         }
         return ['package' => (array) $v];
@@ -341,13 +341,13 @@ public function option_skip(string $k, mixed $v): array
     public function option_saveconfig(string $k, mixed $v): array
     {
         if (is_array($v)) {
-            trigger_error(sprintf("You cannot pass %s more than once", $k), E_USER_ERROR);
+            throw new \Error(sprintf('You cannot pass %s more than once', $k));
         }
 
         $val = is_bool($v) ? true : self::boolval($v);
 
         if (!is_bool($val)) {
-            trigger_error("yes/no || on/off || true/false || 1/0 expected", E_USER_ERROR);
+            throw new \Error('yes/no || on/off || true/false || 1/0 expected');
         }
 
         return ['saveConfig' => $val];
@@ -381,7 +381,7 @@ public function option_verbose(string $k, mixed $v): array
                     $verbose = max($verbose, 1);
                     $verbose <<= 1;
                 } else {
-                    trigger_error("Unknown option passed to --$k, '$const'", E_USER_ERROR);
+                    throw new \Error("Unknown option passed to --$k, '$const'");
                 }
             }
         }
@@ -438,11 +438,11 @@ public function option_c(string $k, mixed $v): array
     public function option_color(string $k, mixed $v): array
     {
         if (is_array($v)) {
-            trigger_error(sprintf("You cannot pass %s more than once", $k), E_USER_ERROR);
+            throw new \Error(sprintf('You cannot pass %s more than once', $k));
         }
         $val = self::boolval($v);
         if (!is_bool($val)) {
-            trigger_error("yes/no || on/off || true/false || 1/0 expected", E_USER_ERROR);
+            throw new \Error('yes/no || on/off || true/false || 1/0 expected');
         }
         return ['colorOutput' => $val];
     }

phpdotnet/phd/Options/Parser.php

@@ -80,11 +80,11 @@ private function validateOptions(): void {
             $checkArgv = explode('=', $argv[$i]);
             if (substr($checkArgv[0], 0, 2) === '--') {
                 if (!in_array(substr($checkArgv[0], 2), $long)) {
-                    trigger_error('Invalid long option ' . $argv[$i], E_USER_ERROR);
+                    throw new \Error('Invalid long option ' . $argv[$i]);
                 }
             } elseif (substr($checkArgv[0], 0, 1) === '-') {
                 if (!in_array(substr($checkArgv[0], 1), $short)) {
-                    trigger_error('Invalid short option ' . $argv[$i], E_USER_ERROR);
+                    throw new \Error('Invalid short option ' . $argv[$i]);
                 }
            }
         }
@@ -98,15 +98,15 @@ public function getopt(): array {
 
         $args = getopt($this->getShortOptions(), $this->getLongOptions());
         if ($args === false) {
-            trigger_error("Something happend with getopt(), please report a bug", E_USER_ERROR);
+            throw new \Error('Something happend with getopt(), please report a bug');
         }
 
         $parsedOptions = [];
         foreach ($args as $k => $v) {
             $handler = $this->handlerForOption($k);
 
             if (!is_callable($handler)) {
-                trigger_error("Hmh, something weird has happend, I don't know this option", E_USER_ERROR);
+                throw new \Error("Hmh, something weird has happend, I don't know this option");
             }
 
             $retVal = call_user_func($handler, $k, $v);