Plugin Architecture

From FreemedDeveloperWiki, the FreeMED developers' Wiki.

This is a draft of the external plugin architecture debuting in FreeMED 0.8.0. Things may, and probably will, change.

Contents 1 Overview 2 Commands 2.1 Common Commands 2.1.1 INFO

Overview

The external plugin architecture is an attempt to get FreeMED to be able to harness the power of external applications, most probably in languages other than PHP. This is accomplished by calling the programs with a relatively simple command syntax, and expecting a certain type of result. The syntax of any plugin is:

 plugin COMMAND [ optional options ]

They are placed in an arbitrary directory, where they are indexed. Each directory can hold one type of plugin.

Commands

Common Commands

These commands are used by all modules.

INFO

• Syntax: INFO
• Returns: Information about the module
• Example:

 NAME: Test Module
 DESCRIPTION: Communicate with test insurance authorization source
 AUTHOR: Joe Schmoe
 VERSION: 1.0
 API: 0.1
 TYPE: InsuranceAuthorization