PHP Classes

PHP Microservices Framework: Setup microservices apps with configuration arrays

Recommend this page to a friend!
  Info   View files Documentation   View files View files (109)   DownloadInstall with Composer Download .zip   Reputation   Support forum (1)   Blog (2)    
Last Updated Ratings Unique User Downloads Download Rankings
2024-06-21 (Less than 1 hour ago) RSS 2.0 feedNot enough user ratingsTotal: 139 All time: 9,221 This week: 28Up
Version License PHP version Categories
microservices 4.9MIT/X Consortium ...7.4Design Patterns, PHP 7
Description 

Author

This package can be used to setup microservices apps using configuration arrays.

It can read configuration PHP scripts that contain values that will be used to set up details of operation of an application based on microservices.

Currently it allows to configure:

- SQL query templates to perform CRUD operations on data stored in a database

- Scripts that should handle HTTP requests of methods GET, POST, DELETE, PATCH and PUT

Innovation Award
PHP Programming Innovation award winner
April 2023
Winner
Many PHP applications are based in microservices that implement Web or API interfaces.

These applications can be implemented using base core code that developers can customize in several ways.

This package implements a microservices approach based on configuration PHP scripts that contain arrays with values to set the application's behavior.

This way, it is straightforward and fast to create microservices-based applications.

Manuel Lemos
Picture of Ramesh Narayan Jangid
  Performance   Level  
Name: Ramesh Narayan Jangid <contact>
Classes: 8 packages by
Country: India India
Age: 48
All time rank: 3191208 in India India
Week rank: 17 Up1 in India India Up
Innovation award
Innovation award
Nominee: 3x

Winner: 2x

Recommendations

Online examination system for staff recruitment
Web based Online examination system for staff recruitment

Instructions

import global.sql in global database import cache.sql in cache database import client_master.sql in client_001 database

Make required config changes in .env.example

HttpAuthenticationRestrictedIp='127.0.0.1' HttpAuthenticationUser='reload_username' HttpAuthenticationPassword='reload_password'

cacheHostname='127.0.0.1' cachePort=3306 cacheUsername='root' cachePassword='shames11'

defaultDbHostname='127.0.0.1' defaultDbPort=3306 defaultDbUsername='root' defaultDbPassword='shames11'

Save .env.example as .env

Open a browser and access below once to complete with setting-up things. http://localhost/Microservices/public_html/index.php?r=/reload Make required changes as per Microservices folder path. Username/Password: reload_username/reload_password

Ready to go !

Open Postname and try requesting for access token. http://localhost/Microservices/public_html/index.php?r=/login admin/shames11 client_1_user_1/shames11

Documentation

PHP Microservices Framework

This is a light & easy Framework for Microservices. It can be used to create APIs in a very short time once you are done with your database.

Important Files

.env.example Create a copy of this file as .env

global.sql Import this SQL file on your MySQL global instance

client\_master.sql Import this SQL file on your MySQL client instance

cache.sql Import this SQL file for cache in MySQL cache instance if Redis is not the choice (To be configured in .env)

> Note: One can import all three sql's in a single database to start with. Just configure the same details in the .env file.

.env.example

Below are the configuration settings details in .env

| Variable | Description | Value Example | | -------- | ----------- | ------------- | | defaultDbHostname | Default MySQL hostname | 127.0.0.1 | | defaultDbUsername | Default MySQL username | root | | defaultDbPassword | Default MySQL password | password | | defaultDbDatabase | Default MySQL database | global | | clientMasterDbName | Client Master Database | client\_master - Complete Database with least required data to replicate if client demand a separate database for his data. | | dbHostnameClient001 | Client MySQL hostname | This can be the dedicated host domain / IP | | dbUsernameClient001 | Client MySQL username | username | | dbPasswordClient001 | Client MySQL password | password | | dbDatabaseClient001 | Client MySQL database | client\_001 / as\_per\_your\_use | | | The Client details can be same as all Default MySQL settings also depending on situation | | | r=/reload | | | | HttpAuthenticationRestrictedIp | For reloading global DB changes allowed IP | 127.0.0.1 | | HttpAuthenticationUser | HTTP Authentication Username | reload\_username | | HttpAuthenticationPassword | HTTP Authentication Password | reload\_password |

