search

timgws / QueryBuilderParser

A simple to use query builder for the jQuery QueryBuilder plugin for use with Laravel.
MIT License
159 stars 65 forks source link

Documentation Suggestion #31

Open galeaspablo opened 6 years ago

galeaspablo commented 6 years ago

In Using QueryBuilderParser you use DB::table and DB::collection. May I suggest adding the namespace for these. That would make it easier to understand how to integrate with Illuminate, without Laravel.

I'm making a pull request to the documentation of https://querybuilder.js.org/, to label your project for both Laravel and Illuminate. It's currently labelled just for Laravel.

galeaspablo commented 6 years ago

FYI this got merged, so even more reason to add the namespaces.

See https://github.com/mistic100/jQuery-QueryBuilder/pull/707

You are now labelled as PHP (Illuminate, Laravel with Illuminate) > timgws / QueryBuilderParser in the homepage https://querybuilder.js.org/

timgws commented 6 years ago

@galeaspablo Sure, feel free to write the documentation. Although QueryBuilderParser does work with Illuminate, it is not a supported use.

You will notice the first paragraph clearly states:

QueryBuilderParser is designed mainly to be used inside Laravel projects

If I had seen https://github.com/mistic100/jQuery-QueryBuilder/pull/707 in time, I would have suggested that the description be left as Laravel.

This is how I am setting up sqlite in the tests: https://github.com/timgws/QueryBuilderParser/blob/master/tests/CommonQueryBuilderTests.php#L56-L65

If you (or anyone else) wish(es) to contribute to the documentation to add in additional information for using this code base with Illuminate, feel free.

I don't personally need this use case, and do not currently have the time to support it, any further then what is required to run the tests to ensure that it works.