README

Allow for multi-tenancy by using table prefix

Also see laratt-api where this project was originally built and refactored.

Install:

composer require niiknow/laratt

Config:

php artisan vendor:publish --provider="Niiknow\Laratt\LarattServiceProvider"

Features

Use special character $ for tenant and table separator. Most database allow for this character.
Dynamic table as tenant$table_name
Tenant resolution use x-tenant header/input by default; though, it is customizable by providing a static function for resolver config.
A generic Controller Trait that provide simple and flexible CRUD (create, retrieve, update, delete) REST endpoint.
Simple query and bulk delete /query REST endpoint.
jQuery DataTables as /data endpoint with laravel-datatables
Pre-defined structured schema for ProfileModel
Schedulable and ecommerce schema type for TableModel
Being able to include and exclude table from auditable - so you don't have to audit things like when you're using it for logging, caching, or when client doesn't need it for some particular reason.

CONS It doesn't support table relationship.

API Schema

The image below is from our Swagger documentation of the laratt-api project.

Table Schema

Special multi-tables endpoint @ /api/v1/tables/{table}; where {table} is the table name you want to create. {table} must be all lower cased alphanumeric and underscore with mininum of 3 characters to 30 max. Example, let say x-tenant: clienta and {table} = product, then the resulting table will be clienta$product.

Also note that there are two ids: id and uid. id is internal to laratt. You should be using uid for all operations. uid is an auto-generated guid, if none is provide during insert.

Providing a uid allow the API update to effectively act as an merge/upsert operation. This mean that, if you call update with a uid, it will update if the record is found, otherwise insert a new record.

/query endpoint is use for query and bulk DELETE, see: Query Syntax
/data endpoint is use for returning jQuery DataTables format using laravel-datatables.
/import bulk import is csv to allow for bigger import. Up to 10000 records instead of some small number like 100 for Azure Table Storage (also see admin config to adjust). This allow for efficiency of smaller file and quicker file transfer/upload.
/truncate truncate all data from table.
/drop drop a table. Why not? Now you can do all kind of crazy stuff with table.

What about your own/custom schema? See example of our Profile Schema

Query-Syntax

This library provide simple query endpoint for search and bulk delete: api/v1/profile/query or api/v1/tables/{table}/query

Limiting

To limit the number of returned resources to a specific amount with keyword limit or per_page:

/query?limit=10
/query?limit=20

Sorting

To sort the resources by a column in ascending or descending order:

/query?sort[]=column|asc
/query?sort[]=column|desc

You could also have multiple sort queries:

/query?sort[]=column1|asc&sort[]=column2|desc

Filtering

The basic format to filter the resources:

/query?filter[]=column:operator:value

Note: The values are rawurldecode()d.

Filtering Options

Operator	Description	Example
eq	Equal to	`/query?filter[]=column1:eq:123`
neq	Not equal to	`/query?filter[]=column1:neq:123`
gt	Greater than	`/query?filter[]=column1:gt:123`
gte	Greater than or equal to	`/query?filter[]=column1:gte:123`
lt	Less than	`/query?filter[]=column1:lt:123`
lte	Less than or equal to	`/query?filter[]=column1:lte:123`
ct	Contains text	`/query?filter[]=column1:ct:some%20text`
nct	Does not contains text	`/query?filter[]=column1:nct:some%20text`
sw	Starts with text	`/query?filter[]=column1:sw:some%20text`
nsw	Does not start with text	`/query?filter[]=column1:nsw:some%20text`
ew	Ends with text	`/query?filter[]=column1:ew:some%20text`
new	Does not end with text	`/query?filter[]=column1:new:some%20text`
bt	Between two values	`/query?filter[]=column1:bt:123\|321`
nbt	Not between two values	`/query?filter[]=column1:nbt:123\|321`
in	In array	`/query?filter[]=column1:in:123\|321\|231`
nin	Not in array	`/query?filter[]=column1:nin:123\|321\|231`
nl	Is null	`/query?filter[]=column1:nl`
nnl	Is not null	`/query?filter[]=column1:nnl`

You can also do OR and AND clauses. For OR clauses, use commas inside the same filter[] query:

/query?filter[]=column1:operator:value1,column2:operator:value2

For AND clauses, use another filter[] query.

/query?filter[]=column1:operator:value1&filter[]=column2:operator:value2

RequestQueryBuilder server-side usage

Below demo ficticious server-side DonationController that provide Laravel Paginate json data for some client-side ui.

<?php
namespace App\Http\Controllers\Api\V1;

use App\Http\Controllers\Controller;
use App\Models;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Niiknow\Laratt\RequestQueryBuilder;

class DonationController extends Controller
{
    /**
     * Method return donor transaction history
     *
     * @param Request  $request
     */
    public function index(Request $request)
    {
        $user  = \Auth::user();
        $query = \App\Models\Donation::select(
            [
                'donations.id',
                'donations.amount',
                'donations.recurrence_period',
                'donations.created_at',
                'donations.txn_id',
                'donations.txn_type',
                'projects.name as name'
            ]
        )->Where('donor_id', $user->id)
         ->leftJoin('projects', 'donations.project_id', '=', 'projects.id');

        $qb = new RequestQueryBuilder($query);

        return $qb->applyRequest($request);
    }
}

License

The MIT License (MIT). Please see License File for more information.

niiknow / laratt

Maintainers

Details