Folders

  • App Basic Microservices application folder
  • Config Basic Microservices configuration folder
  • public\_html Microservices doc root folder
  • ThirdParty Folder containing Classes to perform HTTP request via cURL to the Third Parties
  • Crons Crons classes folder
  • Dropbox Folder for uploaded files.
  • Validation Folder for validation code files.

Route

Files

  • Config/Routes/&lt;GroupName&gt;/GETroutes.php for all GET method routes configuration.
  • Config/Routes/&lt;GroupName&gt;/POSTroutes.php for all POST method routes configuration.
  • Config/Routes/&lt;GroupName&gt;/PUTroutes.php for all PUT method routes configuration.
  • Config/Routes/&lt;GroupName&gt;/PATCHroutes.php for all PATCH method routes configuration.
  • Config/Routes/&lt;GroupName&gt;/DELETEroutes.php for all DELETE method routes configuration.

&lt;GroupName&gt; These are corresponding to the assigned group to a user for accessing the API's

Example

  • For configuring route /tableName/parts GET method

    return [ 'tableName' => [ 'parts' => [ '__file__' => 'SQL file location' ] ] ];

  • For configuring route /tableName/{id} where id is dynamic integer value to be collected.

    return [ 'tableName' => [ '{id:int}' => [ '__file__' => 'SQL file location' ] ] ];

  • Same dynamic variable but with a different data type, for e.g. {id} will be treated differently for string and integer values to be collected.

    return [ 'tableName' => [ '{id:int}' => [ '__file__' => 'SQL file location for integer data type' ], '{id:string}' => [ '__file__' => 'SQL file location for string data type' ] ] ];

  • To restrict dynamic values to a certain set of values. One can do the same by appending comma-separated values after OR key.

    return [ '{tableName:string|admin,group,client,routes}' => [ '{id:int}' => [ '__file__' => 'SQL file location' ] ] ];

SQLs

Folder

  • Config/Queries/GlobalDB for global database.
  • Config/Queries/ClientDB for Clients (including all hosts and their databases).

Files - GlobalDB

  • Config/Queries/GlobalDB/GET/<filenames>.php GET method SQL.
  • Config/Queries/GlobalDB/POST/<filenames>;.php POST method SQL.
  • Config/Queries/GlobalDB/PUT/<filenames>.php PUT method SQL.
  • Config/Queries/GlobalDB/PATCH/<filenames>.php PATCH method SQL.
  • Config/Queries/GlobalDB/DELETE/<filenames>.php DELETE method SQL.

Files - ClientDB

  • Config/Queries/ClientDB/GET/<filenames>.php GET method SQL.
  • Config/Queries/ClientDB/POST/<filenames>.php POST method SQL.
  • Config/Queries/ClientDB/PUT/<filenames>.php PUT method SQL.
  • Config/Queries/ClientDB/PATCH/<filenames>.php PATCH method SQL.
  • Config/Queries/ClientDB/DELETE/<filenames>.php DELETE method SQL.

> One can replace <filenames> tag with desired name as per functionality.

