README

Introduction

Larapi Components offers you to do modern API development in Laravel.

Larapi Components comes included with...

• A modern exception handler for APIs.
• A Controller class that gives response, parse data for your endpoints.
• A Repository class for requesting entities from your database.
• Sorting.
• Filtering.
• Eager loading.
• Pagination.

Check how to use in your app

Create Controller, Service, Repository & Model with one Command.

php artisan component:make {parent} {name}

Eager loading

Simple eager load

/books?includes[]=author

Will return a collection of 5 Books eager loaded with Author.

IDs mode

/books?includes[]=author-ids

Will return a collection of Books eager loaded with the ID of their Author

Sideload mode

/books?includes[]=author-sideload

Will return a collection of Books and a eager loaded collection of their Authors in the root scope.

Pagination

Two parameters are available: limit and page. limit will determine the number of records per page and page will determine the current page.

/books?limit=10&page=3

Will return books number 30-40.

Sorting

Should be defined as an array of sorting rules. They will be applied in the order of which they are defined.

Sorting rules

Example

{
	"sort": [
		{
			"key": "id",
			"direction": "DESC"
		}
	]
}

Will result in the books being sorted by id in descending order.

Filtering

Before use filters make sure you have declared $whiteListFilter in specified Model. Example:

/**
 * Columns that can be filtered.
 *
 * @var array
 */
public static $whiteListFilter = ['first_name', 'posts.body'];

Filters should be defined as an array of filter groups.

Filter groups

Filters

Operators

Example filter

Below you can find how to filter all users that have first name "Gentrit".

{
	"filter_groups": [
		{
			"filters": [
				{
					"column": "first_name",
					"operator": "eq",
					"value": "Gentrit"
				}
			]
		}
	]
}

You can create Custom filter in Repostory like this:

public function filterAuthorName($queryBuilder, $method, $operator, $value)
{
     switch ($method) {
        case 'where':
            $queryBuilder->whereHas('author', function ($q) use ($operator, $value) {
                $q->where(DB::raw("CONCAT(`first_name`, ' ', `last_name`)"), $operator, $value);
            });
            break;
        
        case 'orWhere':
            $queryBuilder->orWhereHas('author', function ($q) use ($operator, $value) {
                $q->where(DB::raw("CONCAT(`first_name`, ' ', `last_name`)"), $operator, $value);
            });
            break;
}

Custom filter function

Repository functions

The examples will use a hypothetical Eloquent model named User.

get (array $options = [])

Get all User rows

getById ($id, array $options = [])

Get one User by primary key

getRecent (array $options = [])

Get User rows ordered by created_at descending

getRecentWhere (string $column, mixed $value, array $options = [])

Get User rows where $column=$value, ordered by created_at descending

getWhere (string $column, mixed $value, array $options = [])

Get User rows where $column=$value

getWhereArray (array $clauses, array $options = [])

Get User rows by multiple where clauses ([$column1 => $value1, $column2 => $value2])

getWhereIn (string $column, array $values, array $options = [])

Get User rows where $column can be any of the values given by $values

getLatest (array $options = [])

Get the most recent User

getLatestWhere (string $column, mixed $value, array $options = [])

Get the most recent User where $column=$value

delete ($id)

Delete User rows by primary key

deleteWhere ($column, $value)

Delete User rows where $column=$value

deleteWhereArray (array $clauses)

Delete User rows by multiple where clauses ([$column1 => $value1, $column2 => $value2])