plinker/core

PlinkerRPC PHP client/server makes it really easy to link and execute PHP component classes on remote systems, while maintaining the feel of a local method call.

Wednesday, May 23, 2018
by lcherone
Repository
2 Watchers
1 Stars
828 Installations

PHP
12 Dependents
0 Suggesters
0 Forks
0 Open issues
100 Versions
47 % Grown

The README.md

PlinkerRPC - Core

, _(*1)

PlinkerRPC PHP client/server makes it really easy to link and execute generic PHP components on remote systems, while maintaining the feel of a local method call., _(*2)

Docs: https://plinker-rpc.github.io/core, _(*3)

New changes in version 3 include:, _(*4)

Now compaible with PHP extension.
Built-in core components and info method added so components can be discovered.
Only one client instance is now needed, made use of __get() to dynamically set component.
User defined components/classes, so you can call your own code.
Both request and response is encrypted and signed.

Install

Require this package with composer using the following command:, _(*5)

``` bash $ composer require plinker/core, _(*6)


### Additional Setup

This component does not require any additional setup.

## Client

Creating a client instance is done as follows:


    <?php
    require 'vendor/autoload.php';

    /**
     * Initialize plinker client.
     *
     * @param string $server - URL to server listener.
     * @param string $config - server secret, and/or a additional component data
     */
    $client = new \Plinker\Core\Client(
        'http://example.com/server.php',
        [
            'secret' => 'a secret password',
        ]
    );

    // or using global function
    $client = plinker_client('http://example.com/server.php', 'a secret password');


## Server

Creating a server listener is done as follows:

**Optional features:**

 - Set a secret, which all clients will require. 
 - Lock down to specific client IP addresses for addtional security.
 - Define your own classes in the `classes` array then access like above `$client->class->method()`, which can interface out of scope components or composer packages.
 - Define addtional key values for database connections etc, or you could pass the parameters through the client connection.



    <?php
    require 'vendor/autoload.php';

    /**
     * Initialize plinker server.
     */
    if (isset($_SERVER['HTTP_PLINKER'])) {
        // init plinker server
        echo (new \Plinker\Server([
            'secret' => 'a secret password',
            'allowed_ips' => [
                '127.0.0.1'
            ],
            'classes' => [
                'test' => [
                    // path to file
                    'classes/test.php',
                    // addtional key/values
                    [
                        'key' => 'value'
                    ]
                ],
                // you can use namespaced classes
                'Foo\\Demo' => [
                    // path to file
                    'some_class/demo.php',
                    // addtional key/values
                    [
                        'key' => 'value'
                    ]
                ],
                // ...
            ]
        ]))->listen();
    }


## Methods

Once setup, you call the class though its namespace to its method.


### Info

The info method returns defined endpoint methods and their parameters.

**Call**

$result = $client->info();, _(*7)


**Response**

Array ( [class] => Array ( [Foo\Demo] => Array ( [config] => Array ( [key] => value ), _(*8)

                [methods] => Array
                    (
                        [config] => Array
                            (
                            )

                        [this] => Array
                            (
                            )

                        [test] => Array
                            (
                                [0] => x
                                [1] => y
                            )

                    )

            )

    )

), _(*9)


## Testing

``` bash
$ composer test

Contributing

Please see CONTRIBUTING for details., _(*10)

Security

If you discover any security related issues, please contact me via https://cherone.co.uk instead of using the issue tracker., _(*11)

Credits

Development Encouragement

If you use this code and make money from it and want to show your appreciation, please feel free to make a donation https://www.paypal.me/lcherone, thanks., _(*12)

License

The MIT License (MIT). Please see License File for more information., _(*14)

See organisations page for additional components., _(*15)

The Versions

23/05 2018

dev-master

9999999-dev https://github.com/lcherone/plinker-core

PlinkerRPC PHP client/server makes it really easy to link and execute PHP component classes on remote systems, while maintaining the feel of a local method call.

library core

PlinkerRPC PHP client/server makes it really easy to link and execute PHP component classes on remote systems, while maintaining the feel of a local method call.

plinker/core

The README.md

PlinkerRPC - Core

Install

Contributing

Security

Credits

Development Encouragement

Sponsors

License

The Versions

dev-master

The Requires

The Development Requires

by Lawrence Cherone

v3.1.9

The Requires

The Development Requires

by Lawrence Cherone

v3.1.8

The Requires

The Development Requires

by Lawrence Cherone

v3.1.7

The Requires

The Development Requires

by Lawrence Cherone

v3.1.6

The Requires

The Development Requires

by Lawrence Cherone

v3.1.5

The Requires

The Development Requires

by Lawrence Cherone

v3.1.4

The Requires

The Development Requires

by Lawrence Cherone

v3.1.3

The Requires

The Development Requires

by Lawrence Cherone

v3.1.2

The Requires

The Development Requires

by Lawrence Cherone

v3.1.1

The Requires

The Development Requires

by Lawrence Cherone

v3.1.0

The Requires

The Development Requires

by Lawrence Cherone

v3.0.14

The Requires

The Development Requires

by Lawrence Cherone

v3.0.13

The Requires

The Development Requires

by Lawrence Cherone

v3.0.12

The Requires

The Development Requires

by Lawrence Cherone

v3.0.11

The Requires

The Development Requires

by Lawrence Cherone

v3.0.10

The Requires

The Development Requires

by Lawrence Cherone

dev-analysis-qgNnnd

The Requires

The Development Requires