windwalker/application

Windwalker Application package

Windwalker Application

Windwalker application is a kernel as main entry of your system., _(*1)

Installation via Composer

Add this to the require block in your composer.json., _(*2)

``` json { "require": { "windwalker/application": "~3.0" } }, <sub>(*3)</sub>

## Create An Application

Create application and extends the `doExecute()` method to something.

``` php
use Windwalker\Application\AbstractApplication;
use Windwalker\IO\Input;
use Windwalker\Structure\Structure;

class MyApplication extends AbstractApplication
{
    protected function init()
    {
        // Do stuff.

        // Get config
        $this->get('foo'); // bar
    }

    public function doExecute()
    {
        try
        {
            // Some code here...
        }
        catch (\Exception $e)
        {
            Error::renderErrorPage();
        }

        return true;
    }
}

$app = new MyApplication(new Structure(array('foo' => 'bar')));

$app->execute();

Config is Structure object, see Windwalker Structure, <sub>(*4)</sub>

WebApplication

AbstractWebApplication contains WebEnvironment and WenHttpServer object that help us handle HTTP request and output., <sub>(*5)</sub>

WebEnvironment

Use WebEnvironment to get information of browser or server., <sub>(*6)</sub>

``` php $this->environment->browser->getBrowser(); // Get browser name, <sub>(*7)</sub>

Use `Platform` to get server information.

``` php
$this->environment->platform->isUnix();

See: Environment Package, <sub>(*8)</sub>

PSR7 Handler

dispatch() is a standard PSR7 handler so we can write our logic here, just return Response object and the WebHttpServer object which in Application will render it to client., <sub>(*9)</sub>

``` php use Psr\Http\Message\ResponseInterface as Response; use Psr\Http\Message\ServerRequestInterface as Request; use Windwalker\Application\AbstractWebApplication;, <sub>(*10)</sub>

class MyHttpKernel extends AbstractWebApplication { public function dispatch(Request $request, Response $response, $next = null) { // Get request query $query = $request->getQueryParams();, <sub>(*11)</sub>

    // Get Psr Uri
    $uri = $request->getUri();

    // Write body
    $response->getBody()->write('<h1>Hello World~~~!</h1>');

    return $response;
}

}, <sub>(*12)</sub>

$app = new MyHttpKernel;, <sub>(*13)</sub>

$app->execute();, <sub>(*14)</sub>

Result:

``` html
<h1>Hello World~~~!</h1>

Error Handler

Set error handler as final handler so we can use it in dispatch()., <sub>(*15)</sub>

``` php class MyHttpKernel extends AbstractWebApplication { public function dispatch(Request $request, Response $response, $next = null) { try { throw new \Exception('Whoops~', 500); } catch (\Exception $e) { return $next($e, $request, $response); }, <sub>(*16)</sub>

    return $response;
}

}, <sub>(*17)</sub>

$app = new MyHttpKernel;, <sub>(*18)</sub>

$app->setFinalHandler(function (Exception $e, Request $request, Response $response) { $response->getBody()->write(sprintf(', <sub>(*19)</sub>

Error %s. Message: %s

', $e->getCode(), $e->getMessage())); });, <sub>(*20)</sub>

$app->execute();, <sub>(*21)</sub>

Result:

``` html
<h1>Error 500. Message: Whoops~</h1>

See Windwalker Http Package, <sub>(*22)</sub>

Cli Application

This is a example of a simple cli application., <sub>(*23)</sub>

``` php // app.php, <sub>(*24)</sub>

use Windwalker\Application\AbstractCliApplication;, <sub>(*25)</sub>

class MyCliApp extends AbstractCliApplication { public function doExecute() { // Get options (-h) $help = $this->io->get('h');, <sub>(*26)</sub>

    if ($help)
    {
        $msg = <<<MSG

Help message: version 1.0

myapp.php [-options], <sub>(*27)</sub>

foo Description of this command. bar Description of this command. help Description of this command. MSG;, <sub>(*28)</sub>

        $this->io->out($msg);

        $this->close();
    }

    // Get arguments
    $arg = $this->getArgument(0);

    // Do some stuff...

    return 0; // Exit code 0 means success
}

}, <sub>(*29)</sub>

$app = new MyCliApp;, <sub>(*30)</sub>

$app->execute();, <sub>(*31)</sub>

Now we can access this app by PHP CLI:

``` bash
php app.php arg1 arg2 -h --option --foo bar --n=a

See: Windwalker IO, <sub>(*32)</sub>