fm_ph/quark

Quark server

![packagist version][packagist-image] ![php-version][php-version-image] ![composer.lock][composer-lock-image], _(*1)

Server part of quark framework handling mainly the routing and templating., _(*2)

Features

• Routing : Methods, regex parameters, redirect, locale.
• Templating : Twig (layouts, cache, customs extensions, filters, globals...).
• Locale : IP address detection (Geocoder with providers chain), fallback to prefered browser locale.
• User agent : Browser, engine, operating system, device, bot and old browser detection.
• Manifest : Assets hash, environment.
• Configuration : Supports PHP, INI, XML, JSON, and YAML file formats.
• Others : Error handler, function helpers.

Installation

Get Composer and run :, _(*3)

composer require fm_ph/quark

Note : You need at least __PHP 7.x__ (CLI) installed on your machine to use this package (verify it with php -v)., _(*4)

For OS X users, you can easily update it on https://php-osx.liip.ch/., _(*5)

Usage

Basic

Get an Application singleton instance and render matched route template., _(*6)

<?php

define('BASE_PATH', __DIR__);

// Require Composer autoloader
require BASE_PATH . '/vendor/autoload.php';

// Get Application instance and init
$app = Quark\Application::getInstance();
$app->init();

// Render
echo $app->render();

Custom configuration

Init Application with custom configuration., _(*7)

<?php

// ...

// Custom configuration
$config = [
  'locale' => [
    'code' => 'fr',
    'redirectIfOne' => true
  ]
]

// Get Application instance
$app = Quark\Application::getInstance();

// Init with custom configuration array
$app->init($config);

Configuration

All configuration properties that can be passed to init() method on an Application instance., _(*8)

Old browser

Locale

Paths

Twig

API

See https://fm-ph.github.io/quark-server/, _(*9)

Testing

Install PHPUnit globally :, _(*10)

composer global require phpunit/phpunit

And run the tests with :, _(*11)

phpunit

License

MIT License © Patrick Heng Fabien Motte, _(*12)