Native types being assigned to current namespace

[jdrydn]

When generating documentation for a class under a namespace, certain types seem to be mapped to the namespace instead of remaining their native PHP types.

For instance,

namespace My\Awesome\Library;

class Person {
    public function waveTo(string $name, array $opts = []) {
        return "Waved to $name";
    }
}

Produces documentation looking like:

### waveTo

``php
Person::waveTo( \My\Awesome\Library\string $key,  array $opts = [] ): string
``

**Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| `$name` | **\My\Awesome\Library\string** |  |
| `$opts` | **array** |  |

When obviously this is a native string identifier, and adding \string to the function causes PHP to throw a syntax error. What I don't understand is where this template is excluding array, otherwise I'd just add string to the list of native classes to ignore!

Any ideas where this can be done? It's a pretty perfect template otherwise!

[jdrydn]

http://php.net/manual/en/functions.arguments.php#functions.arguments.type-declaration

I'm aware string type declaration support was only added in PHP 7, wondering if this is a PHPDoc issue more than this template! 🤦‍♂️

[cvuorinen]

This template gets the type info from phpDocumentor. What version of phpDocumentor do you have installed? Seems like PHP 7 support was added in version 2.9 https://github.com/phpDocumentor/phpDocumentor2/releases

[jdrydn]

Yeah, I think I had installed v2.9 beforehand, but reverted to 2.8 after seeing this message:

Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Installation request for cvuorinen/phpdoc-markdown-public ^0.1.2 -> satisfiable by cvuorinen/phpdoc-markdown-public[0.1.2].
    - cvuorinen/phpdoc-markdown-public 0.1.2 requires phpdocumentor/phpdocumentor ~2.8.0 -> satisfiable by phpdocumentor/phpdocumentor[v2.8.0, v2.8.1, v2.8.2, v2.8.3, v2.8.4, v2.8.5] but these conflict with your requirements or minimum-stability.

Is there a newer version of this package I should be using?

[cvuorinen]

Ah, sorry. I thought I had defined a version that allows minor updates. I'll fix it and make a new release.

[cvuorinen]

I released a new version that allows updating to phpdocumentor 2.9.

[jdrydn]

Sadly, updating phpdocumentor to 2.9 didn't solve this for me, so my workaround currently is:

{
  "name": "my/awesome/library",
  "version": "1.0.0",
  "scripts": {
    "phpdoc": [
      "php vendor/bin/phpdoc",
      "sed -i -e 's/\\\\My\\\\Awesome\\\\Library\\\\string/string/' -e 's/\\\\My\\\\Awesome\\\\Library\\\\array/array/' phpdocs/README.md"
    ]
  }
}

$ composer run-script phpdoc

¯\_(ツ)_/¯

[cvuorinen]

Ok, I set up a test of my own and I see the same result even with phpdocumentor 2.9. I'll look into it to see if I can figure out a way to fix it.

Meanwhile, another workaround is to have an actual DocBlock comment that has type string, then it works correctly.

[jdrydn]

@cvuorinen Yeah, much better than a sed command. I don't have a lot of files in this project so I'm happy with that as a solution.

[cvuorinen]

Seems like this should be fixed in phpDocumentor 3 but it's still WIP.

This release should be able to parse your php 7+ projects without issues. We are still working on new features to be implemented like parsing of return types and scalar type hints.

from https://github.com/phpDocumentor/phpDocumentor2/releases/tag/v3.0.0-alpha1