topics.scriptlets · xp-framework/xp-framework Wiki · GitHub
Skip to content
This repository was archived by the owner on Apr 5, 2020. It is now read-only.

topics.scriptlets

Jump to bottom
Alex Kiesel edited this page Jun 7, 2012 · 7 revisions

WEB

Everything that runs in the web in the XP Framework, is a scriptlet, at the beginning. Every higher-class API is derived from the simple `HttpScriptlet` class: `SoapRpcRouter`, `WorkflowScriptlet`, ...

The HttpScriptlet class

The scriptlet.HttpScriptlet class is the base class for any so-called scriptlet. A scriptlet is something that can serve HTTP requests.

The simplest form of answering an HTTP request in XP Framework goes like this:

<?php
  uses('scriptlet.HttpScriptlet');
  
  class MyScriptlet extends HttpScriptlet {
  
    /**
     * Perform GET request
     *
     * @param   scriptlet.HttpScriptletRequest request
     * @param   scriptlet.HttpScriptletResponse response
     * @throws  scriptlet.HttpScriptletException
     */
    public function doGet($request, $response) {
      $response->write('<html>
        <head><title>Hello World scriptlet</title></head>
        <body>
          <h1>Hello %s</h1>
        </body>
        </html>
        ',
        $request->getParam('name', 'World')
      );
    }
  }
?>

This code generates a HTML page that shows a headline "Hello World" or "Hello $something" when something was given as GET-parameter "name".

Override doPost() or any of the other methods named after HTTP request types to serve these request types, as well.

Clone this wiki locally