Download the PHP package smalldb/smalldb-rest without Composer

On this page you can find all versions of the php package smalldb/smalldb-rest. 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 smalldb-rest

Smalldb-REST

Simple implementation of REST API for Smalldb.

Requirements

Installation

  1. Use composer install to install all libraries.
  2. Create api-v1.php and api-v1-diagram.php as in examples.
  3. Create state machine definitions in statemachine directory -- see libsmalldb documentation for details.
  4. Before use in production environment change the auth.class option to something less permissive. -- The config.json.php contains option to allow everything. The default is to use CookieAuth class, but that requires some configuration.

Configuration

Configuration is loaded from three JSON files. Later overwrites the previous (using array_replace_recursive function).

To achieve forward compatibility of your configuration files do not use whole copy of default config file in your application. Set only changed options instead.

API Usage

Read state of a state machine (machine ID = "blogpost", 1):

Read transition info of a state machine (transition edit):

Invoke transition of a state machine (transition edit, parameters are passed via $_POST['args']):

List state machines of given type:

State diagram renderer

The second function of the REST API is state diagram renderer. To retrieve state diagram of the blogpost state machine use following HTTP request:

This mean you can simply put this HTML to your application:

Note: Diagrams are rendered using Graphviz and cached using APC. The dot executable must be somewhere in PHP's PATH.

LICENSE

Apache 2.0 - see LICENSE file


All versions of smalldb-rest with dependencies

PHP Build Version
Package Version
Requires smalldb/libsmalldb Version >=0.4
smalldb/flupdo Version *
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 smalldb/smalldb-rest contains the following files

Loading the files please wait ....