php - 如何编写 PHP 函数以使它们可在 IDE 中使用 (PhpStorm)

Question

正如所问的那样，通过使用 CodeIgniter PHP MVC 框架，我应该怎么做才能使我在 MODELS 中的函数可以在 CONTROLLER 中使用，并在您输入时通过下拉菜单或弹出的建议框？

例如，在 MODELS 文件夹中，我有一个名为content_model.php：

...
function getItems($cat_id = NULL, $limit = NULL, $offset = NULL, $ordering){

    ...

}
...

因此，当我输入任何 CONTROLLER class$this->content_model->getItems(时，我希望弹出窗口如下所示：getItems($cat_id = NULL, $limit = NULL, $offset = NULL, $ordering)。

有什么建议么 ？顺便说一句，对不起，我可能不知道描述我的问题的准确词汇。

Answer 1

例如，在您的控制器类中，添加正确的 PhpDoc；

class MyController {

    /**
     * @var ContentModel (this is the name of your Content-model class)
     */
    protected $content_model;

}

如果$content_model属性是在运行时$this->{$propname} = new ContentModel();添加的（例如），像这样添加 PhpDoc；

/**
 * @property ContentModel $content_model
 */
class MyController {
    // your code here
}

Answer 2

我没有使用 PHPStorm，但是在 Netbeans 中，必须添加文档注释才能弹出自动建议框。我希望其他成熟的 IDE 也有类似的东西。

/**
 * Describe what the function does... 
 *
 * @param int $cat_id Describe $cat_id...
 * @param int $limit Describe $limit...
 * @param int $offset Describe $offset...
 * @param type $ordering Describe $ordering...
 */
function getItems($cat_id = NULL, $limit = NULL, $offset = NULL, $ordering)
{
    // code logic
}