Download the PHP package spinen/laravel-formio without Composer

SPINEN's Laravel Formio

PHP package to interface with Formio

We solely use Laravel for our applications, so this package is written with Laravel in mind. We have tried to make it work outside of Laravel. If there is a request from the community to split this package into 2 parts, then we will consider doing that work.

Build Status

Branch	Status	Coverage	Code Quality
Develop
Master

Installation

Install Formio PHP Package:

The package uses the auto registration feature of Laravel.

Usage

The primary class is Spinen\Formio\Client. It gets constructed with 3 parameters...

• array $config - Configuration properties. See the formio.php file in the ./config directory for a documented list of options.

• Guzzle $guzzle - Instance of GuzzleHttp\Client

• Token $token - [Optional] Instance of Spinen\Formio\Token

Once you new up a Client instance, you have the following methods...

• addUser(FormioUser $user, $password = null) - Add the user to the user resource in Formio. If no password is provided, then if a default password is specified in the config, it is used. Otherwise, generate a random 32 character string. Once the user is added to Formio, then the password is set on the formio_password property of the $user object, and the save method is called on it to persist the password for future interactions with Formio for the user. Finally, set the user's JWT on the $token, so that requests are made via the user.

• login(FormioUser $user = null) - If a $user is provided, then log the user into Formio with the array provided by the getLoginData method on the $user object. Otherwise, log in the admin user from the config.

• logout() - Null the $token

• request($path, $data = [], $method = 'GET') - Make an API call to Formio to $path with the $data using the JWT for the logged in user.

• setConfigs(array $configs) - Allow overriding the $configs on the Client instance.

• sso(FormioUser $user) - If the $user instance has a value set for formio_password property, then get a JWT from Formio via API. Otherwise, generate a Custom JWT for the user.

• uri($path = null) - Generate a full uri for the path on the Formio server.

Laravel

Configuration

1. You will need to make your User object implement Spinen\Formio\Contracts\FormioUser so that it will have the required methods. We have also included the Spinen\Formio\Concerns\HasForms trait which will satisfy the contract.

2. Add the appropriate values to your

   Minimal Keys

   Optional Keys

3. [Optional] Publish config & migration

   Config

   A configuration file named can be published to by running...

   Migration

   Migrations files can be published by running...

JS API

By default, there is a route published at /api/formio/jwt which is behind the api & auth:api middlewares, so from your js code, you can request a JWT for the authenticated user from the route...

to get a payload like this...

Examples

Here is an example of getting the roles as admin:

Here is an example of getting the form names as a user with a custom JWT:

Generic PHP

Examples

Here is an example of getting the current user as admin: