Doctrine QueryBuilder — это мощный инструмент в экосистеме PHP, который позволяет разработчикам создавать и выполнять запросы к базе данных, используя объектно-ориентированный подход. Одним из распространенных вариантов использования является динамическое создание запросов SQL и печать полученного кода SQL для целей отладки или анализа. В этой статье мы рассмотрим несколько методов достижения этой цели, а также приведем примеры кода.

1. Использование метода getSQL():
   Самый простой способ распечатать SQL-запрос из экземпляра Doctrine QueryBuilder — использовать метод getSQL(). Этот метод возвращает строку SQL, представляющую запрос, не выполняя его. Вот пример:

$queryBuilder = $entityManager->createQueryBuilder();
$queryBuilder
    ->select('u')
    ->from('User', 'u')
    ->where('u.id = :userId')
    ->setParameter('userId', 1);
$sql = $queryBuilder->getSQL();
echo $sql;

2. Отладка с помощью EnableSqlLogger():
   Класс конфигурации Doctrine предоставляет метод под названием setSQLLogger(), который позволяет включить средство ведения журнала для записи всех выполненных SQL-запросов. Внедрив собственный регистратор, вы можете легко захватывать и распечатывать SQL-запросы. Вот пример:

use Doctrine\DBAL\Logging\SQLLogger;
class CustomLogger implements SQLLogger
{
    public function startQuery($sql, array $params = null, array $types = null)
    {
        echo $sql . PHP_EOL;
    }
    public function stopQuery()
    {
    }
}
$configuration = $entityManager->getConfiguration();
$configuration->setSQLLogger(new CustomLogger());
$queryBuilder = $entityManager->createQueryBuilder();
$queryBuilder
    ->select('u')
    ->from('User', 'u')
    ->where('u.id = :userId')
    ->setParameter('userId', 1);
$queryBuilder->getQuery()->getResult();

3. Использование событий Doctrine:
   Doctrine предоставляет события, к которым вы можете подключиться в процессе выполнения запроса. Прослушивая событие "postLoad", вы можете получить доступ к выполненному SQL-запросу и распечатать его. Вот пример:

use Doctrine\Common\EventSubscriber;
use Doctrine\ORM\Event\LifecycleEventArgs;
class CustomSubscriber implements EventSubscriber
{
    public function getSubscribedEvents()
    {
        return ['postLoad'];
    }
    public function postLoad(LifecycleEventArgs $args)
    {
        $sql = $args->getEntityManager()->getConnection()->getConfiguration()->getSQLLogger()->queries[0]['sql'];
        echo $sql . PHP_EOL;
    }
}
$entityManager->getEventManager()->addEventSubscriber(new CustomSubscriber());
$queryBuilder = $entityManager->createQueryBuilder();
$queryBuilder
    ->select('u')
    ->from('User', 'u')
    ->where('u.id = :userId')
    ->setParameter('userId', 1);
$queryBuilder->getQuery()->getResult();

Распечатка SQL-запросов, созданных Doctrine QueryBuilder, необходима для отладки и понимания основных операций базы данных. В этой статье мы рассмотрели три различных метода достижения этой цели: использование метода getSQL(), включение специального средства ведения журнала SQL и использование событий Doctrine. Используя эти методы, разработчики могут получить более глубокое понимание взаимодействия с базой данных своего приложения и эффективно оптимизировать запросы.