Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.85 KB

README.md

File metadata and controls

51 lines (36 loc) · 1.85 KB

Basic lib to write PPP modules in PHP

Build Status Code Coverage Scrutinizer Code Quality

On Packagist: Latest Stable Version Download count

Installation

Use one of the below methods:

1 - Use composer to install the library and all its dependencies using the master branch:

composer require "ppp/libmodule":"dev-master"

2 - Create a composer.json file that just defines a dependency on version 0.2 of this package, and run 'composer install' in the directory:

{
    "require": {
        "ppp/ppp/libmodule"": "~0.2.0"
    }
}

Example

Here is a small usage example:

// Load everything
require_once(__DIR__ . "/vendor/autoload.php");

// A very simple class implementing RequestHandler interface
class MyRequestHandler implements PPP\Module\RequestHandler {
	public function buildResponse(PPP\Module\DataModel\ModuleRequest $request) {
		return new PPP\Module\DataModel\ModuleResponse(
			$request->getLanguageCode(),
			new PPP\DataModel\MissingNode(),
			0
		);
	}
}

// Lets run the entry point!
$entryPoint = new PPP\Module\ModuleEntryPoint(new MyRequestHandler());
$entryPoint->exec();