randomstate/api

A flexible API package for PHP.

Maintainers

Details

github.com/randomstate/api

Source

Issues

Installs: 1 564

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

v0.5.0 2021-09-03 14:37 UTC

Requires

Requires (Dev)

MIT 73b4fdc079ccc7c8b127924c3652927d95fc239a

  • Connor Forsyth <connor.woop@randomstate.co.uk>

This package is auto-updated.

Last update: 2024-11-29 05:26:44 UTC

README

A flexible API package for PHP. Fits perfectly with Laravel and Laravel Doctrine. This is a barebones package that is agnostic to any given PHP application or framework. As a result, there is a lot of legwork to wire up the different components to get started.

Please see randomstate/laravel-api for an out-of-the-box integration with Laravel that does this all for you.

Installation

composer require randomstate/api

Basic Usage

Input Transformation

<?php

use \RandomState\Api\Transformation\Manager;
use \RandomState\Api\Transformation\Fractal\Resolver;
use \RandomState\Api\Transformation\Fractal\Switchboard;
use \RandomState\Api\Transformation\Adapters\Fractal\CollectionAdapter;
use \RandomState\Api\Transformation\Adapters\Fractal\ItemAdapter;

$manager = new Manager;
$resolver = new Resolver()
$resolver->bind(MyOwnEntityFromSomewhere::class, MyOwnEntityFractalTransformer::class);
$switchboard = new Switchboard($resolver);

$manager->register(
    new CollectionAdapter($switchboard),
    new ItemAdapter($switchboard)
);

$data = new MyOwnEntityFromSomewhere;

$output = $manager->transform($data); // will use MyOwnEntityFractalTransformer via Fractal to transform the data