README

PHP Bridges allows you to interact with a designated php object in javascript without having to deal with routing and marshalling arguments. Spend less time writing boilerplate and fiddling with frameworks, spend more time developing your idea.

An example php object

class MyController {
    function performSomeAction($argument1, $argument2) {
        // ...
    }
}

Interacting with this object in javascript:

var result = await api.performSomeAction(arg1, arg2);

By adding:

PhpBridge\Bridge::serve(MyController::class)

Usage:

PhpBridge is a library and comes with an executable for quickly spinning up local prototypes.

Using the phpbridge executable

PhpBridge will launch a webserver on an available port serving the file (or directory) you specified. It will autoload PhpBridge and provide the bridge function so you can write: It will automatically

./vendor/bin/phpbridge file.php [--port=1234] [--no-browser]

// file.php
<?php
bridge(MyController::class);

class MyController {
    function fn() { } 
}
?>
<button onclick="execute()">Execute</button>
<script>
    async function execute() { 
        var result = await api.fn();
        alert(result);
    }
</script>

Using the library:

<?php


class MyController {
    function fn() { } 
}

$bridge = PhpBridge\Bridge::to(Mycontroller);
$bridge->interrupt();

// Will write <script>window.api = .... </script>
echo $bridge->output('script');
?>

<button onclick="execute()">Execute</button>
<script>
    async function execute() { 
        var result = await api.fn();
        alert(result);
    }
</script>

Installation

Via composer

composer require j-angnoe/php-bridge

Api

PhpBridge\Bridge::to($targetClass) - Create a bridge instance and provide it with a target class (classname or object)

PhpBridge\Bridge::interrupt() - Allow PHP Bridge to interrupt the current script's flow to handle the api calls. Call interrupt before starting output.

PhpBridge\Bridge::output($flags) - Get a copy of the javascript client for your target class.

Features

PhpBridge\Bridge protects calls with a client/csrf method. This is to prevent any non-browser client to interact with your code via the bridge. In order to benefit from this added layer of security you should make sure a php is started prior to calling interrupt. The phpbridge binary does this for you.

The javascript client requires a browser to have the fetch method.

Examples:

Can be found in ./examples/

j-angnoe / php-bridge

Maintainers

Details