README

PHP bindings for Loro, built with UniFFI and PHP FFI.

Requirements

• PHP 8.1+
• ext-ffi
• ffi.enable=1

Install

composer require huanghantao/loro-php

Composer will ask whether huanghantao/loro-php may run as a plugin. Allow it to download the native library for your platform.

For CI:

composer config allow-plugins.huanghantao/loro-php true
composer require huanghantao/loro-php

To use your own native library instead:

export LORO_PHP_LIBRARY=/absolute/path/to/libloro_php.dylib

Usage

<?php

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

use Loro\LoroDoc;

$doc = new LoroDoc();
$text = $doc->getText('text');

$text->insert(0, 'Hello, Loro');
$doc->commit();

echo $text->slice(0, $text->lenUnicode());

Run PHP with FFI enabled:

php -d ffi.enable=1 example.php

Development

composer install
./scripts/build_php_ffi.sh
LORO_PHP_LIBRARY="$(pwd)/rust/target/release/libloro_php.dylib" composer test
composer cs-fix

Release

Tag a release and push it. The GitHub workflow builds native libraries and uploads loro-php-native-<platform>.tar.gz plus checksum files.

git tag -a v0.1.0 -m "Release v0.1.0"
git push origin v0.1.0

Set LORO_PHP_SKIP_NATIVE_INSTALL=1 to skip native download, or LORO_PHP_NATIVE_RELEASE=<tag> to force a native artifact tag.