├── demo
    ├── demo.gif
    ├── server.php
    └── index.php
├── src
    ├── Query
    │   ├── Visitors
    │   │   ├── LikeVisitor.php
    │   │   ├── LogicOperatorVisitor.php
    │   │   ├── EqVisitor.php
    │   │   ├── GtVisitor.php
    │   │   ├── LtVisitor.php
    │   │   ├── GteVisitor.php
    │   │   ├── LteVisitor.php
    │   │   ├── NotEqVisitor.php
    │   │   ├── BaseVisitor.php
    │   │   ├── CtVisitor.php
    │   │   ├── EwVisitor.php
    │   │   ├── SwVisitor.php
    │   │   ├── GroupVisitor.php
    │   │   ├── OrVisitor.php
    │   │   ├── NullVisitor.php
    │   │   ├── NotNullVisitor.php
    │   │   ├── AndVisitor.php
    │   │   ├── InVisitor.php
    │   │   ├── NotInVisitor.php
    │   │   ├── KeyVisitor.php
    │   │   └── BaseOperatorVisitor.php
    │   ├── Functions
    │   │   ├── SumFunction.php
    │   │   ├── ConcatFunction.php
    │   │   ├── DateFormatFunction.php
    │   │   └── BaseFunction.php
    │   └── Builder.php
    ├── Exceptions
    │   └── FilterSyntaxException.php
    └── Filter.php
├── .gitignore
├── phpstan.neon
├── tests
    ├── Foo.php
    └── FilterTest.php
├── composer.json
├── phpunit.xml.dist
├── .github
    └── workflows
    │   ├── style.yml
    │   ├── quality.yml
    │   └── test.yml
├── LICENSE
└── README.md


/demo/demo.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/railken/lara-eye/HEAD/demo/demo.gif


--------------------------------------------------------------------------------
/src/Query/Visitors/LikeVisitor.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace Railken\LaraEye\Query\Visitors;
4 | 
5 | class LikeVisitor extends BaseOperatorVisitor
6 | {
7 | }
8 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/LogicOperatorVisitor.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace Railken\LaraEye\Query\Visitors;
4 | 
5 | class LogicOperatorVisitor extends BaseVisitor
6 | {
7 | }
8 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | vendor/
 2 | \.php_cs\.cache
 3 | build/
 4 | \.env
 5 | composer\.lock
 6 | .phpunit.result.cache
 7 | phpunit.xml
 8 | .php-cs-fixer.cache
 9 | .phpunit.cache/test-results
10 | 


--------------------------------------------------------------------------------
/phpstan.neon:
--------------------------------------------------------------------------------
1 | parameters:
2 | 	reportUnmatchedIgnoredErrors: false
3 | 	ignoreErrors:
4 | 		- '#Call to an undefined static method Illuminate\\Support\\Facades\\([a-zA-Z0-9_]+)::([a-zA-Z0-9_]+)\(\)#'


--------------------------------------------------------------------------------
/src/Exceptions/FilterSyntaxException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | class FilterSyntaxException extends Exception
 8 | {
 9 |     public function __construct(string $filter, string $error)
10 |     {
11 |         parent::__construct(sprintf("Error `%s`, in query `%s`", $error, $filter));
12 |     }
13 | }
14 | 


