vendor/doctrine/doctrine-bundle/src/Twig/DoctrineExtension.php line 42

  1. <?php
  3. namespace Doctrine\Bundle\DoctrineBundle\Twig;
  5. use Doctrine\SqlFormatter\HtmlHighlighter;
  6. use Doctrine\SqlFormatter\NullHighlighter;
  7. use Doctrine\SqlFormatter\SqlFormatter;
  8. use Symfony\Component\VarDumper\Cloner\Data;
  9. use Twig\Extension\AbstractExtension;
  10. use Twig\TwigFilter;
  12. use function addslashes;
  13. use function array_key_exists;
  14. use function bin2hex;
  15. use function implode;
  16. use function is_array;
  17. use function is_bool;
  18. use function is_object;
  19. use function is_string;
  20. use function method_exists;
  21. use function preg_match;
  22. use function preg_replace_callback;
  23. use function sprintf;
  24. use function strtoupper;
  25. use function substr;
  26. use function trigger_deprecation;
  28. /**
  29.  * This class contains the needed functions in order to do the query highlighting
  30.  *
  31.  * @internal since 2.11
  32.  */
  33. class DoctrineExtension extends AbstractExtension
  34. {
  35.     private SqlFormatter $sqlFormatter;
  37.     /**
  38.      * Define our functions
  39.      *
  40.      * @return TwigFilter[]
  41.      */
  42.     public function getFilters()
  43.     {
  44.         return [
  45.             new TwigFilter('doctrine_pretty_query', [$this, 'formatQuery'], ['is_safe' => ['html'], 'deprecated' => true]),
  46.             new TwigFilter('doctrine_prettify_sql', [$this, 'prettifySql'], ['is_safe' => ['html']]),
  47.             new TwigFilter('doctrine_format_sql', [$this, 'formatSql'], ['is_safe' => ['html']]),
  48.             new TwigFilter('doctrine_replace_query_parameters', [$this, 'replaceQueryParameters']),
  49.         ];
  50.     }
  52.     /**
  53.      * Escape parameters of a SQL query
  54.      * DON'T USE THIS FUNCTION OUTSIDE ITS INTENDED SCOPE
  55.      *
  56.      * @internal
  57.      *
  58.      * @param mixed $parameter
  59.      *
  60.      * @return string
  61.      */
  62.     public static function escapeFunction($parameter)
  63.     {
  64.         $result = $parameter;
  66.         switch (true) {
  67.             // Check if result is non-unicode string using PCRE_UTF8 modifier
  68.             case is_string($result) && ! preg_match('//u', $result):
  69.                 $result = '0x' . strtoupper(bin2hex($result));
  70.                 break;
  72.             case is_string($result):
  73.                 $result = "'" . addslashes($result) . "'";
  74.                 break;
  76.             case is_array($result):
  77.                 foreach ($result as &$value) {
  78.                     $value = static::escapeFunction($value);
  79.                 }
  81.                 $result = implode(', ', $result) ?: 'NULL';
  82.                 break;
  84.             case is_object($result) && method_exists($result, '__toString'):
  85.                 $result = addslashes($result->__toString());
  86.                 break;
  88.             case $result === null:
  89.                 $result = 'NULL';
  90.                 break;
  92.             case is_bool($result):
  93.                 $result = $result ? '1' : '0';
  94.                 break;
  95.         }
  97.         return $result;
  98.     }
  100.     /**
  101.      * Return a query with the parameters replaced
  102.      *
  103.      * @param string       $query
  104.      * @param mixed[]|Data $parameters
  105.      *
  106.      * @return string
  107.      */
  108.     public function replaceQueryParameters($query, $parameters)
  109.     {
  110.         if ($parameters instanceof Data) {
  111.             $parameters = $parameters->getValue(true);
  112.         }
  114.         $i = 0;
  116.         if (! array_key_exists(0, $parameters) && array_key_exists(1, $parameters)) {
  117.             $i = 1;
  118.         }
  120.         return preg_replace_callback(
  121.             '/\?|((?<!:):[a-z0-9_]+)/i',
  122.             static function ($matches) use ($parameters, &$i) {
  123.                 $key = substr($matches[0], 1);
  125.                 if (! array_key_exists($i, $parameters) && ($key === false || ! array_key_exists($key, $parameters))) {
  126.                     return $matches[0];
  127.                 }
  129.                 $value  = array_key_exists($i, $parameters) ? $parameters[$i] : $parameters[$key];
  130.                 $result = DoctrineExtension::escapeFunction($value);
  131.                 $i++;
  133.                 return $result;
  134.             },
  135.             $query,
  136.         );
  137.     }
  139.     /**
  140.      * Formats and/or highlights the given SQL statement.
  141.      *
  142.      * @param  string $sql
  143.      * @param  bool   $highlightOnly If true the query is not formatted, just highlighted
  144.      *
  145.      * @return string
  146.      */
  147.     public function formatQuery($sql, $highlightOnly = false)
  148.     {
  149.         trigger_deprecation(
  150.             'doctrine/doctrine-bundle',
  151.             '2.1',
  152.             'The "%s()" method is deprecated and will be removed in doctrine-bundle 3.0.',
  153.             __METHOD__,
  154.         );
  156.         $this->setUpSqlFormatter(true, true);
  158.         if ($highlightOnly) {
  159.             return $this->sqlFormatter->highlight($sql);
  160.         }
  162.         return sprintf(
  163.             '<div class="highlight highlight-sql"><pre>%s</pre></div>',
  164.             $this->sqlFormatter->format($sql),
  165.         );
  166.     }
  168.     public function prettifySql(string $sql): string
  169.     {
  170.         $this->setUpSqlFormatter();
  172.         return $this->sqlFormatter->highlight($sql);
  173.     }
  175.     public function formatSql(string $sql, bool $highlight): string
  176.     {
  177.         $this->setUpSqlFormatter($highlight);
  179.         return $this->sqlFormatter->format($sql);
  180.     }
  182.     private function setUpSqlFormatter(bool $highlight = true, bool $legacy = false): void
  183.     {
  184.         $this->sqlFormatter = new SqlFormatter($highlight ? new HtmlHighlighter([
  185.             HtmlHighlighter::HIGHLIGHT_PRE            => 'class="highlight highlight-sql"',
  186.             HtmlHighlighter::HIGHLIGHT_QUOTE          => 'class="string"',
  187.             HtmlHighlighter::HIGHLIGHT_BACKTICK_QUOTE => 'class="string"',
  188.             HtmlHighlighter::HIGHLIGHT_RESERVED       => 'class="keyword"',
  189.             HtmlHighlighter::HIGHLIGHT_BOUNDARY       => 'class="symbol"',
  190.             HtmlHighlighter::HIGHLIGHT_NUMBER         => 'class="number"',
  191.             HtmlHighlighter::HIGHLIGHT_WORD           => 'class="word"',
  192.             HtmlHighlighter::HIGHLIGHT_ERROR          => 'class="error"',
  193.             HtmlHighlighter::HIGHLIGHT_COMMENT        => 'class="comment"',
  194.             HtmlHighlighter::HIGHLIGHT_VARIABLE       => 'class="variable"',
  195.         ], ! $legacy) : new NullHighlighter());
  196.     }
  197. }