Download the PHP package coder-sapient/json-api-document-builder without Composer

On this page you can find all versions of the php package coder-sapient/json-api-document-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package json-api-document-builder

Json Api Document Builder

This library resolve Query Object to JSON:API Documents.

Features

Request examples:

Requirements

Installation

Use composer to install the package:

Basic Usage

Controller action example:

You can add the following traits to your request classes:

SingleDocumentRequest

Method Description
resourceId() Returns the resource id, which should be taken from the URL, for example.
resourceType() Returns the resource type that defines the ResourceResolver
acceptableIncludes() Returns a list of acceptable relationship names to include
toQuery() Returns the SingleDocumentBuilder

DocumentsRequest

Method Description
resourceType() Returns the resource type that defines the ResourceResolver
acceptableIncludes() Returns a list of acceptable relationship names to include
acceptableSorting() Returns a list of acceptable rows for sorting
acceptableFilters() Returns a list of acceptable filters that can be applied to resource collection
toQuery() Returns the DocumentsBuilder

Builder

To initialize ResourceCache:

Method Description
buildIncludes(Includes $includes, ResourceCollection $resources) Returns the included collection of resource objects

SingleDocumentBuilder

The SingleDocumentBuilder extends Builder:

Method Description
build(SingleDocumentQuery $query) Returns a document with single top-level resource

DocumentsBuilder

The DocumentsBuilder extends Builder:

Method Description
build(DocumentsQuery $query) Returns a document with top-level resources

Resolver

Factory

The ResourceResolver by resource type.

There is a basic implementation InMemoryResourceResolverFactory:

ResourceResolver

The builder use instances of ResourceResolver to find resources by ids or query criteria.

When resolving a collection of top-level resources, it will provide a query criteria consisting of filters, orders, pagination. You need to match criteria with your query builder (Doctrine, Eloquent, etc.).

The builder can accept Guzzle Promises when trying to include related resources and load them async.

PaginationResolver

If the resource resolver implements PaginationResolver, the builder will add top-level Links and Meta objects to the resulting document.

ResourceCache

The builder caches all resolved resources using instance of ResourceCache.

There is a basic implementation InMemoryResourceCache. If you don't need caching, use NullableResourceCache.

License

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


All versions of json-api-document-builder with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
ext-json Version *
json-api-php/json-api Version ^2.2
guzzlehttp/promises Version ^1.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package coder-sapient/json-api-document-builder contains the following files

Loading the files please wait ....