/everscale-client-php-ext

PHP extension for TON-SDK Client

Primary LanguageCApache License 2.0Apache-2.0

PHP Extension for TON SDK Wrapper

Community links:

Chat on Telegram

Supported platforms

  • Windows x86, x64
  • Linux
  • macOS

Installation

See Installation notes.

Development

See Development notes.

Functions

The following functions are added by this extension:

string ton_create_context( string $config_json );

Creates new TON client context.

Parameters:

  • $config_json - TON client configuration.

Return value:

JSON containing context ID.

void ton_destroy_context( int $context );

Destroys TON client context.

Parameters:

  • $context - Context ID previously returned by ton_create_context.
string ton_request_sync( int $context, string $function_name, string $params_json);

Runs TON SDK request synchronously (using tc_request_sync).

Parameters:

  • $context - Context ID previously returned by ton_create_context.
  • $function_name - name of the TON SDK function to call.
  • $params_json - JSON-encoded function params.

Return value:

JSON response.

resource ton_request_start( int $context, string $function_name, string $params_json );

Runs TON SDK request asynchronously using tc_request_ptr.

Parameters:

  • $context - Context ID previously returned by ton_create_context.
  • $function_name - name of the TON SDK function to call.
  • $params_json - JSON-encoded function params.

Return value:

Request handle.

int ton_request_id( resource $resource );

Parameters:

  • $request - Request handle previously returned by ton_request_start.

Return value:

Request unique identifier.

array ton_request_next( resource $request, [ int $timeout ] );

Fetches the next async event.

Parameters:

  • $request - Request handle previously returned by ton_request_start.
  • $timeout - Timeout in milliseconds (optional).

Return value:

Array containing these values:

 [ string $json, int $status, bool $finished, int $id ]

$json is always containing callback data unless it's a return value for a function which returns nothing (like net.unsubscribe_collection).

$status corresponds to the tc_response_types enum defined in tonclient.h;

When request is finished $finished will be true.

$id is an identifier of request. Can be used together with ton_request_join to identify which of the joined requests are receiving this data.

bool ton_request_join( resource $request, resource $request2 )

Sets $request to receive all events of $request2. Used for example to process app requests by $request2, while fetching events for $request via ton_request_next.

Call ton_request_disconnect to undo this.

Parameters:

  • $request - Request handle previously returned by ton_request_start.
  • $request2 - Another request handle previously returned by ton_request_start.

Return value:

true if join was successful, false otherwise.

bool ton_request_disconnect( resource $request, resource $request2 )

Sets $request to no more receive events of $request2. Used as an opposite operation to ton_request_join.

Parameters:

  • $request - Request handle previously returned by ton_request_start.
  • $request2 - Another request handle previously returned by ton_request_start.

Return value:

true if disconnect was successful, false otherwise.

?bool is_ton_request_finished( resource $request )

Checks whether the TON SDK request is finished.

Parameters:

  • $request - Request handle previously returned by ton_request_start.

Return value:

true if request has been finished, false if not, and null if invalid $request handle is passed to the function arguments.

Implementation notes

This extension uses threads and blocking queues to work with TON SDK functions and callbacks. ton_request_next is the only blocking call here, all other functions are instant.

Extension is supposed to work in both Thread-Safe and Non-Thread safe environments.

License

Apache License, Version 2.0.

Troubleshooting

Fire any question to our Telegram channel.