--------------------------------------------------------------------------------
/tests/Foo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Tests;
 4 | 
 5 | use Illuminate\Database\Eloquent\Model;
 6 | 
 7 | class Foo extends Model
 8 | {
 9 |     /**
10 |      * The table associated with the model.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $table = 'foo';
15 | 
16 |     /**
17 |      * The attributes that are mass assignable.
18 |      *
19 |      * @var array
20 |      */
21 |     protected $fillable = [
22 |         'x', 'y', 'z',
23 |     ];
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/EqVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class EqVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\EqNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = '=';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/GtVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class GtVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\GtNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = '>';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/LtVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class LtVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\LtNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = '<';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Query/Functions/SumFunction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Functions;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class SumFunction extends BaseFunction
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\SumFunctionNode::class;
15 | 
16 |     /**
17 |      * The string function for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $name = 'SUM';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/GteVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class GteVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\GteNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = '>=';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/LteVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class LteVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\LteNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = '<=';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/NotEqVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class NotEqVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\NotEqNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = '!=';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Query/Functions/ConcatFunction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Functions;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class ConcatFunction extends BaseFunction
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\ConcatFunctionNode::class;
15 | 
16 |     /**
17 |      * The string function for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $name = 'CONCAT';
22 | }
23 | 


--------------------------------------------------------------------------------
/src/Query/Functions/DateFormatFunction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Functions;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class DateFormatFunction extends BaseFunction
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\DateFormatFunctionNode::class;
15 | 
16 |     /**
17 |      * The string function for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $name = 'DATE_FORMAT';
22 | }
23 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "railken/lara-eye",
 3 |     "keywords": ["api"],
 4 |     "license": "MIT",
 5 |     "require": {
 6 |         "php": ">=8.1",
 7 |         "railken/bag": "^2.0",
 8 |         "illuminate/database": "9.* || 10.*",
 9 |         "railken/search-query": "3.*"
10 |     },
11 |     "require-dev": {
12 |         "orchestra/testbench": "*",
13 |         "friendsofphp/php-cs-fixer": "^3.52"
14 |     },
15 |     "autoload": {
16 |         "psr-4" : {
17 |             "Railken\\LaraEye\\" : "src/"
18 |         }
19 |     },
20 |     "autoload-dev": {
21 |         "psr-4": { 
22 |             "Railken\\LaraEye\\Tests\\": "tests/" 
23 |         }
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/src/Query/Functions/BaseFunction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Functions;
 4 | 
 5 | abstract class BaseFunction
 6 | {
 7 |     /**
 8 |      * The node that will trigger the visitor.
 9 |      *
10 |      * @var string
11 |      */
12 |     protected $node;
13 | 
14 |     /**
15 |      * The string function for the query.
16 |      *
17 |      * @var string
18 |      */
19 |     protected $name;
20 | 
21 |     /**
22 |      * @return string
23 |      */
24 |     public function getNode()
25 |     {
26 |         return $this->node;
27 |     }
28 | 
29 |     /**
30 |      * @return string
31 |      */
32 |     public function getName()
33 |     {
34 |         return $this->name;
35 |     }
36 | }
37 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/BaseVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\LaraEye\Query\Builder;
 6 | 
 7 | class BaseVisitor
 8 | {
 9 |     /**
10 |      * @var \Railken\LaraEye\Query\Builder
11 |      */
12 |     protected $builder;
13 | 
14 |     /**
15 |      * Construct.
16 |      *
17 |      * @param \Railken\LaraEye\Query\Builder $builder
18 |      */
19 |     public function __construct(Builder $builder)
20 |     {
21 |         $this->builder = $builder;
22 |     }
23 | 
24 |     /**
25 |      * Get builder.
26 |      *
27 |      * @return \Railken\LaraEye\Query\Builder
28 |      */
29 |     public function getBuilder()
30 |     {
31 |         return $this->builder;
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/CtVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class CtVisitor extends LikeVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\CtNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = 'like';
22 | 
23 |     /**
24 |      * Parse the value before putting in the query.
25 |      *
26 |      * @param string $value
27 |      *
28 |      * @return string
29 |      */
30 |     public function parseValue($value)
31 |     {
32 |         return '%'.$value.'%';
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
 3 |     <testsuites>
 4 |         <testsuite name="Application Test Suite">
 5 |             <directory suffix="Test.php">./tests</directory>
 6 |         </testsuite>
 7 |     </testsuites>
 8 |     <source>
 9 |         <include>
10 |           <directory suffix=".php">./src</directory>
11 |         </include>
12 |     </source>
13 |     <php>
14 |         <env name="APP_ENV" value="testing"/>
15 |     </php>
16 | </phpunit>
17 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/EwVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class EwVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\EwNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = 'like';
22 | 
23 |     /**
24 |      * Parse the value before putting in the query.
25 |      *
26 |      * @param string $value
27 |      *
28 |      * @return string
29 |      */
30 |     public function parseValue($value)
31 |     {
32 |         return '%'.$value;
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/SwVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class SwVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\SwNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = 'like';
22 | 
23 |     /**
24 |      * Parse the value before putting in the query.
25 |      *
26 |      * @param string $value
27 |      *
28 |      * @return string
29 |      */
30 |     public function parseValue($value)
31 |     {
32 |         return $value.'%';
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/.github/workflows/style.yml:
--------------------------------------------------------------------------------
 1 | name: Style
 2 | on: 
 3 |   pull_request:
 4 |     paths:
 5 |       - '**.php'
 6 |   push:
 7 |     paths:
 8 |       - '**.php'
 9 | jobs:
10 |   style:
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - name: Checkout
14 |         uses: actions/checkout@v2
15 |         
16 |       - name: Install Composer dependencies
17 |         run: |
18 |           composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
19 |           composer require --dev friendsofphp/php-cs-fixer
20 | 
21 |       - name: Run fix:style
22 |         run: |
23 |           export PATH="$HOME/.composer/vendor/bin:$PATH"
24 |           ./vendor/bin/php-cs-fixer fix src
25 |           ./vendor/bin/php-cs-fixer fix tests
26 | 
27 |       - uses: stefanzweifel/git-auto-commit-action@v2.1.0
28 |         with:
29 |           commit_message: Apply style changes
30 |           branch: ${{ github.ref }}
31 |         env:
32 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/GroupVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Contracts\NodeContract;
 6 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 7 | 
 8 | class GroupVisitor extends BaseVisitor
 9 | {
10 |     /**
11 |      * Visit the node and update the query.
12 |      *
13 |      * @param mixed                              $query
14 |      * @param \Railken\SQ\Contracts\NodeContract $node
15 |      * @param string                             $context
16 |      */
17 |     public function visit($query, NodeContract $node, string $context)
18 |     {
19 |         if ($node instanceof Nodes\GroupNode) {
20 |             $callback = function ($q) use ($node, $context) {
21 |                 foreach ($node->getChildren() as $child) {
22 |                     $this->getBuilder()->build($q, $child, $context);
23 |                 }
24 |             };
25 | 
26 |             $context === Nodes\OrNode::class && $query->orWhere($callback);
27 |             $context === Nodes\AndNode::class && $query->where($callback);
28 |         }
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/OrVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Contracts\NodeContract;
 6 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 7 | 
 8 | class OrVisitor extends LogicOperatorVisitor
 9 | {
10 |     /**
11 |      * Visit the node and update the query.
12 |      *
13 |      * @param mixed                              $query
14 |      * @param \Railken\SQ\Contracts\NodeContract $node
15 |      * @param string                             $context
16 |      */
17 |     public function visit($query, NodeContract $node, string $context)
18 |     {
19 |         if ($node instanceof Nodes\OrNode) {
20 |             $callback = function ($q) use ($node) {
21 |                 foreach ($node->getChildren() as $child) {
22 |                     $this->getBuilder()->build($q, $child, Nodes\OrNode::class);
23 |                 }
24 |             };
25 | 
26 |             $context === Nodes\OrNode::class && $query->orWhere($callback);
27 |             $context === Nodes\AndNode::class && $query->where($callback);
28 |         }
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/demo/server.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $autoload = __DIR__.'/../vendor/autoload.php';
 4 | if (!file_exists($autoload)) {
 5 |     throw new RuntimeException('Install dependencies using composer to run the demo.');
 6 | }
 7 | 
 8 | require_once $autoload;
 9 | 
10 | class FilterTest extends \Orchestra\Testbench\TestCase
11 | {
12 |     /**
13 |      * Setup the test environment.
14 |      */
15 |     public function setUp()
16 |     {
17 |         $dotenv = new \Dotenv\Dotenv(__DIR__.'/..', '.env');
18 |         $dotenv->load();
19 |         parent::setUp();
20 |     }
21 | }
22 | 
23 | $t = new FilterTest();
24 | $t->setUp();
25 | 
26 | use Railken\LaraEye\Filter;
27 | use Railken\LaraEye\Tests\Foo;
28 | 
29 | $filter = new Filter("foo", ['*']);
30 | 
31 | $query = \Illuminate\Support\Facades\DB::table('foo');
32 | 
33 | try {
34 |     $result = $filter->build($query, $_GET['q']);
35 | } catch (\Exception $e) {
36 |     http_response_code(400);
37 |     echo json_encode((object) ['message' => $e->getMessage()]);
38 |     die();
39 | }
40 | 
41 | echo json_encode((object) ['query' => ['sql' => $query->toSql(), 'params' => $query->getBindings()]]);
42 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2017 
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/.github/workflows/quality.yml:
--------------------------------------------------------------------------------
 1 | name: Quality
 2 | on: 
 3 |   pull_request:
 4 |     paths:
 5 |       - '**.php'
 6 |   push:
 7 |     paths:
 8 |       - '**.php'
 9 | jobs:
10 |   quality:
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - name: Checkout
14 |         uses: actions/checkout@v1
15 |       - name: Setup PHP, with composer and extensions
16 |         uses: shivammathur/setup-php@master #https://github.com/shivammathur/setup-php
17 |         with:
18 |           php-version: 8.3
19 |           extension-csv: mbstring, dom, fileinfo, mysql, zip
20 |           coverage: xdebug #optional
21 |       - name: Get composer cache directory
22 |         id: composer-cache
23 |         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
24 |       - name: Install Composer dependencies
25 |         run: |
26 |             composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
27 |             composer require --dev phpstan/phpstan
28 |       - name: Test Quality
29 |         run: |
30 |           export PATH="$HOME/.composer/vendor/bin:$PATH"
31 |           ./vendor/bin/phpstan analyse --level=0 src
32 |           ./vendor/bin/phpstan analyse --level=0 tests
33 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/NullVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class NullVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\NullNode::class;
15 | 
16 |     /**
17 |      * Visit the node and update the query.
18 |      *
19 |      * @param mixed                              $query
20 |      * @param \Railken\SQ\Contracts\NodeContract $node
21 |      * @param string                             $context
22 |      */
23 |     public function visit($query, $node, string $context)
24 |     {
25 |         if ($node instanceof $this->node) {
26 |             $bindings = [];
27 |             $sql = [];
28 | 
29 |             $child0 = $node->getChildByIndex(0);
30 | 
31 |             if ($child0 instanceof Nodes\KeyNode) {
32 |                 $context === Nodes\OrNode::class && $query->orWhereNull($this->parseKey($child0->getValue()));
33 |                 $context === Nodes\AndNode::class && $query->whereNull($this->parseKey($child0->getValue()));
34 |             }
35 |         }
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/NotNullVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class NotNullVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\NotNullNode::class;
15 | 
16 |     /**
17 |      * Visit the node and update the query.
18 |      *
19 |      * @param mixed                              $query
20 |      * @param \Railken\SQ\Contracts\NodeContract $node
21 |      * @param string                             $context
22 |      */
23 |     public function visit($query, $node, string $context)
24 |     {
25 |         if ($node instanceof $this->node) {
26 |             $bindings = [];
27 |             $sql = [];
28 | 
29 |             $child0 = $node->getChildByIndex(0);
30 |             $child1 = $node->getChildByIndex(1);
31 | 
32 |             if ($child0 instanceof Nodes\KeyNode) {
33 |                 $context === Nodes\OrNode::class && $query->orWhereNotNull($this->parseKey($child0->getValue()));
34 |                 $context === Nodes\AndNode::class && $query->whereNotNull($this->parseKey($child0->getValue()));
35 |             }
36 |         }
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/AndVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Contracts\NodeContract;
 6 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 7 | 
 8 | class AndVisitor extends LogicOperatorVisitor
 9 | {
10 |     /**
11 |      * Visit the node and update the query.
12 |      *
13 |      * @param mixed                              $query
14 |      * @param \Railken\SQ\Contracts\NodeContract $node
15 |      * @param string                             $context
16 |      */
17 |     public function visit($query, NodeContract $node, string $context)
18 |     {
19 |         if ($node instanceof Nodes\AndNode) {
20 |             $callback = function ($q) use ($node) {
21 |                 foreach ($node->getChildren() as $child) {
22 |                     if ($child instanceof Nodes\KeyNode || $child instanceof Nodes\ValueNode) {
23 |                         throw new \Railken\SQ\Exceptions\QuerySyntaxException('Wrong node detected in a logic comparison. Kes Nodes and Value Nodes cannot be used');
24 |                     }
25 | 
26 |                     $this->getBuilder()->build($q, $child, Nodes\AndNode::class);
27 |                 }
28 |             };
29 | 
30 |             $context === Nodes\OrNode::class && $query->orWhere($callback);
31 |             $context === Nodes\AndNode::class && $query->where($callback);
32 |         }
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/demo/index.php:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 | <head>
 4 | 	<script src="https://unpkg.com/vue"></script>
 5 | 	<script src="https://cdn.jsdelivr.net/npm/vue-resource@1.3.4"></script>
 6 | 	<link href='https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta.2/css/bootstrap.min.css' rel='stylesheet'>
 7 | 	<style>
 8 | 		.container {
 9 | 			max-width: 920px;
10 | 			margin-top: 40px;
11 | 		}
12 | 	</style>
13 | </head>
14 | <body>
15 | <div id="app">
16 | 	<div class='container'>
17 | 		<h3>Filter</h3>
18 | 		<input type='text' v-model='query' class='form-control' placeholder='Type query here' v-bind:class="{'is-invalid': error}">
19 | 		<p class='text-danger'>{{ error }}&nbsp;</p>
20 | 		<pre>{{ result }}</pre>
21 | 	</div>
22 | </div>
23 | 
24 | <script>
25 | var app = new Vue({
26 | 	el: '#app',
27 | 	watch: {
28 | 		query: function (value, old) {
29 | 
30 | 			this.update(value);
31 | 
32 | 		}
33 | 	},
34 | 	methods: {
35 | 		update(value) {
36 | 			this.$http.get('/server.php', {params: {q: value}})
37 | 			.then(response => {
38 | 				this.error = "";
39 | 		  		this.result = response.body.query;
40 | 			}, response => {
41 | 				this.error = response.body.message;
42 | 		  		this.result = '';
43 | 			});
44 | 		}
45 | 	},
46 | 	mounted() {
47 | 		this.update(this.query);
48 | 	},
49 | 	data: {
50 | 		query: 'id eq 1',
51 | 		error: null,
52 | 		result: null
53 | 	}
54 | })
55 | </script>
56 | </body>


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Laravel Eye
 2 | 
 3 | [![Actions Status](https://github.com/railken/lara-eye/workflows/Test/badge.svg)](https://github.com/railken/lara-eye/actions)
 4 | 
 5 | Filter your ```Illuminate\DataBase\Query\Builder``` using a structured query language.
 6 | This can be pretty usefull when you're building an API and you don't want to waste hours of your time creating predefined filters that may change at any time.
 7 | 
 8 | ## Requirements
 9 | 
10 | PHP 8.1 or later.
11 | 
12 | ## Usage
13 | 
14 | ```php
15 | 
16 | use Railken\LaraEye\Filter;
17 | use Railken\SQ\Exceptions\QuerySyntaxException;
18 | use App\Foo;
19 | 
20 | 
21 | // Instance of Illuminate\DataBase\Query\Builder
22 | $query = (new Foo())->newQuery()->getQuery();
23 | 
24 | $str_filter = "x > 5 or y < z";
25 | 
26 | $filter = new Filter("foo", ['id', 'x', 'y', 'z', 'created_at', 'updated_at']);
27 | 
28 | try {
29 |     $filter->build($query, $str_filter);
30 | } catch (QuerySyntaxException $e) {
31 |     // handle syntax error
32 | }
33 | 
34 | 
35 | ```
36 | 
37 | Syntax [here](https://github.com/railken/search-query)
38 | 
39 | ## Composer
40 | 
41 | You can install it via [Composer](https://getcomposer.org/) by typing the following command:
42 | 
43 | ```bash
44 | composer require railken/lara-eye
45 | ```
46 | 
47 | ## Demo
48 | 
49 | ![demo](https://raw.githubusercontent.com/railken/lara-eye/master/demo/demo.gif)
50 | 
51 | ## License
52 | 
53 | Open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).
54 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/InVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class InVisitor extends BaseOperatorVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\InNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = 'IN';
22 | 
23 |     /**
24 |      * Visit the node and update the query.
25 |      *
26 |      * @param mixed                              $query
27 |      * @param \Railken\SQ\Contracts\NodeContract $node
28 |      * @param string                             $context
29 |      */
30 |     public function visit($query, $node, string $context)
31 |     {
32 |         if ($node instanceof $this->node) {
33 |             $column = null;
34 |             $values = null;
35 | 
36 |             if ($node->getChildByIndex(0) instanceof Nodes\KeyNode) {
37 |                 $column = $this->parseKey($node->getChildByIndex(0)->getValue());
38 |             }
39 | 
40 |             if ($node->getChildByIndex(1) instanceof Nodes\GroupNode) {
41 |                 $values = array_map(function ($node) {
42 |                     return $this->parseValue($node->getValue());
43 |                 }, $node->getChildByIndex(1)->getChildren());
44 |             }
45 | 
46 |             if ($column && $values) {
47 |                 $context === Nodes\OrNode::class && $query->orWhereIn($column, $values);
48 |                 $context === Nodes\AndNode::class && $query->whereIn($column, $values);
49 |             }
50 |         }
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/NotInVisitor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query\Visitors;
 4 | 
 5 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 6 | 
 7 | class NotInVisitor extends InVisitor
 8 | {
 9 |     /**
10 |      * The node that will trigger the visitor.
11 |      *
12 |      * @var string
13 |      */
14 |     protected $node = Nodes\NotInNode::class;
15 | 
16 |     /**
17 |      * The string operator for the query.
18 |      *
19 |      * @var string
20 |      */
21 |     protected $operator = 'NOT IN';
22 | 
23 |     /**
24 |      * Visit the node and update the query.
25 |      *
26 |      * @param mixed                              $query
27 |      * @param \Railken\SQ\Contracts\NodeContract $node
28 |      * @param string                             $context
29 |      */
30 |     public function visit($query, $node, string $context)
31 |     {
32 |         if ($node instanceof $this->node) {
33 |             $column = null;
34 |             $values = null;
35 | 
36 |             if ($node->getChildByIndex(0) instanceof Nodes\KeyNode) {
37 |                 $column = $this->parseKey($node->getChildByIndex(0)->getValue());
38 |             }
39 | 
40 |             if ($node->getChildByIndex(1) instanceof Nodes\GroupNode) {
41 |                 $values = array_map(function ($node) {
42 |                     return $this->parseValue($node->getValue());
43 |                 }, $node->getChildByIndex(1)->getChildren());
44 |             }
45 | 
46 |             if ($column && $values) {
47 |                 $context === Nodes\OrNode::class && $query->orWhereNotIn($column, $values);
48 |                 $context === Nodes\AndNode::class && $query->whereNotIn($column, $values);
49 |             }
50 |         }
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/src/Query/Builder.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Railken\LaraEye\Query;
 4 | 
 5 | use Illuminate\Support\Collection;
 6 | use Railken\SQ\Contracts\NodeContract;
 7 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
 8 | 
 9 | class Builder
10 | {
11 |     /**
12 |      * @var string
13 |      */
14 |     protected $context;
15 | 
16 |     /**
17 |      * @var array
18 |      */
19 |     protected $visitors;
20 | 
21 |     /**
22 |      * @var \Illuminate\Support\Collection
23 |      */
24 |     protected $functions;
25 | 
26 |     /**
27 |      * Construct.
28 |      *
29 |      * @var array
30 |      */
31 |     public function __construct()
32 |     {
33 |     }
34 | 
35 |     /**
36 |      * Set visitors.
37 |      *
38 |      * @param array $visitors
39 |      *
40 |      * @return $this
41 |      */
42 |     public function setVisitors($visitors)
43 |     {
44 |         $this->visitors = $visitors;
45 | 
46 |         return $this;
47 |     }
48 | 
49 |     /**
50 |      * Set functions.
51 |      *
52 |      * @param array $functions
53 |      *
54 |      * @return $this
55 |      */
56 |     public function setFunctions($functions)
57 |     {
58 |         $this->functions = new Collection($functions);
59 | 
60 |         return $this;
61 |     }
62 | 
63 |     /**
64 |      * @return Collection
65 |      */
66 |     public function getFunctions()
67 |     {
68 |         return $this->functions;
69 |     }
70 | 
71 |     /**
72 |      * Build the query.
73 |      *
74 |      * @param mixed                              $query
75 |      * @param \Railken\SQ\Contracts\NodeContract $node
76 |      * @param string                             $context
77 |      */
78 |     public function build($query, NodeContract $node, $context = Nodes\AndNode::class)
79 |     {
80 |         foreach ($this->visitors as $visitor) {
81 |             $visitor->visit($query, $node, $context);
82 |         }
83 |     }
84 | }
85 | 


--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
 1 | name: Test
 2 | on: 
 3 |   pull_request:
 4 |     paths:
 5 |       - '**.php' 
 6 |       - '**.yml'
 7 |   push:
 8 |     paths:
 9 |       - '**.php'
10 |       - '**.yml'
11 | jobs:
12 |   laravel:
13 |     name: Laravel ${{ matrix.laravel }} (PHP ${{ matrix.php }})
14 |     runs-on: ubuntu-latest
15 |     env:
16 |       DB_DATABASE: laravel
17 |       DB_USERNAME: root
18 |       DB_PASSWORD: password
19 |       BROADCAST_DRIVER: log 
20 |     services:
21 |       mysql:
22 |         image: mysql:5.7
23 |         env:
24 |           MYSQL_ALLOW_EMPTY_PASSWORD: false
25 |           MYSQL_ROOT_PASSWORD: password
26 |           MYSQL_DATABASE: laravel
27 |         ports:
28 |           - 3306
29 |         options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
30 |       redis:
31 |         image: redis
32 |         ports:
33 |           - 6379/tcp
34 |         options: --health-cmd="redis-cli ping" --health-interval=10s --health-timeout=5s --health-retries=3
35 |     strategy:
36 |       fail-fast: false
37 |       matrix:
38 |         php: ['8.2', '8.3']
39 |         laravel: ['9.*', '10.*']
40 |     steps:
41 |       - name: Checkout
42 |         uses: actions/checkout@v1
43 |       - name: Setup PHP, with composer and extensions
44 |         uses: shivammathur/setup-php@master #https://github.com/shivammathur/setup-php
45 |         with:
46 |           php-version: ${{ matrix.php }}
47 |           extension-csv: mbstring, dom, fileinfo, mysql, zip
48 |           coverage: xdebug #optional
49 |       - name: Get composer cache directory
50 |         id: composer-cache
51 |         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
52 |       - name: Install Composer dependencies
53 |         run: |
54 |           composer require --dev "laravel/framework:${{ matrix.laravel }}" --no-update
55 |           composer update --no-progress --no-suggest --prefer-dist --optimize-autoloader
56 |       - name: Prepare the application
57 |         run: |
58 |           php -r "file_exists('.env') || copy('.env.example', '.env');"
59 |       - name: Test
60 |         run: ./vendor/bin/phpunit --coverage-text --coverage-clover=build/logs/clover.xml
61 |         env:
62 |           DB_PORT: ${{ job.services.mysql.ports['3306'] }}
63 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/KeyVisitor.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Railken\LaraEye\Query\Visitors;
  4 | 
  5 | use Railken\SQ\Contracts\NodeContract;
  6 | use Railken\SQ\Exceptions\QuerySyntaxException;
  7 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
  8 | 
  9 | class KeyVisitor extends BaseVisitor
 10 | {
 11 |     /**
 12 |      * @var string
 13 |      */
 14 |     protected $base_table;
 15 | 
 16 |     /**
 17 |      * @var array
 18 |      */
 19 |     protected $keys;
 20 | 
 21 |     /**
 22 |      * @param string $base_table
 23 |      *
 24 |      * @return $this
 25 |      */
 26 |     public function setBaseTable($base_table)
 27 |     {
 28 |         $this->base_table = $base_table;
 29 | 
 30 |         return $this;
 31 |     }
 32 | 
 33 |     /**
 34 |      * @return string
 35 |      */
 36 |     public function getBaseTable()
 37 |     {
 38 |         return $this->base_table;
 39 |     }
 40 | 
 41 |     /**
 42 |      * @param mixed $keys
 43 |      *
 44 |      * @return $this
 45 |      */
 46 |     public function setKeys($keys)
 47 |     {
 48 |         $this->keys = $keys;
 49 | 
 50 |         return $this;
 51 |     }
 52 | 
 53 |     /**
 54 |      * @return array
 55 |      */
 56 |     public function getKeys()
 57 |     {
 58 |         return $this->keys;
 59 |     }
 60 | 
 61 |     /**
 62 |      * Visit the node and update the query.
 63 |      *
 64 |      * @param mixed                              $query
 65 |      * @param \Railken\SQ\Contracts\NodeContract $node
 66 |      * @param string                             $context
 67 |      */
 68 |     public function visit($query, NodeContract $node, string $context)
 69 |     {
 70 |         if ($node instanceof Nodes\KeyNode) {
 71 |             $key = $node->getValue();
 72 | 
 73 |             $keys = explode('.', $key);
 74 | 
 75 | 
 76 |             if (count($this->getKeys()) === 0) {
 77 |                 throw new QuerySyntaxException(sprintf("No range of keys defined"));
 78 |             }
 79 | 
 80 |             if (count($keys) === 1) {
 81 |                 $keys = [$this->getBaseTable(), $keys[0]];
 82 |             }
 83 | 
 84 |             $key = implode('.', $keys);
 85 | 
 86 |             $node->setValue($key);
 87 | 
 88 |             if ($this->getKeys()[0] === '*') {
 89 |                 return;
 90 |             }
 91 | 
 92 |             if (!in_array($key, $this->getKeys())) {
 93 |                 throw new QuerySyntaxException(sprintf("Invalid key %s", $key));
 94 |             }
 95 |         }
 96 | 
 97 |         foreach ($node->getChildren() as $child) {
 98 |             $this->visit($query, $child, $context);
 99 |         }
100 |     }
101 | }
102 | 


--------------------------------------------------------------------------------
/src/Query/Visitors/BaseOperatorVisitor.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Railken\LaraEye\Query\Visitors;
  4 | 
  5 | use Illuminate\Support\Collection;
  6 | use Illuminate\Support\Facades\DB;
  7 | use Railken\SQ\Languages\BoomTree\Nodes as Nodes;
  8 | 
  9 | abstract class BaseOperatorVisitor extends BaseVisitor
 10 | {
 11 |     /**
 12 |      * The node that will trigger the visitor.
 13 |      *
 14 |      * @var string
 15 |      */
 16 |     protected $node = Nodes\Node::class;
 17 | 
 18 |     /**
 19 |      * The string operator for the query.
 20 |      *
 21 |      * @var string
 22 |      */
 23 |     protected $operator = '';
 24 | 
 25 |     /**
 26 |      * Visit the node and update the query.
 27 |      *
 28 |      * @param mixed                              $query
 29 |      * @param \Railken\SQ\Contracts\NodeContract $node
 30 |      * @param string                             $context
 31 |      */
 32 |     public function visit($query, $node, string $context)
 33 |     {
 34 |         if ($node instanceof $this->node) {
 35 |             $child0 = $node->getChildByIndex(0);
 36 |             $child1 = $node->getChildByIndex(1);
 37 | 
 38 |             if ($context === Nodes\OrNode::class) {
 39 |                 $query->orWhere($this->parseNode($query, $child0), $this->operator, $this->parseNode($query, $child1));
 40 |             }
 41 | 
 42 |             if ($context === Nodes\AndNode::class) {
 43 |                 $query->where($this->parseNode($query, $child0), $this->operator, $this->parseNode($query, $child1));
 44 |             }
 45 |         }
 46 |     }
 47 | 
 48 |     /**
 49 |      * Parse the node.
 50 |      *
 51 |      * @param mixed                              $query
 52 |      * @param \Railken\SQ\Contracts\NodeContract $node
 53 |      *
 54 |      * @return mixed
 55 |      */
 56 |     public function parseNode($query, $node)
 57 |     {
 58 |         if ($node instanceof Nodes\KeyNode) {
 59 |             return $this->parseKey($node->getValue());
 60 |         }
 61 | 
 62 |         if ($node instanceof Nodes\ValueNode) {
 63 |             return $this->parseValue($node->getValue());
 64 |         }
 65 | 
 66 |         if ($node instanceof Nodes\FunctionNode) {
 67 |             // .. ?
 68 | 
 69 |             $f = $this->getBuilder()->getFunctions()->first(function ($item, $key) use ($node) {
 70 |                 $class = $item->getNode();
 71 | 
 72 |                 return $node instanceof $class;
 73 |             });
 74 | 
 75 |             if (!$f) {
 76 |                 throw new \Railken\SQ\Exceptions\QuerySyntaxException(sprintf("Function %s not allowed", $node->getName()));
 77 |             }
 78 | 
 79 |             $childs = new Collection();
 80 | 
 81 |             foreach ($node->getChildren() as $child) {
 82 |                 $childs[] = $this->parseNode($query, $child);
 83 |             }
 84 | 
 85 |             $childs = $childs->map(function ($v) use ($query) {
 86 |                 if ($v instanceof \Illuminate\Database\Query\Expression) {
 87 |                     $qb = $query instanceof \Illuminate\Database\Query\Builder ? $query : $query->getQuery();
 88 |                     return $v->getValue($qb->grammar);
 89 |                 }
 90 | 
 91 |                 $query->addBinding($v, 'where');
 92 | 
 93 |                 return '?';
 94 |             });
 95 | 
 96 |             return DB::raw($f->getName().'('.$childs->implode(',').')');
 97 |         }
 98 |     }
 99 | 
100 |     /**
101 |      * Parse key.
102 |      *
103 |      * @param string $key
104 |      *
105 |      * @return string
106 |      */
107 |     public function parseKey($key)
108 |     {
109 |         $keys = explode('.', $key);
110 | 
111 |         $keys = [implode(".", array_slice($keys, 0, -1)), $keys[count($keys) - 1]];
112 | 
113 |         $key = (new Collection($keys))->map(function ($part) {
114 |             return '`'.$part.'`';
115 |         })->implode('.');
116 | 
117 |         return DB::raw($key);
118 |     }
119 | 
120 |     /**
121 |      * Parse value.
122 |      *
123 |      * @param string $value
124 |      *
125 |      * @return string
126 |      */
127 |     public function parseValue($value)
128 |     {
129 |         return $value;
130 |     }
131 | }
132 | 


--------------------------------------------------------------------------------
/src/Filter.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Railken\LaraEye;
  4 | 
  5 | use Railken\LaraEye\Query\Functions as Functions;
  6 | use Railken\LaraEye\Query\Visitors as Visitors;
  7 | use Railken\SQ\Languages\BoomTree\Resolvers as Resolvers;
  8 | use Railken\SQ\QueryParser;
  9 | 
 10 | class Filter
 11 | {
 12 |     /**
 13 |      * @var string
 14 |      */
 15 |     protected $table;
 16 | 
 17 |     /**
 18 |      * @var array
 19 |      */
 20 |     protected $keys;
 21 | 
 22 |     /**
 23 |      * Construct.
 24 |      *
 25 |      * @param string $table
 26 |      * @param array  $keys
 27 |      */
 28 |     public function __construct(string $table, array $keys)
 29 |     {
 30 |         $this->table = $table;
 31 |         $this->keys = array_map(function ($key) use ($table) {
 32 |             if ($key === '*') {
 33 |                 return $key;
 34 |             }
 35 | 
 36 |             $keys = explode('.', $key);
 37 | 
 38 |             if (count($keys) === 1) {
 39 |                 return implode('.', [$table, $key]);
 40 |             }
 41 | 
 42 |             return $key;
 43 |         }, $keys);
 44 |     }
 45 | 
 46 |     /**
 47 |      * Filter query with where.
 48 |      *
 49 |      * @return Query\Builder
 50 |      */
 51 |     public function getBuilder()
 52 |     {
 53 |         $builder = new Query\Builder();
 54 |         $builder->setVisitors([
 55 |             (new Visitors\KeyVisitor($builder))->setKeys($this->keys)->setBaseTable($this->table),
 56 |             new Visitors\GroupVisitor($builder),
 57 |             new Visitors\EqVisitor($builder),
 58 |             new Visitors\NotEqVisitor($builder),
 59 |             new Visitors\GtVisitor($builder),
 60 |             new Visitors\GteVisitor($builder),
 61 |             new Visitors\LtVisitor($builder),
 62 |             new Visitors\LteVisitor($builder),
 63 |             new Visitors\CtVisitor($builder),
 64 |             new Visitors\SwVisitor($builder),
 65 |             new Visitors\EwVisitor($builder),
 66 |             new Visitors\AndVisitor($builder),
 67 |             new Visitors\OrVisitor($builder),
 68 |             new Visitors\NotInVisitor($builder),
 69 |             new Visitors\InVisitor($builder),
 70 |             new Visitors\NullVisitor($builder),
 71 |             new Visitors\NotNullVisitor($builder),
 72 |         ]);
 73 |         $builder->setFunctions([
 74 |             new Functions\ConcatFunction(),
 75 |             new Functions\SumFunction(),
 76 |             new Functions\DateFormatFunction(),
 77 |         ]);
 78 | 
 79 |         return $builder;
 80 |     }
 81 | 
 82 |     /**
 83 |      * Convert the string query into an object (e.g.).
 84 |      *
 85 |      * @return QueryParser
 86 |      */
 87 |     public function getParser()
 88 |     {
 89 |         $parser = new QueryParser();
 90 |         $parser->addResolvers([
 91 |             new Resolvers\ValueResolver(),
 92 |             new Resolvers\KeyResolver(),
 93 |             new Resolvers\GroupingResolver(),
 94 |             new Resolvers\SumFunctionResolver(),
 95 |             new Resolvers\DateFormatFunctionResolver(),
 96 |             new Resolvers\ConcatFunctionResolver(),
 97 |             new Resolvers\NotEqResolver(),
 98 |             new Resolvers\EqResolver(),
 99 |             new Resolvers\LteResolver(),
100 |             new Resolvers\LtResolver(),
101 |             new Resolvers\GteResolver(),
102 |             new Resolvers\GtResolver(),
103 |             new Resolvers\CtResolver(),
104 |             new Resolvers\SwResolver(),
105 |             new Resolvers\EwResolver(),
106 |             new Resolvers\NotInResolver(),
107 |             new Resolvers\InResolver(),
108 |             new Resolvers\NotNullResolver(),
109 |             new Resolvers\NullResolver(),
110 |             new Resolvers\AndResolver(),
111 |             new Resolvers\OrResolver(),
112 |         ]);
113 | 
114 |         return $parser;
115 |     }
116 | 
117 |     /**
118 |      * Filter query with where.
119 |      *
120 |      * @param mixed  $query
121 |      * @param string $filter
122 |      */
123 |     public function build($query, $filter)
124 |     {
125 |         $parser = $this->getParser();
126 |         $builder = $this->getBuilder();
127 | 
128 |         try {
129 |             $builder->build($query, $parser->parse($filter));
130 |         } catch (\Railken\SQ\Exceptions\QuerySyntaxException $e) {
131 |             throw new Exceptions\FilterSyntaxException($filter, $e->getMessage());
132 |         }
133 |     }
134 | }
135 | 


--------------------------------------------------------------------------------
/tests/FilterTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Railken\LaraEye\Tests;
  4 | 
  5 | use Illuminate\Database\Schema\Blueprint;
  6 | use Illuminate\Support\Facades\Schema;
  7 | use Railken\LaraEye\Filter;
  8 | use Railken\LaraEye\Exceptions\FilterSyntaxException;
  9 | 
 10 | class FilterTest extends \Orchestra\Testbench\TestCase
 11 | {
 12 |     /**
 13 |      * Setup the test environment.
 14 |      */
 15 |     public function setUp(): void
 16 |     {
 17 |         parent::setUp();
 18 | 
 19 |         Schema::dropIfExists('foo');
 20 | 
 21 |         Schema::create('foo', function (Blueprint $table) {
 22 |             $table->increments('id');
 23 |             $table->string('x')->nullable();
 24 |             $table->string('y')->nullable();
 25 |             $table->string('z')->nullable();
 26 |             $table->string('d')->nullable();
 27 |             $table->timestamps();
 28 |         });
 29 |     }
 30 | 
 31 |     /**
 32 |      * Retrieve a new instance of query.
 33 |      *
 34 |      * @param string $str_filter
 35 |      * @param array  $keys
 36 |      *
 37 |      * @return \Illuminate\Database\Query\Builder
 38 |      */
 39 |     public function newQuery($str_filter, $keys)
 40 |     {
 41 |         $filter = new Filter('foo', $keys);
 42 |         $query = (new Foo())->newQuery()->getQuery();
 43 |         $filter->build($query, $str_filter);
 44 | 
 45 |         return $query;
 46 |     }
 47 | 
 48 |     public function testFilterUndefindKey()
 49 |     {
 50 |         $this->expectException(FilterSyntaxException::class);
 51 |         $this->newQuery('d eq 1', ['x']);
 52 |     }
 53 | 
 54 |     public function assertQuery(string $sql, string $filter, $keys = ['id', 'x', 'y', 'z', 'created_at'])
 55 |     {
 56 |         $query = $this->newQuery($filter, $keys);
 57 |         $this->assertEquals($sql, $query->toSql());
 58 |         $query->get();
 59 |     }
 60 | 
 61 |     public function testFilterAndWrong()
 62 |     {
 63 |         $this->expectException(FilterSyntaxException::class);
 64 |         $this->newQuery('x and 1', ['*']);
 65 |     }
 66 | 
 67 |     public function testFilterConcatFunction()
 68 |     {
 69 |         $this->assertQuery('select * from `foo` where `foo`.`x` = CONCAT(`foo`.`x`,?)', 'x eq concat(x,2)');
 70 |         $this->assertQuery('select * from `foo` where `foo`.`x` = CONCAT(`foo`.`x`,CONCAT(`foo`.`y`,?))', 'x eq concat(x,concat(y,3))');
 71 |     }
 72 | 
 73 |     public function testFilterDateFormatFunction()
 74 |     {
 75 |         $this->assertQuery('select * from `foo` where `foo`.`x` = DATE_FORMAT(`foo`.`x`,?)', 'x eq date_format(x,"%d")');
 76 |     }
 77 | 
 78 |     /*public function testFilterSumFunction()
 79 |     {
 80 |         $this->assertQuery('select * from `foo` where `foo`.`x` = SUM(`foo`.`x`)', 'x eq sum(x)');
 81 |     }*/
 82 | 
 83 |     public function testFilterAllKeysValid()
 84 |     {
 85 |         $this->assertQuery('select * from `foo` where `foo`.`d` = `foo`.`x`', 'd eq x', ['*']);
 86 |     }
 87 | 
 88 |     public function testFilterEqColumns()
 89 |     {
 90 |         $this->assertQuery('select * from `foo` where `foo`.`x` = `foo`.`x`', 'x eq x');
 91 |         $this->assertQuery('select * from `foo` where `foo`.`x` = `foo`.`x`', 'x = x');
 92 |     }
 93 | 
 94 |     public function testFilterEq()
 95 |     {
 96 |         $this->assertQuery('select * from `foo` where `foo`.`x` = ?', 'x eq 1');
 97 |         $this->assertQuery('select * from `foo` where `foo`.`x` = ?', 'x = 1');
 98 |     }
 99 | 
100 |     public function testFilterGt()
101 |     {
102 |         $this->assertQuery('select * from `foo` where `foo`.`x` > ?', 'x gt 1');
103 |         $this->assertQuery('select * from `foo` where `foo`.`x` > ?', 'x > 1');
104 |     }
105 | 
106 |     public function testFilterGte()
107 |     {
108 |         $this->assertQuery('select * from `foo` where `foo`.`x` >= ?', 'x gte 1');
109 |         $this->assertQuery('select * from `foo` where `foo`.`x` >= ?', 'x >= 1');
110 |     }
111 | 
112 |     public function testFilterLt()
113 |     {
114 |         $this->assertQuery('select * from `foo` where `foo`.`x` < ?', 'x lt 1');
115 |         $this->assertQuery('select * from `foo` where `foo`.`x` < ?', 'x < 1');
116 |     }
117 | 
118 |     public function testFilterLte()
119 |     {
120 |         $this->assertQuery('select * from `foo` where `foo`.`x` <= ?', 'x lte 1');
121 |         $this->assertQuery('select * from `foo` where `foo`.`x` <= ?', 'x <= 1');
122 |     }
123 | 
124 |     public function testFilterCt()
125 |     {
126 |         $this->assertQuery('select * from `foo` where `foo`.`x` like ?', 'x ct 1');
127 |         $this->assertQuery('select * from `foo` where `foo`.`x` like ?', 'x *= 1');
128 |     }
129 | 
130 |     public function testFilterSw()
131 |     {
132 |         $this->assertQuery('select * from `foo` where `foo`.`x` like ?', 'x sw 1');
133 |         $this->assertQuery('select * from `foo` where `foo`.`x` like ?', 'x ^= 1');
134 |     }
135 | 
136 |     public function testFilterEw()
137 |     {
138 |         $this->assertQuery('select * from `foo` where `foo`.`x` like ?', 'x ew 1');
139 |         $this->assertQuery('select * from `foo` where `foo`.`x` like ?', 'x $= 1');
140 |     }
141 | 
142 |     public function testFilterIn()
143 |     {
144 |         $this->assertQuery('select * from `foo` where `foo`.`x` in (?)', 'x in (1)');
145 |         $this->assertQuery('select * from `foo` where `foo`.`x` in (?)', 'x =[] (1)');
146 |     }
147 | 
148 |     public function testFilterNotIn()
149 |     {
150 |         $this->assertQuery('select * from `foo` where `foo`.`x` not in (?)', 'x not in (1)');
151 |         $this->assertQuery('select * from `foo` where `foo`.`x` not in (?)', 'x !=[] (1)');
152 |     }
153 | 
154 |     public function testFilterAnd()
155 |     {
156 |         $this->assertQuery('select * from `foo` where (`foo`.`x` = ? and `foo`.`x` = ?)', 'x = 1 and x = 2');
157 |         $this->assertQuery('select * from `foo` where (`foo`.`x` = ? and `foo`.`x` = ?)', 'x = 1 && x = 2');
158 |     }
159 | 
160 |     public function testFilterOr()
161 |     {
162 |         $this->assertQuery('select * from `foo` where (`foo`.`x` = ? or `foo`.`x` = ?)', 'x = 1 or x = 2');
163 |         $this->assertQuery('select * from `foo` where (`foo`.`x` = ? or `foo`.`x` = ?)', 'x = 1 || x = 2');
164 |     }
165 | 
166 |     public function testFilterNull()
167 |     {
168 |         $this->assertQuery('select * from `foo` where `foo`.`x` is null', 'x is null');
169 |     }
170 | 
171 |     public function testFilterNotNull()
172 |     {
173 |         $this->assertQuery('select * from `foo` where `foo`.`x` is not null', 'x is not null');
174 |     }
175 | 
176 |     public function testGrouping()
177 |     {
178 |         $this->assertQuery('select * from `foo` where (`foo`.`x` = ? or (`foo`.`x` = ? and `foo`.`x` = ?))', 'x = 1 or (x = 2 and x = 3)');
179 |         $this->assertQuery('select * from `foo` where (`foo`.`x` = ? and (`foo`.`x` = ? or `foo`.`x` = ?))', 'x = 1 and (x = 2 or x = 3)');
180 |         $this->assertQuery('select * from `foo` where (`foo`.`x` = ? and (`foo`.`x` = ?))', 'x = 1 and (x = 2)');
181 |     }
182 | }
183 | 


--------------------------------------------------------------------------------