Variable arguments do not work

[Tatsh]

  /**
   * Constructor. Accepts multiple arguments or only a single array argument.
   *
   * @param mixed $arg First item of the array.
   * @param mixed $arg,... Second item of the array.
   * @return sArray
   */
  public function __construct($arg = NULL) {
    if (is_array($arg)) {
      $this->data = array_values($arg);
      return;
    }

    $this->data = func_get_args();
  }

This only shows in the documentation as having the $arg parameter.

[deadbeef84]

I second this.

Also wondering if the old syntax could be improved upon. If my understanding is correct the previous parameter is necessary when documenting the optional number of arguments. Wouldn't this cause problems when no optional parameter is required?

Consider native php function call_user_func(), it's declaration would probably something like this function call_user_func($callback) {...}, what would the phpdoc block look like?

[mvriel]

@ralphschinder makes the following suggestion over IRC: https://gist.github.com/3881402

(this item is a good one to discuss as it may indeed be improved upon)

[boenrobot]

How about simply extending the definition of a variable, so that "$..." is a reserved variable name that means "zero or more arguments at this point", which in turn covers the case @deadbeef84 mentions. A legal PHP variable can't be called that way, so there's no conflicts here.

[barryvdh]

So what is the current suggested way of documenting a variable number of parameters?

Do you want to follow the new RFC and wait before it is final, or implement it seperately? https://wiki.php.net/rfc/variadics

The syntax in the examples from http://philsturgeon.co.uk/blog/2013/08/potential-variadic-function-syntax-for-php-56 look pretty nice

/**
 * Favorite one or more statuses.
 *
 * @param string $screenName
 * @param Twitter\Status ...$statuses
 *
 * @return array[League\Twitter\User]
 */
public function favoriteStatus($screenName, Twitter\Status ...$statuses)
{

[boenrobot]

IMHO, we should only follow it after it is accepted. We could support it before PHP does, but the point is for the syntax to be agreed upon first.

I personally like it (coincidently, I first saw that RFC earlier today...), but the rest of PHP internals to be on the same page as well.

[philsturgeon]

@mvriel any progress on this one? The RFC has been accepted.

[mvriel]

I have just added support for variadics matching the RFC on internals. This feature will be released with phpDocumentor version 2.4 that is due for release this weekend.

Note: Variadics support in the DocBlock works for all versions of PHP, not just PHP 5.6

[barryvdh]

Cool, thanks a lot!