giadc/json-api-request

A package for handling JSON API requests

Tuesday, September 26, 2017
by giadc-dev
Repository
4 Watchers
1 Stars
367 Installations

PHP
2 Dependents
0 Suggesters
0 Forks
0 Open issues
18 Versions
3 % Grown

The README.md

JSON API Request

A package for automating pagination, filtering, sorting, and includes when working with the JSON API standard., _(*1)

Installation

composer install giadc/json-api-request, _(*2)

Basic Usage

RequestParams

Request Params provides objects for pulling/modifying HttpFoundation Requests that compile with JSON API V1.0., _(*3)

Example:, _(*4)

GET /articles?include=author,comments.author&page[number]=3&page[size]=20&filter[author]=frank&sort=-created,title&fields[author]=name,age

```php use Giadc\JsonApiRequest\Requests\RequestParams;, _(*5)

// By default it creates params from Globals $request = new RequestParams();, _(*6)

// Get Includes $request->getIncludes()->toArray(); // outputs: ['author', 'comments.author'], _(*7)

// Get Page Details $request->getPageDetails()->toArray(); // outputs: ['page' => ['number => 3, 'size' => 20]], _(*8)

// Get Sorting $request->getSortDetails()->toArray(); // outputs: [['field' => 'title', 'direction' => 'ASC'], ['field' => 'created', 'direction' => 'DESC']], _(*9)

// Get Filters $request->getFiltersDetails()->toArray(); // outputs: ['author' => ['frank']], _(*10)

// Get Full Pagination $request->getFullPagination(); // outputs: [{Pagination}, {Includes}, {Sorting}, {Filters}], _(*11)

// Get Fields $request->getFields()->toArray(); // outputs: ['author' => ['name', 'age']], _(*12)


### Request Objects
All Objects implements the RequestInterface and give access the following methods: `getParamsArray()`, `getQueryString()`
#### Includes
```php
$includes = new Includes(['author', 'comments.author');
$includes->add('site');
$includes->getQueryString();
//outputs: 'include=author,comments.author,site'

Pagination

Pagination sets a defaults the pages size if not provided. It will Also allow you to set max it is able to return by settings the PAGINATION_DEFAULT and PAGINATION_MAX env variables., _(*13)

$pagination = new Pagination(2, 20);
$pagination->getQueryString();
//outputs: 'page[number]=2&page[size]=20'

// PAGINATION_MAX=25
$pagination = new Pagination(2, 1000);
$pagination->getQueryString();
//outputs: 'page[number]=2&page[size]=25'

Sorting

$sorting = new Sorting('-created,title');
$sorting->setSorting();
$sorting->getQueryString('created,-title');
//outputs: 'sort=created,title'

Filters

$filters = new Filters(['author' => 'frank');
$filters->addFilter('author', 'bob');
$filters->getQueryString();
//outputs: 'filter[author]=frank,bob'

Excludes

$filters = new Excludes(['author' => 'country');
$filters->add('author', 'age');
$filters->getQueryString();
//outputs: 'excludes[author]=country,age'

Fields

$filters = new Fields(['author' => 'name');
$filters->add('author', 'age');
$filters->getQueryString();
//outputs: 'fields[author]=name,age'

The Versions

26/09 2017

1.0.x-dev

1.0.9999999.9999999-dev

A package for handling JSON API requests

library json-api-request

A package for handling JSON API requests

giadc/json-api-request

The README.md

JSON API Request

Installation

Basic Usage

RequestParams

Pagination

Sorting

Filters

Excludes

Fields

The Versions

1.0.x-dev

The Requires

The Development Requires

by David Hill

by Ryan Marganti

dev-master

The Requires

The Development Requires

by David Hill

by Ryan Marganti

1.1.0

The Requires

The Development Requires

by David Hill

by Ryan Marganti

1.0.1

The Requires

The Development Requires

by David Hill

by Ryan Marganti

dev-f-and-boolean-search

The Requires

The Development Requires

by David Hill

by Ryan Marganti

0.5.0-alpha

The Requires

The Development Requires

by David Hill

by Ryan Marganti

1.0.0

The Requires

The Development Requires

by David Hill

by Ryan Marganti

0.4.4

The Requires

The Development Requires

by David Hill

by Ryan Marganti

0.4.3

The Requires

The Development Requires

by David Hill

by Ryan Marganti

0.4.2

The Requires

The Development Requires

by David Hill

by Ryan Marganti

0.4.1

The Requires

The Development Requires

by David Hill

by Ryan Marganti

0.4.0

The Requires

The Development Requires

by David Hill

by Ryan Marganti

0.3.1

The Requires

by David Hill

by Ryan Marganti

0.3.0

The Requires