Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onroerenderfgoed/lukas
A PHP Search Query Parser
https://github.com/onroerenderfgoed/lukas
Last synced: about 5 hours ago
JSON representation
A PHP Search Query Parser
- Host: GitHub
- URL: https://github.com/onroerenderfgoed/lukas
- Owner: OnroerendErfgoed
- License: mit
- Created: 2012-08-07T14:28:28.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-11-26T15:58:09.000Z (almost 9 years ago)
- Last Synced: 2024-10-29T23:19:22.893Z (20 days ago)
- Language: PHP
- Size: 141 KB
- Stars: 25
- Watchers: 11
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Lukas - Search Query Handler
============================
Lukas is a library that helps in implementing a custom search query language.
It offers some standard features users have come to expect from text driven search
like boolean operators and subexpressions.
Lukas can also help you implement custom behaviour for certain keywords, you
might for eg. define that keyword "photo" to mean "search for things that have a
photo".
Unit Tests
----------
[](http://travis-ci.org/OnroerendErfgoed/Lukas)
Query Syntax
------------
The Lukas query parser supports a fairly universal search query standard. It is
meant to support the most common search combinations while be fairly simple to
use by non-technical users.
It supports the following features:
* Keywords are split on whitespace, eg. _Lukas me_ contains two keywords.
* Keywords can be grouped using quotation marks, eg. _"Lukas me"_ only contains
one keyword.
* Keywords can be combined using boolean and, eg. _Lukas AND me_. This is also
the default combination, so _Lukas me_ is the same as _Lukas AND me_.
* Keywords can be combined using boolean or, eg. _Lukas OR me_.
* Keywords can be negated using boolean, written as _-keyword_, eg. _-Lukas_.
* Combinational logic can be specified using parentheses, eg. _Lukas OR (me AND you)_.
* A keyword can be explicitely marked as belonging to a certain domain,
eg. _people:Lukas_.
Installation
------------
Lukas can be installed from [packagist](http://packagist.org) through
[composer](http://getcomposer.org). Add a file called *composer.json*
that contains the following:
```json
{
"require": {
"oe/lukas": "dev-master"
}
}
```
Please bear in mind that Lukas is still in active development. Installing
"dev-master" means you are running from trunk. As soon as we hit a stable version
it would be best to change "dev-master" to eg. "0.1.0"
Download and install composer:
```
curl -s http://getcomposer.org/installer | php
```
Install Lukas:
```
php composer.phar install
```
Examples
--------
The examples folder contains some samples of what can be parsed and how a certain
string will be parsed.
Contributing
------------
All contributions are welcome. Please fork the repository and send us a pull
request. If at all possible include unit tests in the pull request.
To run the unit tests, first download and install composer:
```
curl -s http://getcomposer.org/installer | php
```
Create the autoloader:
```
php composer.phar install
```
Run the unit tests:
```
phpunit
```
Out of the box this will print code coverage information to the commandline.
Although this is usefull and tells us how much coverage each class has, it does
not show what parts of a class are covered or not. To see that kind of information,
please run phpunit like this:
```
phpunit --coverage-html build/coverage/html
```