Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Proper DQL escaping for LIKE queries with Doctrine2
<?php
namespace Foo;
/**
* Methods for safe LIKE querying.
*/
trait LikeQueryHelpers
{
/**
* Format a value that can be used as a parameter for a DQL LIKE search.
*
* $qb->where('u.name LIKE (:name) ESCAPE \'!\'')
* ->setParameter('name', $this->makeLikeParam('john'))
*
* You MUST manually specify the `ESCAPE '!' in your DQL query.
*
* Using the $pattern argument you can change the LIKE pattern your query
* matches again. Default is "%search%". Remember that "%%" in a sprintf
* pattern is an escaped "%".
*
* Common usage:
*
* ->makeLikeParam('foo') == "%foo%"
* ->makeLikeParam('foo', '%s%%') == "foo%"
* ->makeLikeParam('foo', '%s_') == "foo_"
* ->makeLikeParam('foo', '%%%s') == "%foo"
* ->makeLikeParam('foo', '_%s') == "_foo"
*
* Escapes LIKE wildcards using '!' character:
*
* ->makeLikeParam('foo_bar') == "%foo!_bar%"
*
* @param string $search Text to search for LIKE
* @param string $pattern sprintf-compatible substitution pattern
* @return string
*/
protected function makeLikeParam($search, $pattern = '%%%s%%')
{
/**
* Function defined in-line so it doesn't show up for type-hinting on
* classes that implement this trait.
*
* Makes a string safe for use in an SQL LIKE search query by escaping all
* special characters with special meaning when used in a LIKE query.
*
* Uses ! character as default escape character because \ character in
* Doctrine/DQL had trouble accepting it as a single \ and instead kept
* trying to escape it as "\\". Resulted in DQL parse errors about "Escape
* character must be 1 character"
*
* % = match 0 or more characters
* _ = match 1 character
*
* Examples:
* gloves_pink becomes gloves_pink
* gloves%pink becomes gloves!%pink
* glo_ves%pink becomes glo!_ves!%pink
*
* @param string $search
* @return string
*/
$sanitizeLikeValue = function ($search) {
$escapeChar = '!';
$escape = array(
'\\' . $escapeChar, // Must escape the escape-character for regex
'\%',
'\_',
);
$pattern = sprintf('/([%s])/', implode('', $escape));
return preg_replace($pattern, $escapeChar . '$0', $search);
};
return sprintf($pattern, $sanitizeLikeValue($search));
}
}
<?php
namespace Foo\Entity;
use Doctrine\ORM\EntityRepository;
use Foo\LikeQueryHelpers;
class ProductRepository extends EntityRepository
{
use LikeQueryHelpers;
/**
* Find Product entities containing searched terms
*
* @param string $term
* @return Product[]
*/
public function findInSearchableFields($term)
{
return $this->createQueryBuilder('p')
->where('p.title LIKE :title ESCAPE \'!\'')
->setParameter('title', $this->makeLikeParam($term))
->getQuery()
->execute();
}
}
@johnkary

This comment has been minimized.

Copy link

@johnkary johnkary commented Aug 5, 2014

Just noticed you had fixed the quote issue around the ! character. I have updated my original.

I ran into this same issue because a teammate had tried to use this exactly as I had documented it (which previously used double-quotes instead of single-quotes) and was throwing a Doctrine parser error:

[Syntax Error] line 0, col 127: Error: Expected Doctrine\ORM\Query\Lexer::T_STRING, got '"'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment