Download the PHP package zk2/human-to-tsquery without Composer
On this page you can find all versions of the php package zk2/human-to-tsquery. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zk2/human-to-tsquery
More information about zk2/human-to-tsquery
Files in zk2/human-to-tsquery
Package human-to-tsquery
Short Description Convert human request to postgres ts_query
License MIT
Homepage https://github.com/zk2/human-to-tsquery
Informations about the package human-to-tsquery
zk2\human-to-tsquery
Human query to ts_query for PostgreSQL full text search (https://www.postgresql.org/docs/12/textsearch.html). Provides a clement parser and associated tools for a convert human query to query which can be used ih Postgres Full Text Search. Lenient in that is will produce a parse tree for any input, given a default operator and by generally ignoring any unparsable syntax.
The query language supports the following features at a high level:
-
Boolean operators: AND (infix), OR (infix), "-" (prefix) with an implied default operator and precedence rules, e.g. "boy OR girl -infant"
-
Proximity Near Operator (Nx) -
television N2 violence
- Finds words within x number of words from each other, regardless of the order in which they occur. -
Proximity Within Operator (Wx) -
Franklin W2 Roosevelt
- Finds words within x number of words from each other, in the order they are entered in the search. -
Optional parenthesis for explicitly denoting precedence.
- Quoted phrases (for proximity matching)
Documentation
// Some function, which getting SQL query and return single string result
$closure = function (string $sql) use ($connection) {
return $connection->fetchOne($sql);
};
$humanToTsQuery = new HumanToTsQuery('Opel AND (auto car (patrol OR diesel OR "electric car") AND -sale)');
$tsQuery = $humanToTsQuery->getQuery($closure);
var_dump($tsQuery); // "opel & (auto & car & (patrol | diesel | (electr <-> car)) & !sale)"
$humanToTsQuery = new HumanToTsQuery('indigenous N2 ("debt financing" OR lalala) AND ("New York" OR Boston)');
$tsQuery = $humanToTsQuery->getQuery($closure);
var_dump($tsQuery); // "(indigen <2> ((debt <-> financ) | lalala ) | ((debt <-> financ) | lalala ) <2> indigen | indigen <1> ((debt <-> financ) | lalala ) | ((debt <-> financ) | lalala ) <1> indigen) & ((new <-> york) | boston )"
$humanToTsQuery = new HumanToTsQuery('(indigenous OR texas) W2 ("debt financing" OR lalala) AND ("New York" OR Boston)');
$tsQuery = $humanToTsQuery->getQuery($closure);
var_dump($tsQuery); // "((indigen | texa ) <2> ((debt <-> financ) | lalala ) | (indigen | texa ) <1> ((debt <-> financ) | lalala )) & ((new <-> york) | boston )"
Running the Tests
Install the Composer dev
dependencies:
composer install --dev
Then, run the test suite using PHPUnit:
vendor/bin/phpunit
License
This bundle is released under the MIT license. See the complete license in the bundle:
LICENSE