Search code examples
phpphpdoc

Php documenting array param


Question is about phpDocs, and describing array parameter. For example i have code like this

<?= $view['form']->getElement('number_of_doors_id'); ?>

And phpStorm doesn't understand what 'form' key is.

I've tried

/**
* @var $view['form'] \\Framework\Templating\Helper\FormHelper
*/

/**
* @params $view['form'] \\Framework\Templating\Helper\FormHelper
*/

Solution

  • Modified @Robert answer and solved this problem like this

    <?php
        /**
        * @var $view \Framework\Templating\Helper\FormHelper[]
        */
    ?>
    

    And if you need two different types just do

    /**
     * @var $view \Framework\Templating\Helper\FormHelper[]|\Framework\Templating\Helper\TranslatorHelper[]
     */
    

    And so on