docs: bad octal number representation

[hiqsol]

That's what we see in docs:

public static boolean createDirectory ( $path, $mode = 509, $recursive = true )

And in the source:

public static function createDirectory($path, $mode = 0775, $recursive = true)

[samdark]

Nice catch.

[cebe]

I do not think apidoc has any chance to detect that the original representation was not decimal but octal...

[samdark]

If it's mode it's usually octal, isn't it?

[samdark]

We can make an exception...

[cebe]

mode can mean anything depended on the context :) Of course we could hardcode all the places we know in Yii but that could mess up the apidoc generator a bit.

[samdark]

Could it be exposed in config?

[cebe]

I am open for ideas on how to solve this, I do not see a good way right now, may reopen it, maybe someone has an idea about it.

[SilverFire]

Maybe we can handle it with a special PHPDoc comment?

[hiqsol]

This is rough, but it's enough for the problem and suitable for similar situations when you can be sure that this const is used only in special representation.

protected static $_specialConsts = [
  '509' => '0775',
  ...
] ;

public function renderConst ($value) 
{
  if (isset(static::$_specialConsts[(string) $value]) {
    return static::$_specialConsts[(string) $value] ;
  } 
  return somedefaultrenderconst($value);
} 

[yii-bot]

Issue moved to yiisoft/yii2-apidoc#38

[cebe]

@hiqsol want to send a PR to apidoc extension?