Jaxon

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

Before a PHP class or function can be called from javascript, it must first be registered. The register() function of Jaxon is used for that purpose.

A function is registered with Jaxon by calling the register() function with the Jaxon::CALLABLE_FUNCTION parameter.

use Jaxon\Jaxon;
use function Jaxon\jaxon;

function hello_world($isCaps)
{
    $response = jaxon()->newResponse();
    $text = ($isCaps) ? 'HELLO WORLD!' : 'Hello World!';
    $response->assign('div2', 'innerHTML', $text);
    return $response;
}

$jaxon = jaxon();
$jaxon->register(Jaxon::CALLABLE_FUNCTION, "hello_world");

After it is registered, the function can be called from javascript with the name jaxon_hello_world(). The prefix jaxon_ is defined using the core.prefix.function configuration option.

Here's the code that Jaxon will generate and send to the browser.

jaxon_hello_world = function() {
    return jaxon.request(
        { jxnfun: 'helloWorld' },
        { parameters: arguments }
    );
};

Here is an example of HTML code that calls the PHP function registered with Jaxon.

<input type="button" value="Say Hello" onclick="jaxon_hello_world(0)" />

The javascript function name can be changed to an alias.

$jaxon->register(Jaxon::CALLABLE_FUNCTION, "hello_world", ["alias" => "sayHello"]);

<input type="button" value="Say Hello" onclick="jaxon_sayHello(0)" />

A method of a class can also be registered as a function. In this case, the class name is passed to the register() call, as in the following example.

use Jaxon\Jaxon;
use function Jaxon\jaxon;

class HelloWorld
{
    public function hello_world($isCaps)
    {
        $response = jaxon()->newResponse();
        $text = ($isCaps) ? 'HELLO WORLD!' : 'Hello World!';
        $response->assign('div2', 'innerHTML', $text);
        return $response;
    }
}

$jaxon->register(Jaxon::CALLABLE_FUNCTION, "hello_world", ["class" => HelloWorld::class]);

<input type="button" value="Say Hello" onclick="jaxon_hello_world(0)" />

An alias can also be defined.

$jaxon->register(Jaxon::CALLABLE_FUNCTION, "hello_world", ["class" => HelloWorld::class, "alias" => "sayHello"]);

<input type="button" value="Submit" onclick="jaxon_sayHello()" />