steos/restmachine

webmachine for PHP

dev-master 2020-07-07 18:18 UTC

Requires

• php: >=7.4
• ext-json: *
• symfony/http-foundation: ^5.1

Requires (Dev)

• phpunit/phpunit: ^9.2

BSD-3-Clause

README

restmachine is a webmachine implementation for PHP.

Webmachine brings HTTP semantic awareness to your application. It allows you to declaratively specify dynamic HTTP resources so you don't have to worry about implementation details.

Example

Resource::create(self::defaults())
    ->allowedMethods(['GET', 'PUT', 'DELETE'])
    ->isProcessable(self::validator())
    ->canPutToMissing(false)
    ->isNew(false)
    ->isRespondWithEntity(function(Context $context) {
        return $context->getRequest()->isMethod('PUT');
    })
    ->exists(function($context) use ($db, $id) {
        return Todo::exists($db, $id);
    })
    ->put(function($context) use ($db, $id) {
        Todo::update($db, $id, $context->entity);
    })
    ->delete(function($context) use ($db, $id) {
        Todo::delete($db, $id);
    })
    ->handleOk(function(Context $context) use ($db, $id) {
        return Todo::fetchOne($db, $id);
    });

Install

With composer:

{
  "require": {
    "steos/restmachine": "dev-master"
  }
}

restmachine currently requires PHP >= 7.4.

Documentation

• Getting Started
• How It Works
• Serialization
• Content Negotiation
• Conditional Requests
• Debugging

Credits

Credits go to

• clojure-liberator where we extracted the decision graph and which we heavily used as reference and documentation to understand the webmachine execution model

• Symfony HttpFoundation which RestMachine is built on.

Project Status

This is beta software. Some functionality is still missing. There will be bugs. The API may still change, but should be fairly stable.

TODO

• Content negotiation for language, charset, encoding
• Standalone wrapper with routing
• PATCH method
• handle RFC850/1036 and ANSI C's asctime() format as per rfc 2616 (Utils::parseHttpDate)

License

Copyright © 2020 Stefan Oestreicher and contributors.

Distributed under the terms of the BSD-3-Clause license.