krinkle/toollabs-base

Framework for web apps in Wikimedia's Toolforge environment.

v1.0.0 2018-07-15 23:18 UTC

README

Packagist Build Status

Tool Labs Base

Install

It's recommended you use Composer.

  • Run composer require Krinkle/toollabs-base.
  • Create a symlink from "base/" in your application's root public directory (e.g. public_html) to vendor/krinkle/toollabs-base/public_html.
  • Include vendor/autoload.php in your program.

Example

require_once __DIR__ . '/vendor/autoload.php';
// require_once __DIR__ . '/config.php';

$kgBase = BaseTool::newFromArray( array(
	'displayTitle' => 'Example',
	'remoteBasePath' => dirname( $_SERVER['PHP_SELF'] ),
) );
$kgBase->flushMainOutput();

See Template for an example.

Versioning

This library follows the Semantic Versioning guidelines.

Releases will be numbered in the following format: <major>.<minor>.<patch>.