php / phd Goto Github PK

https://github.com/php/phd/releases mentions the last release was 1.1.11, from 2019. Various improvements were made on the master branch since then (e.g. fixing various notices uses of deprecated features such as join() argument order).

https://wiki.php.net/doc/phd/install mentions that "The preferred method is using the pear channel", which also causes 1.1.11 to be installed.

I'm not familiar with publishing of pear modules myself, or who would be considered an owner of this application. Going through the steps in https://github.com/php/phd/blob/master/HOWTO.RELEASE first would help (e.g. checking for missing files and putting release notes in package.xml)

Random\IntervalBoundary is probably the first pre-defined enum, maybe we need to get PhD to render the enum?

https://github.com/php/php-src/blob/PHP-8.3/ext/random/random.stub.php#L158-L163

pear install doc.php.net/phd produces the following error:

No releases available for package "doc.php.net/phd"
install failed

Instead of installing phD.

Linking to an ID that is on an element with annotations="chunk:false" does not work.

Related to php/doc-en#3178

Hi,

The links to constants in https://www.php.net/manual/en/class.phar.php are broken (e.g., https://www.php.net/manual/en/.php#phar.constants.sha256 )

While they point to the correct ids it seems the URLs for Ids inside table.row are not being generated correctly.

en/reference/phar/Phar.xml
121:     <varname linkend="phar.constants.sha256">Phar::SHA256</varname>

en/reference/phar/constants.xml
117:     <row xml:id="phar.constants.sha256">

While the code lies in the doc-en repository, I suppose this is a URL generation issue with phd (?)

Starting with Firefox 103, it now does not replace nbsp with a normal space. https://bugzilla.mozilla.org/show_bug.cgi?id=359303

Try copying some code from the documentation and pasting it into a text file. (for example from here https://www.php.net/manual/en/function.preg-replace.php)

When running phd/render.php --docbook doc-base/.manual.xml --package PHP --partial=book.simdjson --format xhtml - it takes 10 seconds

Using https://github.com/adsr/phpspy to render a flame graph:

1. Use php's curl module if available?
2. Use a different CDN for static assets if possible, or check if the file is recent? (This is taking 5 seconds per file, which is a different question for a different repo)
3. Send etags/if-modified-since? (doesn't help, still slow https://daniel.haxx.se/blog/2019/12/06/curl-speaks-etag/ )
4. It's a fast 0.01 second redirect to https://www.php.net/styles/theme-base.css
5. Maybe check the modification time on disk and cache on disk as sha($url) on http 200s, and allow it by default if the css file modification time is less than a day old

Copying http://www.php.net/styles/theme-base.css
Copying http://www.php.net/styles/theme-medium.css

» wc output/php-chunked-xhtml/**/*.css  
 1884  3784 32631 output/php-chunked-xhtml/styles/03e73060321a0a848018724a6c83de7f-theme-base.css
  606  1242 11091 output/php-chunked-xhtml/styles/03e73060321a0a848018724a6c83de7f-theme-medium.css
 2490  5026 43722 total

< HTTP/2 200 
< server: myracloud
< date: Fri, 21 Oct 2022 12:52:18 GMT
< content-type: text/css
< last-modified: Mon, 17 Oct 2022 12:10:02 GMT
< etag: "634d461a-7f77"
< expires: Sat, 22 Oct 2022 11:06:08 GMT
< cache-control: max-age=86400
< x-cdn: 1

This might just be a wifi or cdn or isp issue, though - see php/web-php#556

I noticed that the documentation still uses Java/C# style return types, even though PHP now has its own syntax for return types. For exmaple:

mixed json_decode ( string $json )

instead of:

json_decode ( string $json ) : mixed

It would be nice to see the documentation reflect the syntax of the language.

The Function and Method listing contains spurious entries at the end for some languages, e.g. Japanese and simplified Chinese. I think this is (at least partially) caused by not properly handling UTF-8, e.g.

I'm not really sure whether this is the actual issue, though, since only functions and methods are supposed to be listed there, and this should only contain valid ASCII characters, so strlower() and friends shouldn't be a problem.

After decompiling chm file, I found that style.css contains HTML code.

I recently fixed an issue on pt_BR where linking on <function> was failing because whitespace inside the tag. So I suggest trim() and strtolower() the tag's content before calculating link targets.

Originally posted by @alfsb in php/doc-en#2658 (comment)

There is a missing space between the name of the interface and the extend keyword.

See https://www.php.net/manual/en/class.throwable.php for an example.

@mallardduck could you have a look considering you made the rendering changes.

The repository contains a valid composer.json file, so the package could be installed via Composer, however attempting to composer require php/phd lists that the package could not be found.

Attempting to submit the package via https://packagist.org/packages/submit gives "The vendor name php is reserved, please use another name or reach out to us if you have a legitimate use for it."

Specifically type="inline", but the others can also be useful.

see https://tdg.docbook.org/tdg/4.5/simplelist