Symfony |如何从控制器中的存储库访问自定义方法？

Question

我正在建立一个清单来练习使用Symfony构建Web应用程序。它的工作原理是将一个字符串输入一个表单并按下一个提交按钮。输入存储在数据库中。

我想将存储在数据库中的输入返回到网页。

目前，输入存储在数据库中，我已经在我的存储库中编写了一个DQL查询函数。

我的问题是我无法访问我在控制器中创建的方法。

我的存储库中的方法：

    /**
     * @return Checklist[]
     */
    public function getAllItemsForChecklist(): array
    {
        $qb = $this->createQueryBuilder('c')
            ->select('item')
            ->from('checklist', 'x') 
            ->getQuery()
        ;

        return $qb->execute();
    }

尝试访问控制器中的方法的行（失败）：

$items = $this->getDoctrine()
    ->getRepository(ChecklistRepository::class)
    ->getAllItemsForChecklist()
;

根据https://symfony.com/doc/master/doctrine.html#querying-for-objects-the-repository的Symfony文档，这应该有效。但是，找不到方法“getAllItemsForChecklist（）。我的IDE上给出了以下消息：

在\ Doctrine \ Common \ Persistence \ ObjectRepository中找不到方法'getAllItemsForChecklist'

我不确定为什么它不读取我指定的存储库类。

如果有人知道如何解决这个问题，那么它将找到我在我的存储库中制作的方法，我将不胜感激。

如果需要任何额外信息，请告诉我，我很乐意提供更多信息。

问候，

史蒂夫

Answer 1

欢迎来到StackOverflow！

首先，当你调用getRepository()时，你必须传递实体类，而不是存储库本身，所以它会是这样的：

$this->getDoctrine()->getRepository(Checklist::class);

即使您这样做，您的IDE也不会知道该方法存在。您的IDE实际上是错误的，该方法确实存在，您的IDE无法知道从getRepository()调用返回的对象。

怎么避免呢？选择其中一个解决方案（所有这些解决方案都适用于PhpStorm，选项1应该适用于所有现代IDE，选项2可能适用于所有现代IDE，我不知道其他IDE中的选项3支持）：

选项1：将其作为服务注入

public function myControllerRoute(ChecklistRepository $checklistRepository) {
    // now your IDE knows what methods are inside the $checklistRepository
    $items = $checklistRepository->getAllItemsForChecklist();
}

选项2：将它键入IDE（和其他开发人员）

public function myControllerRoute() {
    /** @var ChecklistRepository $checklistRepository */
    $checklistRepository = $this->getDoctrine()->getRepository(Checklist::class);

    // after the typehint the IDE knows what type it is
    $items = $checklistRepository->getAllItemsForChecklist();
}

选项3：使用断言

public function myControllerRoute() {
    $checklistRepository = $this->getDoctrine()->getRepository(Checklist::class);
    assert($checklistRepository instanceof ChecklistRepository);

    // after the assert the IDE knows what type it is
    $items = $checklistRepository->getAllItemsForChecklist();
}

选项2和3几乎相同，但选项3有额外的好处，如果$checklistRepository不是ChecklistRepository的实例，在开发机器上它将抛出异常，在生产环境中assert()调用被忽略并且不会减慢执行速度。