Jaxon

•    Version 4.x
•    Version 3.x
•    Version 2.x

The configuration

The app.classes section of the Armada configuration contains an array of directories where the classes to be registered are found. Each entry of the array represents a directory, defined with the following informations:

• directory : the full path to the directory.
• namespace : the associated namespace.
• separator : optional, the separator to be used in javascript class names, can be . (by default) or _.
• protected : optional, an array of methods that are not to be exported in javascript classes, empty by default.

This array must always contain at least one entry. The following code is an excerpt from the example of using Armada.

    'app' => array(
        'classes' => array(
            array(
                'directory' => dirname(__DIR__) . '/classes',
                'namespace' => '\\Jaxon\\App',
                // 'separator' => '.',
                // 'protected' => [],
            ),
        ),
    ),

The options of the Jaxon requests can be defined in the app.options.classes of the configuration file.

    'app' => [
        'options' => [
            'classes' => [
                \Jaxon\App\Test\Bts::class => [
                    '*' => [
                        'mode' => "'asynchronous'",
                    ]
                ]
            ],
        ],
    ],

The Jaxon\Sentry\Armada class

The classes of an Armada application must inherit from the Jaxon\Sentry\Armada class, which provides them with functions to access other classes, and to manage requests, responses, views and sessions.

The instance() method (or its short version cl()) returns an instance of another Jaxon class in the same namespace. It takes the name of the class as a parameter, without the namespace.

For example, the instance of the \Namespace\Subdir\Class class in namespace Namespace will be returned by the following call.

$myClass = $this->instance(':Subdir.Class');

If both classes are in the same subdirectory, this can be omitted, and the class name is prepended with a period.

$myClass = $this->instance('.Class');

The Response object

All instances of the classes registered in a Armada application have access to the same Response object, through their response attribute. This object is automatically initialized by the library, and allows to build the response to a request by calling several methods in one or more classes.

class ClassA extends \Jaxon\Sentry\Armada
{
    public function doA()
    {
        $this->response->alert('ClassA::doAB() called.');
        // Call the doB() method of this class
        $this->doB();
        return $this->response;
    }

    public function doB()
    {
        $this->response->alert('ClassA::doB() called.');
        // Call the doB() method of class ClassB
        $this->instance('.ClassB')->doB();
        return $this->response;
    }
}

class ClassB extends \Jaxon\Sentry\Armada
{
    public function doB()
    {
        $this->response->alert('ClassB::doB() called.');
        return $this->response;
    }
}

The Request Factory

The request() method (or its short version rq()) returns a request to its calling class. It provides a fluid interface that transforms any received call into a request to the method with the same name in the caller class.

class ClassA extends \Jaxon\Sentry\Armada
{
    public function doA()
    {
        // Bind the click on the button with id "btn-a" to a call to the doB() method in this class
        $this->response->onClick('btn-a', $this->rq()->doB());

        // Bind the click on the button with id "btn-b" to a call to the doB() method in class ClassB
        $this->response->onClick('btn-b', $this->ct('.ClassB')->rq()->doB());
        return $this->response;
    }
}

The contents of the webpage can be passed as parameters to calls using the Request Factory or the PHP jQuery API, and their global functions rq() and jq().

class ClassA extends \Jaxon\Sentry\Armada
{
    public function doA()
    {
        // Parameter using the Request Factory
        $this->response->onClick('btn-a', $this->rq()->doB(rq()->form('form-user')));

        // Parameter using the PHP jQuery API
        $this->response->onClick('btn-b', $this->ct('.ClassB')->rq()->doB(jq('#username')->val()));
        return $this->response;
    }
}

The jQuery PHP API

The jQuery() method (or its short version jq()) adds a call to jQuery into the response.

class ClassA extends \Jaxon\Sentry\Armada
{
    public function doA()
    {
        // Bind the click on the button with id "btn-a" to a call to the doB() method in this class
        $this->jQuery('#btn-a')->click($this->rq()->doB(rq()->form('form-user')));

        // Bind the click on the button with id "btn-b" to a call to the doB() method in class ClassB
        $this->jQuery('#btn-b')->click($this->ct('.ClassB')->rq()->doB(jq('#username')->val()));
        return $this->response;
    }
}

The $this->jQuery() call is the same as $this->response->jQuery().

The pagination

The paginator() method (or its short version pg()) creates pagination links with calls to a method of a Jaxon class.

class ClassA extends \Jaxon\Sentry\Armada
{
    public function doA($pageNumber)
    {
        // Insert the pagination links into the page
        $pagination = $this->paginator($totalPages, $itemsPerPage, $currentPage)->doA(rq()->page());
        $this->response->assign('pagination-links', 'innerHTML', $pagination);
        return $this->response;
    }
}

With Armada, the pagination links can be printed using any template engine (see the views documentation). In order to customize the pagination, create all the required templates in a directory, and then change the views configuration accordingly.

        'views' => array(
            'pagination' => array(
                'directory' => '/path/to/the/directory',
                'extension' => '.tpl',
                'renderer' => 'smarty',
            ),
        ),

For example, this is the content of the /path/to/the/directory/wrapper.tpl, which is a Smarty template.

{if !empty($prev)}
{$prev}
{/if}
{$links}
{if !empty($next)}
{$next}
{/if}