muratymt/ignite-client

PHP Client for GridGain Community Edition

1.0.3 2022-06-20 09:59 UTC

README

Installation

The client requires PHP version 7.2 or higher (http://php.net/manual/en/install.php) and Composer Dependency Manager (https://getcomposer.org/download/).

The client additionally requires PHP Multibyte String extension. Depending on you PHP configuration you may need to additionally install/configure it (http://php.net/manual/en/mbstring.installation.php)

Installation from the PHP Package Repository

This is a recommended way for users. Run from your application root

composer require gridgain/gridgain-client

To use the client in your application, include vendor/autoload.php file, generated by Composer, to your source code, eg.

require_once __DIR__ . '/vendor/autoload.php';

Installation from Sources

This way is more suitable for developers or if you install client from zip archive.

  1. Download and/or unpack GridGain PHP client sources to gridgain_client_path
  2. Go to gridgain_client_path folder
  3. Execute composer install --no-dev command
cd gridgain_client_path
composer install --no-dev

To use the client in your application, include vendor/autoload.php file, generated by Composer, to your source code, eg.

require_once "<gridgain_client_path>/vendor/autoload.php";

Updating to newer version

To update version of client used in your project, just update version in your "require" section of composer.json and run the following command:

composer update gridgain/gridgain-client

Full Examples

PHP Thin Client contains examples to demonstrate the main behavior of the client.

Examples Installation

Examples are installed during installation of the whole GridGain client from sources.

Examples Setup and Running

  1. Run GridGain server - locally or remotely - if not run yet.

  2. If needed, modify ENDPOINT constant in an example source file - GridGain node endpoint. The default value is 127.0.0.1:10800.

  3. Run an example by calling php <example_file_name>.php, eg:

cd gridgain_client_path/examples
php CachePutGetExample.php

Refer to Examples ReadMe for detailed descriptions of examples.

For more information, see GridGain PHP Thin Client documentation.