steos/restmachine

webmachine for PHP

restmachine

, _(*1)

restmachine is a webmachine implementation for PHP., _(*2)

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., _(*3)

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:, _(*4)

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

restmachine currently requires PHP >= 7.4., _(*5)

Documentation

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

Credits

Credits go to, _(*6)

• clojure-liberator where we extracted the decision graph and which we heavily used as reference and documentation to understand the webmachine execution model, _(*7)

• Symfony HttpFoundation which RestMachine is built on., _(*8)

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., _(*9)

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., _(*10)

Distributed under the terms of the BSD-3-Clause license., _(*11)