opencomponents/oc-client-php

PHP client for OpenComponents

oc-client-php

PHP client for OpenComponents

For a nodejs implementation check this link. This library is heavily based on it.

Install

composer require opencomponents/oc-client-php

Quickstart

use OpenComponents\Client;

// Initializing the client
$client = new Client(array(
    "serverRendering" => 'https://your-components.repository.com/'
));

// Render some component
$components = $client->renderComponents(array(
    array(
        'name' => 'your-amazing-widget',
        'parameters' => array(
            'param1' => 'hello opencomponents!',
            'param2' => 'just show me the component'
        )
    ),
    array(
        'name' => 'one-more-component'
    )
));

// Print the rendered component and volià
echo $components['html'];

Running tests

composer test

oc-client-php's Issues

Allow to instantiate Client withouth initial components

Allowing to specify component version

Improve documentation

Write some sort of quickstart and basic usage of the library.

Improve error handling

Right now, if you try to select a non-existent widget from the registry, the client will fail crashing in ComponentDataRetriever.php@43.

We should handle errors somehow.

Ensure PHP 5.6 compatibility

We should ensure php5.6 compatibility for all those legacy projects that needs to include components.