Configuration

  • GET method.

    <?php return [ 'query' => "SELECT * FROM {$Env::$globalDB}.TableName WHERE id = ? AND group_id = ? AND client_id = ?", '__WHERE__' => [//column => [uriParams|payload|function|readOnlySession|{custom}, key|{value}] 'id' => ['uriParams', 'id'], 'group_id' => ['payload', 'group_id'], 'client_id' => ['readOnlySession', 'client_id'] ], 'mode' => 'singleRowFormat',// Single row returned. 'subQuery' => [ 'Clients' => [ 'query' => "MySQL Query here", '__WHERE__' => [], 'mode' => 'multipleRowFormat'// Multiple rows returned. ], ... ], 'validate' => [ [ 'fn' => 'validateGroupId', 'fnArgs' => [ 'group_id' => ['payload', 'group_id'] ], 'errorMessage' => 'Invalid Group Id' ], ... ] ];

> Here query & mode keys are required keys

  • For POST/PUT/PATCH/DELETE method.

    <?php return [ 'query' => "INSERT {$Env::$globalDB}.TableName SET SET WHERE WHERE ", // Only fields present in CONFIG shall be supported. Both Required and Optional '__CONFIG__' => [// Set your payload/uriParams fields config here. ['payload', 'group_id', Constants::$REQUIRED], // Required field ['payload', 'password'], // Optional field ['payload', 'client_id'], // Optional field ], '__SET__' => [//column => [uriParams|payload|function|readOnlySession|insertIdParams|{custom}, key|{value}], 'group_id' => ['payload', 'group_id'], 'password' => ['function', function() { return password_hash(HttpRequest::$input['payload']['password'], PASSWORD_DEFAULT); }], 'client_id' => ['readOnlySession', 'client_id'] ], '__WHERE__' => [// column => [uriParams|payload|function|readOnlySession|insertIdParams|{custom}, key|{value} 'id' => ['uriParams', 'id'] ], 'insertId' => 'tablename1:id',// Last insert id key name in $input['insertIdParams'][<tableName>:id]; 'subQuery' => [ 'module1' => [ 'query' => "MySQL Query here", '__SET__' => [ 'previous_table_id' => ['insertIdParams', '<tableName>:id'], ], '__WHERE__' => [], ], ... ], 'validate' => [ [ 'fn' => 'validateGroupId', 'fnArgs' => [ 'group_id' => ['payload', 'group_id'] ], 'errorMessage' => 'Invalid Group Id' ], ... ] ];

> Note: If there are modules or configurations repeated. One can reuse them by palcing them in a separate file and including as below.

  'subQuery' => [
    //Here the module1 properties are reused for write operation.
    'module1' => include DOC_ROOT . 'Config/Queries/ClientDB/Common/reusefilename.php',
  ]

> Note: For POST, PUT, PATCH, and DELETE methods we can configure both INSERT as well as UPDATE queries.

HTTP Request

GET Request

> One can clean the URL by making the required changes in the web server .conf file.

POST, PUT, PATCH, and DELETE Request

  • Single
    {"Payload":
      {
        "key1": "value1",
        "key2": "value2",
        ...
      }
    };
  • Multiple
    {"Payload":
      [
        {
          "key1": "value1",
          "key2": "value2",
          ...
        },
        {
          "key1": "value21",
          "key2": "value22",
          ...
        }
        ...
      ]
    };

Variables

  • HttpRequest::$input\['uriParams'\] Data passed in URI.

Suppose our configured route is /{table:string}/{id:int} and we make an HTTP request for /tableName/1 then $input\['uriParams'\] will hold these dynamic values as below.

  • HttpRequest::$input\['readOnlySession'\] Session Data.

This remains same for every request and contains keys like id, group\_id, client\_id

  • HttpRequest::$input\['payload'\] Request data.

For GET method, the $\_GET is the payload.

  • HttpRequest::$input\['insertIdParams'\] Insert ids Data as per configuration.

For POST/PUT/PATCH/DELETE we perform both INSERT as well as UPDATE operation. The insertIdParams contains the insert ids of the executed INSERT queries.

Hierarchy

  • Config/Queries/ClientDB/GET/Category.php

In this file one can confirm how previous select data is used recursively in subQuery select as indicated by useHierarchy flag.

    'parent_id' => ['hierarchyData', 'return:id'],
  • Config/Queries/ClientDB/POST/Category.php .Here a request can handle the hierarchy for write operations.
        // Configuration
        return [
          'query' => "INSERT INTO {$Env::$clientDB}.`category` SET SET",
          '__CONFIG__' => [
              ['payload', 'name', Constants::$REQUIRED],
          ],
          '__SET__' => [
              'name' => ['payload', 'name'],
              'parent_id' => ['custom', 0],
          ],
          'insertId' => 'category:id',
          'subQuery' => [
              'module1' => [
                'query' => "INSERT INTO {$Env::$clientDB}.`category` SET SET",
                '__CONFIG__' => [
                  ['payload', 'subname', Constants::$REQUIRED],
                ],
                '__SET__' => [
                  'name' => ['payload', 'subname'],
                  'parent_id' => ['insertIdParams', 'category:id'],
                ],
                'insertId' => 'sub:id',
              ]
          ],
          'useHierarchy' => true
        ];

  • Request - 1: Single object.
    {"Payload":
      {
        "name":"name",
        "module1":{
          "subname":"subname",
        }
      }
    }
  • Request - 2: Array of module1
    {"Payload":
      {
        "name":"name",
        "module1":[
          {
            "subname":"subname1",
          },
          {
            "subname":"subname2",
          },
          ...
        ]
      }
    }
  • Request - 3: Array of payload and arrays of module1
    {"Payload":
      [
        {
          "name":"name1",
          "module1":[
            {
              "subname":"subname1",
            },
            {
              "subname":"subname2",
            },
            ...
          ]
        },
        {
          "name":"name2",
          "module1":[
            {
              "subname":"subname21",
            },
            {
              "subname":"subname22",
            },
            ...
          ]
        },
        ...
      ]
    }

Route ending with /config

  • Adding keyword config at the end of route after a slash returns the payload information that should be supplied; both required and optional with desired format.

Examples:

  • r=/registration/config
  • r=/category/config

One need to configure for same in route with a flag as config => true

Only these configured routes will be supported the config feature.

  • For controlling globally there is a flag in env file labled allowConfigRequest

r=/routes

This lists down all allowed routes for HTTP methods respectively.

r=/check

Perform basic checks on Config folder.


  Files folder image Files  
File Role Description
Files folder imageApp (18 files, 2 directories)
Files folder imageConfig (2 directories)
Files folder imageCrons (1 file)
Files folder imageCustom (2 files)
Files folder imagepublic_html (1 file)
Files folder imageThirdParty (1 file)
Files folder imageValidation (2 files)
Accessible without login Plain text file .env.example Data Auxiliary data
Accessible without login Plain text file cache.sql Data Auxiliary data
Accessible without login Plain text file client_master.sql Data Auxiliary data
Accessible without login Plain text file global.sql Data Auxiliary data
Accessible without login Plain text file License Lic. License text
Plain text file Microservices.php Class Class source
Accessible without login HTML file README.html Doc. Documentation
Accessible without login Plain text file README.md Doc. Example script
Plain text file Start.php Class Class source

  Files folder image Files  /  App  
File Role Description
Files folder imageServers (2 directories)
Files folder imageValidation (2 files)
  Plain text file Api.php Class Class source
  Plain text file AppTrait.php Class Class source
  Plain text file CacheHandler.php Class Class source
  Plain text file Check.php Class Class source
  Plain text file Constants.php Class Class source
  Plain text file Env.php Class Class source
  Plain text file HttpRequest.php Class Class source
  Plain text file HttpResponse.php Class Class source
  Plain text file JsonDecode.php Class Class source
  Plain text file JsonEncode.php Class Class source
  Plain text file Login.php Class Class source
  Plain text file Logs.php Class Class source
  Plain text file Read.php Class Class source
  Plain text file Reload.php Class Class source
  Plain text file Routes.php Class Class source
  Plain text file Upload.php Class Class source
  Plain text file UrlDecodeFilter.php Class Class source
  Plain text file Write.php Class Class source

  Files folder image Files  /  App  /  Servers  
File Role Description
Files folder imageCache (4 files)
Files folder imageDatabase (3 files)

  Files folder image Files  /  App  /  Servers  /  Cache  
File Role Description
  Plain text file AbstractCache.php Class Class source
  Plain text file Cache.php Class Class source
  Plain text file MySQL.php Class Class source
  Plain text file Redis.php Class Class source

  Files folder image Files  /  App  /  Servers  /  Database  
File Role Description
  Plain text file AbstractDatabase.php Class Class source
  Plain text file Database.php Class Class source
  Plain text file MySQL.php Class Class source

  Files folder image Files  /  App  /  Validation  
File Role Description
  Plain text file Validator.php Class Class source
  Plain text file ValidatorTrait.php Class Class source

  Files folder image Files  /  Config  
File Role Description
Files folder imageQueries (2 directories)
Files folder imageRoutes (3 directories)

  Files folder image Files  /  Config  /  Queries  
File Role Description
Files folder imageClientDB (6 directories)
Files folder imageGlobalDB (6 directories)

  Files folder image Files  /  Config  /  Queries  /  ClientDB  
File Role Description
Files folder imageCommon (2 files)
Files folder imageDELETE (2 files)
Files folder imageGET (7 files)
Files folder imagePATCH (2 files)
Files folder imagePOST (3 files)
Files folder imagePUT (2 files)

  Files folder image Files  /  Config  /  Queries  /  ClientDB  /  Common  
File Role Description
  Accessible without login Plain text file Address.php Example Example script
  Accessible without login Plain text file Registration.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  ClientDB  /  DELETE  
File Role Description
  Accessible without login Plain text file Address.php Aux. Auxiliary script
  Accessible without login Plain text file Registration.php Aux. Auxiliary script

  Files folder image Files  /  Config  /  Queries  /  ClientDB  /  GET  
File Role Description
  Accessible without login Plain text file Address-all.php Aux. Auxiliary script
  Accessible without login Plain text file Address-single.php Aux. Auxiliary script
  Accessible without login Plain text file Category.php Example Example script
  Accessible without login Plain text file Registration-all.php Aux. Auxiliary script
  Accessible without login Plain text file Registration-single.php Aux. Auxiliary script
  Accessible without login Plain text file Registration.php Example Example script
  Accessible without login Plain text file SearchCategory.php Aux. Auxiliary script

  Files folder image Files  /  Config  /  Queries  /  ClientDB  /  PATCH  
File Role Description
  Accessible without login Plain text file Address.php Aux. Auxiliary script
  Accessible without login Plain text file Registration.php Aux. Auxiliary script

  Files folder image Files  /  Config  /  Queries  /  ClientDB  /  POST  
File Role Description
  Accessible without login Plain text file Address.php Aux. Auxiliary script
  Accessible without login Plain text file Category.php Example Example script
  Accessible without login Plain text file Registration.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  ClientDB  /  PUT  
File Role Description
  Accessible without login Plain text file Address.php Aux. Auxiliary script
  Accessible without login Plain text file Registration.php Aux. Auxiliary script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  
File Role Description
Files folder imageCommon (1 file)
Files folder imageDELETE (4 files)
Files folder imageGET (4 files)
Files folder imagePATCH (4 files, 3 directories)
Files folder imagePOST (4 files)
Files folder imagePUT (4 files)

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  Common  
File Role Description
  Accessible without login Plain text file Common.php Aux. Auxiliary script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  DELETE  
File Role Description
  Accessible without login Plain text file clients.php Example Example script
  Accessible without login Plain text file connections.php Example Example script
  Accessible without login Plain text file groups.php Example Example script
  Accessible without login Plain text file users.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  GET  
File Role Description
  Accessible without login Plain text file clients.php Example Example script
  Accessible without login Plain text file connections.php Example Example script
  Accessible without login Plain text file groups.php Example Example script
  Accessible without login Plain text file users.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  PATCH  
File Role Description
Files folder imageapprove (4 files)
Files folder imagedisable (4 files)
Files folder imageenable (4 files)
  Accessible without login Plain text file clients.php Example Example script
  Accessible without login Plain text file connections.php Example Example script
  Accessible without login Plain text file groups.php Example Example script
  Accessible without login Plain text file users.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  PATCH  /  approve  
File Role Description
  Accessible without login Plain text file clients.php Example Example script
  Accessible without login Plain text file connections.php Example Example script
  Accessible without login Plain text file groups.php Example Example script
  Accessible without login Plain text file users.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  PATCH  /  disable  
File Role Description
  Accessible without login Plain text file clients.php Example Example script
  Accessible without login Plain text file connections.php Example Example script
  Accessible without login Plain text file groups.php Example Example script
  Accessible without login Plain text file users.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  PATCH  /  enable  
File Role Description
  Accessible without login Plain text file clients.php Example Example script
  Accessible without login Plain text file connections.php Example Example script
  Accessible without login Plain text file groups.php Example Example script
  Accessible without login Plain text file users.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  POST  
File Role Description
  Accessible without login Plain text file clients.php Example Example script
  Accessible without login Plain text file connections.php Example Example script
  Accessible without login Plain text file groups.php Example Example script
  Accessible without login Plain text file users.php Example Example script

  Files folder image Files  /  Config  /  Queries  /  GlobalDB  /  PUT  
File Role Description
  Accessible without login Plain text file clients.php Example Example script
  Accessible without login Plain text file connections.php Example Example script
  Accessible without login Plain text file groups.php Example Example script
  Accessible without login Plain text file users.php Example Example script

  Files folder image Files  /  Config  /  Routes  
File Role Description
Files folder imageAdminGroup (5 files)
Files folder imageClient001UserGroup1 (5 files)
Files folder imageClient002UserGroup1 (5 files)

  Files folder image Files  /  Config  /  Routes  /  AdminGroup  
File Role Description
  Accessible without login Plain text file DELETEroutes.php Aux. Auxiliary script
  Accessible without login Plain text file GETroutes.php Aux. Auxiliary script
  Accessible without login Plain text file PATCHroutes.php Aux. Auxiliary script
  Accessible without login Plain text file POSTroutes.php Aux. Auxiliary script
  Accessible without login Plain text file PUTroutes.php Aux. Auxiliary script

  Files folder image Files  /  Config  /  Routes  /  Client001UserGroup1  
File Role Description
  Accessible without login Plain text file DELETEroutes.php Aux. Auxiliary script
  Accessible without login Plain text file GETroutes.php Aux. Auxiliary script
  Accessible without login Plain text file PATCHroutes.php Aux. Auxiliary script
  Accessible without login Plain text file POSTroutes.php Aux. Auxiliary script
  Accessible without login Plain text file PUTroutes.php Aux. Auxiliary script

  Files folder image Files  /  Config  /  Routes  /  Client002UserGroup1  
File Role Description
  Accessible without login Plain text file DELETEroutes.php Aux. Auxiliary script
  Accessible without login Plain text file GETroutes.php Aux. Auxiliary script
  Accessible without login Plain text file PATCHroutes.php Aux. Auxiliary script
  Accessible without login Plain text file POSTroutes.php Aux. Auxiliary script
  Accessible without login Plain text file PUTroutes.php Aux. Auxiliary script

  Files folder image Files  /  Crons  
File Role Description
  Plain text file Cron.php Class Cron class

  Files folder image Files  /  Custom  
File Role Description
  Plain text file Category.php Class Class source
  Plain text file CustomApi.php Class Class source

  Files folder image Files  /  public_html  
File Role Description
  Accessible without login Plain text file index.php Aux. Auxiliary script

  Files folder image Files  /  ThirdParty  
File Role Description
  Plain text file Google.php Class Class source

  Files folder image Files  /  Validation  
File Role Description
  Plain text file ClientValidator.php Class Class source
  Plain text file GlobalValidator.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:139
This week:0
All time:9,221
This week:28Up
User Comments (1)