使用 Symfony2 依赖注入保留自动完成功能

Question

我使用 PHP Storm 作为 IDE，但我相信其他 IDE（例如 Netbeans）也会遇到相同的问题，我将在下面解释。

当使用像 Symfony2 这样的框架时，我们添加了依赖注入的美妙世界。因此，可以使用如下代码片段简单地实例化对象：

$myThingy = $this->get('some_cool_service');

这非常方便，因为对象已经预先配置。一个问题是，自动完成功能在基本上任何 PHP IDE 中都会完全中断，因为 IDE 不知道 get() 方法返回什么类型。

有没有办法保留自动完成功能？例如，创建控制器的扩展是答案吗？例如：

class MyController extends Controller {
    /**
     * @return \MyNamespace\CoolService
     */
    public getSomeCoolService() {
        return new CoolService();
    }
}

然后对于应用程序控制器，指定MyController作为基类而不是Controller？

使用工厂类或任何其他可能的方法怎么样？

Answer 1

它更复杂，但您仍然可以使用 eclipse PDT 来完成此操作：

$myThingy = $this->get('some_cool_service');
/* @var $myThingy \MyNamespace\CoolService */

更新：
此页面上的示例显示您也可以使用 phpStorm 的相反方式：

$myThingy = $this->get('some_cool_service');
/* @var \MyNamespace\CoolService $myThingy */

Answer 2

您可以在控制器中定义私有属性

class MyController extends Controller
{
    /**
     * @var \Namespace\To\SomeCoolService;
     */
    private $my_service;

    public function myAction()
    {
        $this->my_service = $this->get('some_cool_service');
        /**
         * enjoy your autocompletion :)
         */
    }
}

Answer 3

我使用基本控制器类来进行捆绑。您需要在方法中注释 return。至少在 Eclipse 上是有效的。

/**
 * Gets SomeCoolService
 *
 * @return \Namespace\To\SomeCoolService
 */
protected function getSomeCoolService()
{
    return $this->get('some_cool_service');
}

我不喜欢 /*var ... */，因为它在代码中包含了太多内容。
我不喜欢私有属性，因为您可能会错误地认为服务已经加载。

Answer 4

我使用 Komodo Studio，并使用 @var 标记变量，即使在方法内部，也可以为我保留自动完成功能。

namespace MyProject\MyBundle\Controller;

use Symfony\Component\DependencyInjection\ContainerAware;
use Symfony\Component\HttpFoundation\Request;

class WelcomeController extends ContainerAware
{
    public function indexAction()
    {
        /*@var Request*/$request = $this->container->get('request');
        $request->[autocomplete hint list appears here]
    }
}

Answer 5

使用 netbeans IDE 7.1.2 PHP