Awesome
php-wasm
PHP in WebAssembly, npm not required.
npm | github | unpkg | reddit | discord
🌟 v0.0.9-alpha - Aiming for the (GitHub) Stars
- Adding PHP-CGI support!
- Runtime extension loading!
- libicu, freetype, zlib, gd, libpng, libjpeg, openssl, & phar support.
- php-wasm, php-cgi-wasm, & php-wasm-builder are now separate packages.
- Vrzno now facilitates url fopen via the fetch() api.
- pdo_cfd1 is now a separate extension from Vrzno.
- pdo_pglite adds local Postgres support.
- SQLite is now using version 3.46.
- Demos for CodeIgniter, CakePHP, Laravel & Laminas.
- Drupal & all other demos now use standard build + zip install.
- Modules are now webpack-compatible out of the box.
- Exposing FS methods w/queueing & locking to sync files between tabs & workers.
- Fixed the bug with POST requests under Firefox.
- Adding support for PHP 8.3.7
- Automatic CI testing for PHP 8.0, 8.1, 8.2 & 8.3.
Installing php-wasm:
$ npm i php-wasm@alpha
Installing php-cgi-wasm:
$ npm i php-cgi-wasm@alpha
Installing php-wasm-builder:
$ npm i php-wasm-builder@alpha
☀️ Examples
[React + php-web/php-cgi-worker demo]
<table> <tr> <td width = "500px"> <a href = "https://seanmorris.github.io/php-wasm/install-demo.html?framework=drupal-7">Drupal Demo</a> </td> <td width = "500px"> <a href = "https://seanmorris.github.io/php-wasm/install-demo.html?framework=cakephp-5">CakePHP Demo</a> </td> <td width = "500px"> <a href = "https://seanmorris.github.io/php-wasm/install-demo.html?framework=codeigniter-4">CodeIgniter Demo</a> </td> <td width = "500px"> <a href = "https://seanmorris.github.io/php-wasm/install-demo.html?framework=laravel-11">Laravel Demo</a> </td> <td width = "500px"> <a href = "https://seanmorris.github.io/php-wasm/install-demo.html?framework=laminas-3">Laminas Demo</a> </td> <td width = "500px"> <a href = "https://seanmorris.github.io/php-wasm/code-editor.html?path=/persist">Code Editor</a> </td> </tr> </table> <table> <tr> <td width = "500px" border = "0"> <ul> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250Aecho%2520%2522Hello%252C%2520World%21%2522%253B%250A&autorun=1&persist=0&single-expression=0&render-as=text">Hello World!</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522html%2522%257D%250Aphpinfo%28%29%253B%250A&autorun=1&persist=0&single-expression=0&render-as=html">phpinfo();</a></li> <li><a href = "https://seanmorris.github.io/php-wasm?render-as=text&autorun=1&persist=1&single-expression=0&code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Atrue%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%2524setup%2520%253D%2520%2524setup%2520%253F%253F%2520false%253B%250A%2524x%2520%253D%2520%2524x%2520%253F%253F%25200%253B%250A%250Avar_dump%28%2524x%29%253B%250A%250Aif%28%21%2524setup%29%250A%257B%250A%2520%2520%2520%2520%2524window%2520%253D%2520new%2520Vrzno%253B%250A%250A%2520%2520%2520%2520%2524f%2520%253D%2520%2524window-%253EphpFuncA%2520%253D%2520function%28%29%2520use%28%2526%2524x%252C%2520%2524window%29%2520%257B%250A%2520%2520%2520%2520%2520%2520%2520%2520%2524window-%253Ealert%28%27RAN%2520A%21%2520%27%2520.%2520%2524x%252B%252B%29%253B%250A%2520%2520%2520%2520%257D%253B%250A%2520%2520%2520%2520%250A%2520%2520%2520%2520%2524g%2520%253D%2520%2524window-%253EphpFuncB%2520%253D%2520function%28%29%2520use%28%2526%2524x%252C%2520%2524window%29%2520%257B%250A%2520%2520%2520%2520%2520%2520%2520%2520echo%2520%27%2524x%2520is%2520now%2520%27%2520.%2520%28%252B%252B%2524x%29%2520.%2520PHP_EOL%253B%250A%2520%2520%2520%2520%257D%253B%250A%2520%2520%2520%2520%250A%2520%2520%2520%2520%2524setup%2520%253D%2520true%253B%250A%2520%2520%2520%2520%250A%2520%2520%2520%2520echo%2520%2522Initialized.%255Cn%2522%253B%250A%257D%250A%250A%2524window-%253EphpFuncA%28%29%253B%250A%252F%252F%2520%2524window-%253EphpFuncB%28%29%253B%250A%250A%252F%252F%2520vrzno_eval%28%27window.phpFuncA%28%29%27%29%253B%250Avrzno_eval%28%27window.phpFuncB%28%29%27%29%253B%250A">Javascript Callbacks</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Atrue%252C%2520%2522single-expression%2522%253A%2520true%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%252F%252F%2520run%2520this%2520over%2520and%2520over%2520again%250A%2524c%2520%253D%25201%2520%252B%2520%28%2524c%2520%253F%253F%2520-1%29%253B%250A%250Aprint%2520%2524c%253B%250A&autorun=1&persist=1&single-expression=1&render-as=text">Persistent Memory</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%2524oldTitle%2520%253D%2520NULL%253B%250A%2524newTitle%2520%253D%2520%27Changed%2540%27%2520.%2520date%28%27h%253Ai%253As%27%29%253B%250A%250A%252F%252F%2520Grab%2520the%2520current%2520title%250A%2524oldTitle%2520%253D%2520vrzno_eval%28%27document.title%27%29%253B%250A%250A%252F%252F%2520Change%2520the%2520document%2520title%250A%2524newTitle%2520%253D%2520vrzno_eval%28%27document.title%2520%253D%2520%2522%27%2520.%2520%2524newTitle%2520.%2520%27%2522%27%2520%29%253B%250A%250Aprintf%28%250A%2509%27Title%2520changed%2520from%2520%2522%2525s%2522%2520to%2520%2522%2525s%2522.%27%250A%2509%252C%2520%2524oldTitle%250A%2509%252C%2520%2524newTitle%250A%29%253B%250A%250A%250A%252F%252F%2520Show%2520an%2520alert%250Avrzno_run%28%27alert%27%252C%2520%255B%27Hello%252C%2520World%21%27%255D%29%253B%250A&autorun=1&persist=0&single-expression=0&render-as=text">DOM Access</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%2524x%2520%253D%2520false%253B%250A%250Aa%253A%250A%250Aif%28%21%2524x%29%250A%257B%250A%2509goto%2520b%253B%250A%257D%250A%250Aecho%2520%272.%2520Foo%27%2520.%2520PHP_EOL%253B%250A%250Agoto%2520c%253B%250A%250Ab%253A%250A%250Aecho%2520%271.%2520Bar%27%2520.%2520PHP_EOL%253B%250A%250Aif%28%21%2524x%29%250A%257B%250A%2509%2524x%2520%253D%2520true%253B%250A%2509goto%2520a%253B%250A%257D%250A%250Ac%253A%250Aecho%2520%273.%2520Baz%27%2520.%2520PHP_EOL%253B%250A&autorun=1&persist=0&single-expression=0&render-as=text">goto</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520true%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%252F%252F%2520Only%2520%2522single%2522%2520expressions%2520can%2520return%2520strings%2520directly%250A%252F%252F%2520So%2520wrap%2520the%2520commands%2520in%2520an%2520IFFE.%250A%250A%28function%28%29%2520%257B%250A%2509global%2520%2524persist%253B%250A%250A%2509fwrite%28fopen%28%27php%253A%252F%252Fstdout%27%252C%2520%27w%27%29%252C%2520%2522standard%2520output%21%255Cn%2522%29%253B%250A%2509fwrite%28fopen%28%27php%253A%252F%252Fstdout%27%252C%2520%27w%27%29%252C%2520sprintf%28%250A%2509%2509%2522Ran%2520%2525d%2520times%21%255Cn%2522%252C%2520%252B%252B%2524persist%250A%2509%29%29%253B%250A%2509fwrite%28fopen%28%27php%253A%252F%252Fstderr%27%252C%2520%27w%27%29%252C%2520%27standard%2520error%21%27%29%253B%250A%250A%2509return%2520%27return%2520value%27%253B%250A%257D%29%28%29%253B%250A&autorun=1&persist=1&single-expression=1&render-as=text">StdOut, StdErr & Return</a></li> </ul> </td> <td width = "500px"> <ul> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%2524db%2520%253D%2520new%2520SQLite3%28%27people.db%27%29%253B%250A%2524db-%253Equery%28%27CREATE%2520TABLE%2520IF%2520NOT%2520EXISTS%2520people%2520%28%250A%2509id%2520INTEGER%2520PRIMARY%2520KEY%252C%250A%2520%2520%2520%2509name%2520TEXT%2520NOT%2520NULL%250A%29%253B%27%29%253B%250A%250Afor%28%2524i%2520%253D%25200%253B%2520%2524i%2520%253C%2520100%253B%2520%2524i%252B%252B%29%2520%257B%250A%250A%2509%2524weirdName%2520%253D%2520str_repeat%28chr%28%2524i%252B64%29%252C%252010%29%253B%250A%2509%2524insert%2520%2520%2520%2520%253D%2520%2524db-%253Eprepare%28%27INSERT%2520INTO%2520people%2520%28name%29%2520VALUES%28%253Aname%29%27%29%253B%250A%250A%2509%2524insert-%253EbindValue%28%27%253Aname%27%252C%2520%2524weirdName%252C%2520SQLITE3_TEXT%29%253B%250A%250A%2509%2524insert-%253Eexecute%28%29%253B%250A%257D%250A%250A%2524results%2520%253D%2520%2524db-%253Equery%28%27SELECT%2520*%2520FROM%2520people%27%29%253B%250A%250A%2524rows%2520%253D%2520%255B%255D%253B%250A%250Awhile%2520%28%2524row%2520%253D%2520%2524results-%253EfetchArray%28%29%29%2520%257B%250A%2520%2520%2520%2520var_dump%28%2524row%29%253B%250A%257D%250A&autorun=1&persist=0&single-expression=0&render-as=text">Sqlite</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%2524db%2520%253D%2520new%2520PDO%28%27sqlite%253Apeople.db%27%29%253B%250A%250A%2524db-%253Equery%28%27CREATE%2520TABLE%2520IF%2520NOT%2520EXISTS%2520people%2520%28%250A%2509id%2520INTEGER%2520PRIMARY%2520KEY%252C%250A%2520%2520%2520%2509name%2520TEXT%2520NOT%2520NULL%250A%29%253B%27%29%253B%250A%250Afor%28%2524i%2520%253D%25200%253B%2520%2524i%2520%253C%252010%253B%2520%2524i%252B%252B%29%2520%257B%250A%2509%2524weirdName%2520%253D%2520str_repeat%28chr%28%2524i%252B64%29%252C%252010%29%253B%250A%2509%2524insert%2520%2520%2520%2520%253D%2520%2524db-%253Eprepare%28%27INSERT%2520INTO%2520people%2520%28name%29%2520VALUES%28%253Aname%29%27%29%253B%250A%250A%2509%2524insert-%253EbindParam%28%27%253Aname%27%252C%2520%2524weirdName%252C%2520SQLITE3_TEXT%29%253B%250A%250A%2509%2524insert-%253Eexecute%28%29%253B%250A%257D%250A%250A%2524results%2520%253D%2520%2524db-%253Equery%28%27SELECT%2520*%2520FROM%2520people%27%29%253B%250A%250A%2524rows%2520%253D%2520%255B%255D%253B%250A%250Awhile%2520%28%2524row%2520%253D%2520%2524results-%253EfetchObject%28%29%29%2520%257B%250A%2520%2520%2520%2520print_r%28%2524row%29%253B%250A%257D%250A&autorun=1&persist=0&single-expression=0&render-as=text">Sqlite w/PDO</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%2524x%2520%253D%2520%255B%250A%2509%2522id%2522%2520%253D%253E%25201%250A%255D%253B%250A%250Avar_dump%28json_decode%28json_encode%28%2524x%29%29%29%253B%250A&autorun=1&persist=0&single-expression=0&render-as=text">JSON</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%2524x%2520%253D%252010%253B%250A%250Afunction%2520run%28callable%2520%2524f%29%2520%257B%250A%2509%2524f%28%29%253B%250A%257D%250A%250Arun%28function%2520%28%29%2520use%2520%28%2526%2524x%29%2520%257B%250A%2509%2524x%2520%253D%25209%253B%250A%257D%29%253B%250A%250Avar_dump%28%2524x%29%253B%250A&autorun=1&persist=0&single-expression=0&render-as=text">Closures</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522html%2522%257D%250A%250A%2524it%2520%253D%2520new%2520RecursiveIteratorIterator%28new%2520RecursiveDirectoryIterator%28%2522.%2522%29%29%253B%250A%250Aforeach%2520%28%2524it%2520as%2520%2524name%2520%253D%253E%2520%2524entry%29%2520%257B%250A%2509echo%2520%2524name%2520.%2520%2522%253Cbr%252F%253E%2522%253B%250A%257D%250A&autorun=1&persist=0&single-expression=0&render-as=html">File access</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250Ainclude%28%2522%252Fpreload%252Fbench.php%2522%29%253B%250A&autorun=1&persist=0&single-expression=0&render-as=text">Zend/bench.php</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?demo=drupal.php&render-as=html&autorun=1&persist=0&single-expression=0&code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Afalse%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522html%2522%257D%250Aini_set%28%27session.save_path%27%252C%2520%27%252Fpersist%27%29%253B%250A%250A%2524stdErr%2520%253D%2520fopen%28%27php%253A%252F%252Fstderr%27%252C%2520%27w%27%29%253B%250A%2524errors%2520%253D%2520%255B%255D%253B%250A%250Aset_error_handler%28function%28...%2524args%29%2520use%28%2524stdErr%252C%2520%2526%2524errors%29%257B%250A%2509fwrite%28%2524stdErr%252C%2520print_r%28%2524args%252C1%29%29%253B%250A%257D%29%253B%250A%250A%2524docroot%2520%253D%2520%27%252Fpersist%252Fdrupal-7.95%27%253B%250A%2524path%2520%2520%2520%2520%253D%2520%27%252Fnode%27%253B%250A%2524script%2520%2520%253D%2520%27index.php%27%253B%250A%250Aif%28%21is_dir%28%2524docroot%29%29%250A%257B%250A%2520%2520%2520%2520%2524it%2520%253D%2520new%2520RecursiveIteratorIterator%28new%2520RecursiveDirectoryIterator%28%2522%252Fpreload%252Fdrupal-7.95%252F%2522%252C%2520FilesystemIterator%253A%253ASKIP_DOTS%29%29%253B%250A%2520%2520%2520%2520foreach%2520%28%2524it%2520as%2520%2524name%2520%253D%253E%2520%2524entry%29%250A%2520%2520%2520%2520%257B%250A%2520%2520%2520%2520%2520%2520%2520%2520if%28is_dir%28%2524name%29%29%2520continue%253B%250A%2520%2520%2520%2520%2520%2520%2520%2520%2524fromDir%2520%253D%2520dirname%28%2524name%29%253B%250A%2520%2520%2520%2520%2520%2520%2520%2520%2524toDir%2520%2520%253D%2520%27%252Fpersist%27%2520.%2520substr%28%2524fromDir%252C%25208%29%253B%250A%2520%2520%2520%2520%2520%2520%2520%2520%2524filename%2520%253D%2520basename%28%2524name%29%253B%250A%2520%2520%2520%2520%2509%2524pDirs%2520%253D%2520%255B%2524pDir%2520%253D%2520%2524toDir%255D%253B%250A%2520%2520%2520%2520%2509while%28%2524pDir%2520%21%253D%253D%2520dirname%28%2524pDir%29%29%2520%2524pDirs%255B%255D%2520%253D%2520%2524pDir%2520%253D%2520dirname%28%2524pDir%29%253B%250A%2520%2520%2520%2520%2509%2524pDirs%2520%253D%2520array_reverse%28%2524pDirs%29%253B%250A%2520%2520%2520%2520%2509foreach%28%2524pDirs%2520as%2520%2524pDir%29%2520if%28%21is_dir%28%2524pDir%29%29%2520mkdir%28%2524pDir%252C%25200777%29%253B%250A%2520%2520%2520%2520%2509file_put_contents%28%2524toDir%2520%2520.%2520%27%252F%27%2520.%2520%2524filename%252C%2520file_get_contents%28%2524fromDir%2520.%2520%27%252F%27%2520.%2520%2524filename%29%29%253B%250A%2520%2520%2520%2520%257D%250A%257D%250A%250A%2524_SERVER%255B%27REQUEST_URI%27%255D%2520%2520%2520%2520%2520%253D%2520%27%252Fphp-wasm%27%2520.%2520%2524docroot%2520.%2520%2524path%253B%250A%2524_SERVER%255B%27REMOTE_ADDR%27%255D%2520%2520%2520%2520%2520%253D%2520%27127.0.0.1%27%253B%250A%2524_SERVER%255B%27SERVER_NAME%27%255D%2520%2520%2520%2520%2520%253D%2520%27localhost%27%253B%250A%2524_SERVER%255B%27SERVER_PORT%27%255D%2520%2520%2520%2520%2520%253D%25203333%253B%250A%2524_SERVER%255B%27REQUEST_METHOD%27%255D%2520%2520%253D%2520%27GET%27%253B%250A%2524_SERVER%255B%27SCRIPT_FILENAME%27%255D%2520%253D%2520%2524docroot%2520.%2520%27%252F%27%2520.%2520%2524script%253B%250A%2524_SERVER%255B%27SCRIPT_NAME%27%255D%2520%2520%2520%2520%2520%253D%2520%2524docroot%2520.%2520%27%252F%27%2520.%2520%2524script%253B%250A%2524_SERVER%255B%27PHP_SELF%27%255D%2520%2520%2520%2520%2520%2520%2520%2520%253D%2520%2524docroot%2520.%2520%27%252F%27%2520.%2520%2524script%253B%250A%250Achdir%28%2524docroot%29%253B%250A%250Aif%28%21defined%28%27DRUPAL_ROOT%27%29%29%2520define%28%27DRUPAL_ROOT%27%252C%2520getcwd%28%29%29%253B%250A%250Arequire_once%2520DRUPAL_ROOT%2520.%2520%27%252Fincludes%252Fbootstrap.inc%27%253B%250Adrupal_bootstrap%28DRUPAL_BOOTSTRAP_FULL%29%253B%250Adrupal_session_start%28%29%253B%250A%250Afwrite%28%2524stdErr%252C%2520json_encode%28%255B%27session_id%27%2520%253D%253E%2520session_id%28%29%255D%29%2520.%2520%2522%255Cn%2522%29%253B%250A%250Aglobal%2520%2524user%253B%250A%250A%2524uid%2520%2520%2520%2520%2520%253D%25201%253B%250A%2524user%2520%2520%2520%2520%253D%2520user_load%28%2524uid%29%253B%250A%2524account%2520%253D%2520array%28%27uid%27%2520%253D%253E%2520%2524user-%253Euid%29%253B%250A%2524session_name%2520%253D%2520session_name%28%29%253B%250A%250Aif%28%21%2524_COOKIE%2520%257C%257C%2520%21%2524_COOKIE%255B%2524%2524session_name%255D%29%250A%257B%250A%2509user_login_submit%28array%28%29%252C%2520%2524account%29%253B%250A%257D%250A%250A%2524itemPath%2520%253D%2520%2524path%253B%250A%2524itemPath%2520%253D%2520preg_replace%28%27%252F%255E%255C%255C%252F%252F%27%252C%2520%27%27%252C%2520%2524path%29%253B%250A%250A%2524GLOBALS%255B%27base_path%27%255D%2520%253D%2520%27%252Fphp-wasm%27%2520.%2520%2524docroot%2520.%2520%27%252F%27%253B%250A%2524base_url%2520%253D%2520%27%252Fphp-wasm%27%2520.%2520%2524docroot%253B%250A%250A%2524_GET%255B%27q%27%255D%2520%253D%2520%2524itemPath%253B%250A%250Amenu_execute_active_handler%28%29%253B%250A%250Afwrite%28%2524stdErr%252C%2520json_encode%28%255B%27HEADERS%27%2520%253D%253Eheaders_list%28%29%255D%29%2520.%2520%2522%255Cn%2522%29%253B%250Afwrite%28%2524stdErr%252C%2520json_encode%28%255B%27COOKIE%27%2520%2520%253D%253E%2520%2524_COOKIE%255D%29%2520.%2520PHP_EOL%29%253B%250Afwrite%28%2524stdErr%252C%2520json_encode%28%255B%27errors%27%2520%2520%253D%253E%2520error_get_last%28%29%255D%29%2520.%2520%2522%255Cn%2522%29%253B%250A">Drupal 7</a></li> </ul> </td> <td width = "500px"> <ul> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Atrue%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%2524window%2520%253D%2520new%2520Vrzno%253B%250A%2524import%2520%253D%2520vrzno_import%28%27https%253A%252F%252Fcdn.jsdelivr.net%252Fnpm%252F%2540observablehq%252Fplot%25400.6%252F%252Besm%27%29%253B%250A%250A%2524import-%253Ethen%28function%28%2524Plot%29%2520use%28%2524window%29%2520%257B%250A%250A%2509%2524plot%2520%253D%2520%2524Plot-%253ErectY%28%250A%250A%2509%2509%28object%29%255B%27length%27%2520%253D%253E%2520100000%255D%252C%250A%250A%2509%2509%2524Plot-%253EbinX%28%250A%2509%2509%2509%28object%29%255B%27y%27%253D%253E%2520function%28%2524a%252C%2524b%29%257B%2520return%2520-cos%28%2524b-%253Ex1*pi%28%29%29%253B%2520%257D%255D%252C%250A%2509%2509%2509%28object%29%255B%27x%27%253D%253E%2520%2524window-%253EMath-%253Erandom%255D%250A%2509%2509%29%250A%250A%2509%29-%253Eplot%28%29%253B%250A%250A%2509%2524renderTo%2520%253D%2520%2524window-%253Edocument-%253Ebody-%253EquerySelector%28%27%2523example%27%29%253B%250A%2509%2524renderTo-%253EinnerHTML%2520%253D%2520%27%27%253B%250A%250A%2509%2524renderTo-%253Eappend%28%2524plot%29%253B%250A%250A%257D%29-%253Ecatch%28fn%28%2524error%29%2520%253D%253E%2520%2524window-%253Econsole-%253Eerror%28%2524error-%253Emessage%29%29%253B%250A&autorun=1&persist=1&single-expression=0&render-as=text&demo=import.php">Import Javascript Libs</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Atrue%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%250A%2524url%2520%253D%2520%27https%253A%252F%252Fapi.weather.gov%252Fgridpoints%252FTOP%252F40%252C74%252Fforecast%27%253B%250A%250A%2524window%2520%253D%2520new%2520Vrzno%253B%250A%2524window-%253Efetch%28%2524url%29%250A-%253Ethen%28function%28%2524r%29%2520%257B%2520return%2520%2524r-%253Ejson%28%29%253B%2520%257D%29%250A-%253Ethen%28var_dump%28...%29%29%253B%250A%250Aecho%2520%2522Yeah%252C%2520its%2520async.%255Cn%255Cn%2522%253B%250A&autorun=1&persist=1&single-expression=0&render-as=text&demo=fetch.php">Fetch</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Atrue%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%2524window%2520%253D%2520%2524window%2520%253F%253F%2520new%2520Vrzno%253B%250A%250A%2524Promise%2520%253D%2520%2524window-%253EPromise%253B%250A%250A%2524promise%2520%253D%2520vrzno_new%28%2524Promise%252C%2520function%28%2524accept%252C%2520%2524reject%29%2520%257B%250A%250A%2520%2520%2520%2520%2524window%2520%253D%2520new%2520Vrzno%253B%250A%250A%2520%2520%2520%2520if%281%29%250A%2520%2520%2520%2520%257B%250A%2520%2520%2520%2520%2520%2520%2520%2520%2524accept%28%27Something.%27%29%253B%250A%2520%2520%2520%2520%2520%2520%2520%2520%252F%252F%2520%2524window-%253EsetTimeout%28%250A%2520%2520%2520%2520%2520%2520%2520%2520%252F%252F%2520%2520%2520%2520%2520fn%28%29%2520%253D%253E%2520%2524accept%28%27Something.%27%29%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%252F%252F%2520%2520%2520%2520%25201000%250A%2520%2520%2520%2520%2520%2520%2520%2520%252F%252F%2520%29%253B%250A%2520%2520%2520%2520%257D%250A%2520%2520%2520%2520else%250A%2520%2520%2520%2520%257B%250A%2520%2520%2520%2520%2520%2520%2520%2520%2524window-%253EsetTimeout%28%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520fn%28%29%2520%253D%253E%2520%2524reject%28%27Error.%27%29%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%25201000%250A%2520%2520%2520%2520%2520%2520%2520%2520%29%253B%250A%2520%2520%2520%2520%257D%250A%250A%257D%29%253B%250A%250A%2524promise-%253Ethen%28var_dump%28...%29%29-%253Ecatch%28var_dump%28...%29%29%253B%250A&autorun=1&persist=1&single-expression=0&render-as=text&demo=promise.php">Promise</a></li> <li><a href = "https://seanmorris.github.io/php-wasm/?code=%253C%253Fphp%2520%252F%252F%2520%257B%2522autorun%2522%253Atrue%252C%2520%2522persist%2522%253Atrue%252C%2520%2522single-expression%2522%253A%2520false%252C%2520%2522render-as%2522%253A%2520%2522text%2522%257D%250A%2524window%2520%253D%2520new%2520Vrzno%253B%250A%2524require%2520%253D%2520%2524window-%253Erequire%253B%250A%2524Form%2520%253D%2520%2524require%28%27curvature%252Fform%252FForm%27%29-%253EForm%253B%250A%2524View%2520%253D%2520%2524require%28%27curvature%252Fbase%252FView%27%29-%253EView%253B%250A%250A%2524form%2520%253D%2520new%2520%2524Form%28%28object%29%255B%250A%2520%2520%2520%2520%27id%27%2520%2520%2520%253D%253E%2520%28object%29%255B%27type%27%2520%253D%253E%2520%27number%27%255D%252C%250A%2520%2520%2520%2520%27name%27%2520%253D%253E%2520%28object%29%255B%27type%27%2520%253D%253E%2520%27text%27%255D%252C%250A%255D%29%253B%250A%250A%2524view%2520%253D%2520%2524View-%253Efrom%28%27%253Cdiv%2520style%2520%253D%2520%2522display%253Aflex%253Bflex-direction%253Arow%253Bmargin%253A1rem%253B%2522%253E%250A%2509%253Cdiv%2520style%2520%253D%2520%2522margin-right%253A1rem%2522%253E%250A%2509%2509%253Cp%253ECounter%253C%252Fp%253E%250A%2509%2509%253Cdiv%2520style%2520%253D%2520%2522display%253Aflex%253Bflex-direction%253Arow%253Bmargin%253A1rem%2520auto%253Bmin-width%253A4rem%253B%2522%253E%250A%2509%2509%2509%253Cbutton%2520cv-on%2520%253D%2520%2522click%253Adec%2522%2520style%2520%253D%2520%2522flex%253A1%2522%253E-%253C%252Fbutton%253E%250A%2509%2509%2509%253Cbutton%2520cv-on%2520%253D%2520%2522click%253Ainc%2522%2520style%2520%253D%2520%2522flex%253A1%2522%253E%252B%253C%252Fbutton%253E%250A%2509%2509%253C%252Fdiv%253E%250A%2509%2509%253Cdiv%2520style%2520%253D%2520%2522font-size%253A6rem%253B%2522%253E%255B%255Bcounter%255D%255D%253C%252Fdiv%253E%250A%2509%253C%252Fdiv%253E%250A%2509%253Cdiv%2520style%2520%253D%2520%2522margin-right%253A1rem%2522%253E%250A%2509%2509%253Cp%253EForm%253A%2520%255B%255Bform%255D%255D%253C%252Fp%253E%250A%2509%2509%253Cp%253ESerialized%253A%2520%255B%255Bserialized%255D%255D%253C%252Fp%253E%250A%2509%2509%253Cp%253EJSON%253A%2520%255B%255Bjson%255D%255D%253C%252Fp%253E%250A%2509%253C%252Fdiv%253E%250A%253C%252Fdiv%253E%27%29%253B%250A%250A%2524form-%253EbindTo%28%27json%27%252C%2520function%28%2524json%2520%253D%2520NULL%29%2520use%28%2524view%252C%2520%2524form%29%2520%257B%250A%2520%2520%2520%2520%2524view-%253Eargs-%253Eserialized%2520%253D%2520serialize%28%2524form-%253Eargs-%253Evalue%29%253B%250A%2520%2520%2520%2520%2524view-%253Eargs-%253Ejson%2520%253D%2520%2524json%253B%250A%257D%29%253B%250A%250A%2524view-%253Eargs-%253Ecounter%2520%253D%25200%253B%250A%2524view-%253Eargs-%253Eform%2520%253D%2520%2524form%253B%250A%250A%2524view-%253Einc%2520%253D%2520fn%28%29%2520%253D%253E%2520%2524view-%253Eargs-%253Ecounter%252B%252B%253B%250A%2524view-%253Edec%2520%253D%2520fn%28%29%2520%253D%253E%2520%2524view-%253Eargs-%253Ecounter--%253B%250A%250A%2524renderTo%2520%253D%2520%2524window-%253Edocument-%253Ebody-%253EquerySelector%28%27%2523example%27%29%253B%250A%2524renderTo-%253EinnerHTML%2520%253D%2520%27%27%253B%250A%2524view-%253Erender%28%2524renderTo%29%253B%250A&autorun=1&persist=1&single-expression=0&render-as=text&demo=curvature.php">Curvature</a></li> <li><a href = "https://github.com/seanmorris/php-gtk">php-gtk</a></li> <li><a href = "https://php-cloud.pages.dev/">php in cloudflare workers</a></li> <br /> </ul> </td> </tr> </table>🎩 Introducing php-cgi-wasm!
Version 0.0.9 adds php-cgi-wasm
to the mix. This allows you to run php in web-server mode, similar to how it runs under apache or nginx. Running within a Service Worker, it can intercept and respond to HTTP requests just like a normal webserver. This means the browser can simply navigate to a URL, and PHP will generate the page, and everything will work as-normal, AJAX and all. From the perspective of the webpage, its just making HTTP requests. Its not worried about whether the PHP runs on the server or in a Service Worker.
Install the php-cgi-wasm package
$ npm install php-cgi-wasm
Example Service Worker:
import { PhpCgiWorker } from "php-cgi-wasm/PhpCgiWorker";
// Spawn the PHP-CGI binary
const php = new PhpCgiWorker({
prefix: '/php-wasm',
docroot: '/persist/www',
types: {
jpg: 'image/jpeg',
jpeg: 'image/jpeg',
gif: 'image/gif',
png: 'image/png',
svg: 'image/svg+xml',
}
});
// Set up the event handlers
self.addEventListener('install', event => php.handleInstallEvent(event));
self.addEventListener('activate', event => php.handleActivateEvent(event));
self.addEventListener('fetch', event => php.handleFetchEvent(event));
self.addEventListener('message', event => php.handleMessageEvent(event));
You can see examples of php-cgi-wasm running in a service worker and nodejs in demo-web/src/cgi-worker.mjs
& demo-node/index.mjs
respectively.
Note: php-cgi-wasm
& php-wasm
are separate packages. One "embeds" php right into your javascript, the other runs in "cgi-mode," just like php would under apache or nginx.
You can find documentation specific to php-cgi-wasm here.
🛠️ Install & Use
Install php-wasm with npm:
$ npm install php-wasm
Include the module in your preferred format:
Common JS
const { PhpWeb } = require('php-wasm/PhpWeb.js');
const php = new PhpWeb;
ESM
import { PhpWeb } from 'php-wasm/PhpWeb.mjs';
const php = new PhpWeb;
From a CDN:
Note: This does not require npm.
jsdelivr
const { PhpWeb } = await import('https://cdn.jsdelivr.net/npm/php-wasm/PhpWeb.mjs');
const php = new PhpWeb;
unpkg
const { PhpWeb } = await import('https://www.unpkg.com/php-wasm/php-wasm/PhpWeb.mjs');
const php = new PhpWeb;
Pre-Packaged Static Assets:
If you're using a bundler, use the vendor's documentation to learn how to move the files matching the following pattern to your public directory:
node_modules/php-wasm/php-web.mjs.wasm
node_modules/php-wasm/php-worker.mjs.wasm # ONLY if you're running the standard build in a worker
For php-cgi-wasm:
node_modules/php-cgi-wasm/php-cgi-worker.mjs.wasm
node_modules/php-cgi-wasm/php-cgi-web.mjs.wasm # ONLY if you're running the cgi build in a page
🍎 Quickstart
Inline PHP
Include the php-tags.js
script from a CDN:
<script async type = "text/javascript" src = "https://cdn.jsdelivr.net/npm/php-wasm/php-tags.jsdelivr.mjs"></script>
And run some PHP right in the page!
<script type = "text/php" data-stdout = "#output">
<?php phpinfo();
</script>
<div id = "output"></div>
Inline php can use standard input, output and error with data-
attributes. Just set the value of the attribute to a selector that will match that tag.
<script async type = "text/javascript" src = "https://cdn.jsdelivr.net/npm/php-wasm/php-tags.jsdelivr.mjs"></script>
<script id = "input" type = "text/plain">Hello, world!</script>
<script type = "text/php" data-stdin = "#input" data-stdout = "#output" data-stderr = "#error">
<?php echo file_get_contents('php://stdin');
</script>
<div id = "output"></div>
<div id = "error"></div>
The src
attribute can be used on <script type = "text/php">
tags, as well as their input elements. For example:
<html>
<head>
<script async type = "text/javascript" src = "https://cdn.jsdelivr.net/npm/php-wasm/php-tags.jsdelivr.mjs"></script>
<script id = "input" src = "/test-input.json" type = "text/json"></script>
<script type = "text/php" src = "/test.php" data-stdin = "#input" data-stdout = "#output" data-stderr = "#error"></script>
</head>
<body>
<div id = "output"></div>
<div id = "error"></div>
</body>
</html>
CDNs
JSDelivr
<script async type = "text/javascript" src = "https://cdn.jsdelivr.net/npm/php-wasm/php-tags.jsdelivr.mjs"></script>
Unpkg
<script async type = "text/javascript" src = "https://www.unpkg.com/php-wasm/php-tags.unpkg.mjs"></script>
<!--
##### esm.sh
```html
<script async type = "text/javascript" src = "https://esm.sh/php-wasm/php-wasm/php-tags.jsdelivr.mjs"></script>
``` -->
🥤 Running PHP & Taking Output
Create a PHP instance:
const { PhpWeb } = await import('https://cdn.jsdelivr.net/npm/php-wasm/PhpWeb.mjs');
const php = new PhpWeb;
Add your output listeners:
// Listen to STDOUT
php.addEventListener('output', (event) => {
console.log(event.detail);
});
// Listen to STDERR
php.addEventListener('error', (event) => {
console.log(event.detail);
});
Provide some input data on STDIN if you need to:
php.inputString('This is a string of data provided on STDIN.');
... then run some PHP!
const exitCode = await php.run('<?php echo "Hello, world!";');
Dynamic Extensions in Static Pages
Dynamic extensions can be loaded in static webpages like so:
<script async type = "module" src = "https://cdn.jsdelivr.net/npm/php-wasm@0.0.9-alpha-12/php-tags.mjs"></script>
<script type = "text/php" data-stdout = "#output" data-stderr = "#error" data-libs = '[
{"url": "https://unpkg.com/php-wasm-yaml/php8.3-yaml.so", "ini": true},
{"url": "https://unpkg.com/php-wasm-yaml/libyaml.so", "ini": false}
]'><?php
print yaml_emit([1,2,3,"string",["k1" => "value", "k2" => "value2", "k3" => "value3"],"now" => date("Y-m-d h:i:s")]);
</script>
⚙️ Configuration
You can pass in the ini
property to the constructor to add lines to /php.ini
:
const php = new PhpWeb({ini: `
date.timezone=${Intl.DateTimeFormat().resolvedOptions().timeZone}
tidy.clean_output=1
expose_php=0
`});
The /config/php.ini
and /preload/php.ini
files will also be loaded, if they exist. Neither of these files will be created if they do not exist. They're left completely up to the programmer to create & populate.
Options like the following may appear in these files. See the PHP docs for the full list.
[php]
date.timezone=UTC
tidy.clean_output=1
expose_php=0
CGI Configuration
When running in CGI mode, php will look for a php.ini
file in the document root directory, and load it along with the files listed above.
Writing an INI for multiple PHP versions
PHP will replace strings in INI files in the form ${ENVIRONMENT_VARIABLE}
with the env value of ENVIRONMENT_VARIABLE
. The PHP_VERSION
environment variable is available to allow loading of the extension compatible with the currently running version of PHP:
[php]
extension=php${PHP_VERSION}-phar.so
Remember to correctly escape the $
if you're supplying the INI from Javascript with `backtics
`:
const php = new PhpWeb({ini: `
extension=php\${PHP_VERSION}-phar.so
date.timezone=${Intl.DateTimeFormat().resolvedOptions().timeZone}
`});
🔌 Extensions
Loading extensions at runtime
The following extensions may be loaded at runtime. This allows the shared extension & their dependencies to be cached, re-used, and selected a-la-carte for each application.
- gd (https://www.npmjs.com/package/php-wasm-gd)
- iconv (https://www.npmjs.com/package/php-wasm-iconv)
- intl (https://www.npmjs.com/package/php-wasm-intl)
- xml (https://www.npmjs.com/package/php-wasm-libxml)
- dom (https://www.npmjs.com/package/php-wasm-libxml)
- simplexml (https://www.npmjs.com/package/php-wasm-libxml)
- yaml (https://www.npmjs.com/package/php-wasm-libyaml)
- zip (https://www.npmjs.com/package/php-wasm-libzip)
- mbstring (https://www.npmjs.com/package/php-wasm-mbstring)
- openssl (https://www.npmjs.com/package/php-wasm-openssl)
- phar (https://www.npmjs.com/package/php-wasm-phar)
- sqlite (https://www.npmjs.com/package/php-wasm-sqlite)
- pdo-sqlite (https://www.npmjs.com/package/php-wasm-sqlite)
- zlib (https://www.npmjs.com/package/php-wasm-zlib)
There are two ways to load extensions at runtime, using the dl()
function or php.ini
.
<?php
dl('php-8.3-xml.so');
dl('php-8.3-dom.so');
or, pass an array as the extensions
argument to the constructor from Javascript to auto-generate an ini file that loads your extensions:
const php = new PhpWeb({sharedLibs: [
`php8.3-xml.so`,
`php8.3-dom.so`,
]});
The class used to load PHP (PhpWeb
here) also implements a phpVersion property to ensure libs can be loaded for any compatible version:
const php = new PhpWeb({sharedLibs: [
`php${PhpWeb.phpVersion}-xml.so`,
`php${PhpWeb.phpVersion}-dom.so`,
]});
Dynamic Extensions from Remote Servers:
You can also load extensions from remote servers with URLs:
const php = new PhpWeb({sharedLibs: [`https://unpkg.com/php-wasm-phar/php8.3-phar.so`]});
The above is actually shorthand for the following code. Passing ini: true
will automatically load the extension via /php.ini
, passing ini: false
will wait for a call to dl()
to do the lookup.
const php = new PhpWeb({sharedLibs: [
{
name: `php8.3-phar.so`,
url: `https://unpkg.com/php-wasm-phar/php8.3-phar.so`,
ini: true,
}
]});
Strings starting with /
, ./
, http://
or https://
will be treated as URLs:
const php = new PhpWeb({sharedLibs: [
`./php8.3-phar.so`
]});
Some extensions require supporting libraries. You can provide URLs for those as sharedLibs
as well, just pass ini: false
:
(name
is implied to be the last section of the URL here.)
const php = new PhpWeb({sharedLibs: [
{ url: 'https://unpkg.com/php-wasm-sqlite/php8.3-sqlite.so', ini: true },
{ url: 'https://unpkg.com/php-wasm-sqlite/sqlite.so', ini: false },
]});
Loading Dynamic Extensions as JS Modules:
Dynamic extensions can be loaded as modules: So long as the main file of the module defines the getLibs
and getFiles
methods, extensions may be loaded like so:
new PhpNode({sharedLibs:[ await import('php-wasm-intl') ]})
Dynamic extensions can also be loaded as modules from any static HTTP server with an ESM directory structure.
// This will load both sqlite.so & php8.x-sqlite.so:
const php = new PhpWeb({sharedLibs: [ await import('https://cdn.jsdelivr.net/npm/php-wasm-sqlite') ]});
Sadly, this notation is not available for Service Workers, since they do not yet support dynamic imports()
. Hopefully this will change soon.
Compiling extensions
Extensions may be compiled as dynamic
, shared
, or static
. See Custom Builds
for more information on compiling php-wasm.
- dynamic - these extensions may be loaded selectively at runtime.
- shared - these extensions will always be loaded at startup and can be cached and reused.
- static - these extensions will be built directly into the main wasm binary (may cause a huge filesize).
📦 Loading Files
Loading single files at runtime
When spawning a new instance of PHP, a files
array can be provided to be loaded into the filesystem. For example, the php-intl
extension requires us to load icudt72l.dat
into the /preload
directory.
const sharedLibs = [`https://unpkg.com/php-wasm-intl/php\${PHP_VERSION}-intl.so`];
const files = [
{
name: 'icudt72l.dat',
parent: '/preload/',
url: 'https://unpkg.com/php-wasm-intl/icudt72l.dat'
}
];
const php = new PhpWeb({sharedLibs, files});
Preloaded FS
Use the PRELOAD_ASSETS
key in your .php-wasm-rc
file to define a list of files and directories to include by default.
The files and directories will be collected into a single directory. Individual files & directories will appear in the top level, while directories will maintain their internal structure.
These files & directories will be available under /preload
in the final package, packaged into the .data
file that is built along with the .wasm
file.
PRELOAD_ASSETS='/path/to/file.txt /some/directory /path/to/other_file.txt /some/other/directory'
locateFile
You can provide the locateFile
option to php-wasm as a callback to map the names of files to URLs where they're loaded from. undefined
can be returned as a fallback to default.
You can use this if your static assets are served from a different directory than your javascript.
This applies to .wasm
files, shared libraries, single files and preloaded FS packages in .data
files.
const php = new PhpWeb({locateFile: filename => `/my/static/path/${filename}`});
💾 Persistent Storage (IDBFS & NodeFS)
IDBFS (Web & Worker)
To use IDBFS in PhpWeb, pass a persist
object with a mountPath
key.
mountPath
will be used as the path to the persistent directory within the PHP environment.
const { PhpWeb } = await import('https://cdn.jsdelivr.net/npm/php-wasm/PhpWeb.mjs');
const php = new PhpWeb({persist: {mountPath: '/persist'}});
NodeFS (NodeJS Only)
To use NodeFS in PhpWeb, pass a persist
object with mountPath
& localPath
keys.
localPath
will be used as the path to the HOST directory to expose to PHP.
mountPath
will be used as the path to the persistent directory within the PHP environment.
const { PhpNode } = await import('https://cdn.jsdelivr.net/npm/php-wasm/PhpNode.mjs');
const php = new PhpNode({persist: {mountPath: '/persist', localPath: '~/your-files'}});
📁 Filesystem Operations
Filesystem Methods
The following EmscriptenFS methods are exposed via the php object:
Note: If you're using php-web in conjunction with php-cgi-worker to work on the filesystem, you'll need to refresh
the filesystem in the worker. You can do that with the following call using msg-bus
(see below).
// Tell the worker that the FS has been updated
await sendMessage('refresh');
php.analyzePath
Get information about a file or directory.
await php.analyzePath(path);
php.readdir
Get a list of files and folders in or directory.
await php.readdir(path);
php.readFile
Get the content of a file as a Uint8Array
by default, or optionally as utf-8.
await php.readFile(path);
await php.readFile(path, {encoding: 'utf8'});
php.stat
Get information about a file or directory.
await php.stat(path);
php.mkdir
Create a directory.
await php.mkdir(path);
php.rmdir
Delete a directory (must be empty).
await php.rmdir(path);
php.unlink
Delete a file.
await php.rmdir(path);
php.rename
Rename a file or directory.
await php.rename(path, newPath);
php.writeFile
Create a new file. Content should be supplied as a Uint8Array
, or optionally as a string of text.
await php.writeFile(path, data);
await php.writeFile(path, data, {encoding: 'utf8'});
Transactions
Web and Worker only!
The web and worker build use navigator.locks.request
to request a lock named php-wasm-fs-lock
before performing filesystem operations. This ensure multiple tabs & the service worker can interact with the filesystem without overwriting eachother's work. Before any FS operation takes place, the entire FS is loaded from IDBFS, and before the lock is released, the entire FS is laoded BACK into IDBFS.
The operations are enqueued asyncronously, so if multiple requests are generated before one transaction closes, they will be batched automatically. This also applies to multiple requests generated before the lock is acquired. There is generally no need to take explicit control of FS mirroring.
To suppress this behavior and take explicit control of the FS mirroring, you can pass the {autoTransaction: false}
option to the constructor. Doing this will require you to call php.startTransaction()
before any FS operations take place, and thenphp.commitTransaction()
when you're done. Using this incorrectly may leave your filesystem in a corrupted state.
php.startTransaction
await php.startTransaction();
php.commitTransaction
await php.commitTransaction();
msg-bus
There is a msg-bus
module supplied by php-cgi-wasm
as a helper to communicate with php running inside a worker. The module exposes two functions: sendMessageFor
and onMessage
.
This allows you to simply await
the result of calls to file system methods (see above) on the service worker:
const result = await sendMessage(methodName, [param, param, param]);
onMessage & sendMessageFor
- Use
onMessage
as an event handler formessage
events coming from the Service Worker. - Use
sendMessageFor
to GENERATE A FUNCTION that you can use to send messages to your service worker.
import { onMessage, sendMessageFor } from `php-cgi-wasm/msg-bus`;
const SERVICE_WORKER_SCRIPT_URL = '/cgi-worker.mjs';
navigator.serviceWorker.register(SERVICE_WORKER_SCRIPT_URL);
navigator.serviceWorker.addEventListener('message', onMessage);
const sendMessage = sendMessageFor(SERVICE_WORKER_SCRIPT_URL);
const result = await sendMessage(methodName, [param, param, param]);
php.handleMessageEvent
Once you've got the above set up, use php.handleMessageEvent
to handle the message
events on the service worker:
self.addEventListener('message', event => php.handleMessageEvent(event));
🏗️ Custom Builds
To use the the in-place builder, first install php-wasm-builder
globally:
Requires docker, docker-compose, coreutils, wget, & make.
$ npm install -g php-wasm-builder
Create the build environment (can be run from anywhere):
$ php-wasm-builder image
Optionally clean up files from a previous build:
$ php-wasm-builder clean
Build for web
Then navigate to the directory you want the files to be built in, and run php-wasm-builder build
$ cd ~/my-project
$ php-wasm-builder build
# php-wasm-builder build web
# "web" is the default here
Build for node
$ cd ~/my-project
$ php-wasm-builder build node
ESM Modules:
Build ESM modules with:
$ php-wasm-builder build web mjs
$ php-wasm-builder build node mjs
CGI Modules:
Build CGI modules with:
$ php-wasm-builder build web cgi mjs
$ php-wasm-builder build worker cgi mjs
This will build the package inside of the current directory (or in PHP_DIST_DIR
, see below for more info.)
.php-wasm-rc
You can also create a .php-wasm-rc
file in this directory to customize the build.
# Select a PHP version
PHP_VERSION=8.3
# Build the package to a directory other than the current one (RELATIVE path)
PHP_DIST_DIR=./public
# Build the extensions to a directory other than the current one (RELATIVE path)
PHP_ASSET_DIR=./public
# Build the cgi package to a directory other than the current one (RELATIVE path)
PHP_CGI_DIST_DIR=./public
# Build the cgi package's extensions to a directory other than the current one (RELATIVE path)
PHP_CGI_ASSET_DIR=./public
# Space separated list of files/directories (ABSOLUTE paths)
# to be included under the /preload directory in the final build.
PRELOAD_ASSETS=~/my-project/php-scripts ~/other-dir/example.php
# Memory to start the instance with, before growth
INITIAL_MEMORY=2048MB
# Build with assertions enabled
ASSERTIONS=0
# Select the optimization level
OPTIMIZATION=3
# Build with extensions
WITH_GD=1
WITH_LIBPNG=1
WITH_LIBJPEG=1
WITH_FREETYPE=1
Options
The following options may appear in .php-wasm-rc
.
PHP_VERSION
8.0|8.1|8.2|8.3
PHP_DIST_DIR
This is the directory where javascript & wasm files will be built to, relative to the current directory.
PHP_ASSET_DIR
This is the directory where shared libs, extension, .data
files & other supporting files will be built to, relative to the current directory. Defaults to PHP_DIST_DIR
.
OPTIMIZE
0|1|2|3
The optimization level to use while compiling.
SUBOPTIMIZE
The optimization level to use while compiling libraries. Defaults to OPTIMIZE
.
PRELOAD_ASSETS
A list of absolute paths to files & directories to build to the /preload
directory. Will produce a .data
file.
ASSERTIONS
0|1
Build with/without assertions.
Extensions
As stated above, extensions may be compiled as dynamic
, shared
, or static
.
- dynamic - these extensions may be loaded selectively at runtime.
- shared - these extensions will always be loaded at startup and can be cached and reused.
- static - these extensions will be built directly into the main wasm binary (may cause a huge filesize).
(defaults provided below in bold)
The following options are availavle for building static PHP extensions:
WITH_BCMATH # [0, 1] Enabled by default
WITH_CALENDAR # [0, 1] Enabled by default
WITH_CTYPE # [0, 1] Enabled by default
WITH_EXIF # [0, 1] Enabled by default
WITH_FILTER # [0, 1] Enabled by default
WITH_TOKENIZER # [0, 1] Enabled by default
WITH_VRZNO # [0, 1] Enabled by default
The following extension may be compiled as static, shared or dynamic:
WITH_PHAR # [0, 1, static, dynamic]
WITH_LIBXML # [0, 1, static, shared]
WITH_ICONV # [0, 1, static, shared, dynamic]
WITH_SQLITE # [0, 1, static, shared, dynamic]
WITH_LIBZIP # [0, 1, static, shared, dynamic]
WITH_ZLIB # [0, 1, static, shared, dynamic]
WITH_GD # [0, 1, static, shared, dynamic]
WITH_LIBPNG # [0, 1, static, shared]
WITH_FREETYPE # [0, 1, static, shared]
WITH_LIBJPEG # [0, 1, static, shared]
WITH_YAML # [0, 1, static, shared, dynamic]
WITH_TIDY # [0, 1, static, shared, dynamic]
WITH_MBSTRING # [0, 1, static, dynamic]
WITH_ONIGURUMA # [0, 1, static, shared]
WITH_OPENSSL # [0, 1, shared, dynamic]
WITH_INTL # [0, 1, static, shared, dynamic]
WITH_PHAR
static|dynamic
When compiled as a dynamic
extension, this will produce the extension file php8.x-phar.so
.
WITH_LIBXML
static|shared
This actual php-libxml
extension must be statically compiled, but libxml
itself may be loaded as a shared library.
When compiled as a shared
library, it will produce the library libxml.so
.
WITH_LIBZIP
static|shared|dynamic
When compiled as a dynamic
extension, this will produce the extension php-8.x-zip.so
.
When compiled as a dynamic
or shared
extension, it will produce the library libzip.so
.
This extension depends on zlib
.
WITH_ICONV
static|shared|dynamic
When compiled as a dynamic
extension, this will produce the extension php-8.x-iconv.so
.
When compiled as a dynamic
or shared
extension, it will produce the library libiconv.so
.
WITH_SQLITE
static|shared|dynamic
When compiled as a dynamic
extension, this will produce the extensions php-8.x-sqlite.so
, & php-8.x-pdo-sqlite.so
.
When compiled as a dynamic
or shared
extension, it will produce the library libsqlite3.so
.
WITH_GD
static|dynamic
This extenstion makes use of freetype
, libjpeg
, libpng
, & zlib
.
When compiled as a dynamic
extension, this will produce the extension php-8.x-gd.so
.
WITH_LIBPNG
static|shared
When compiled as a shared
library, this will produce the library libpng.so
.
If WITH_GD is dynamic, then loading will be deferred until after gd is loaded.
WITH_FREETYPE
static|shared
When compiled as a shared
library, this will produce the library libfreetype.so
.
If WITH_GD is dynamic, then loading will be deferred until after gd is loaded.
WITH_LIBJPEG
static|shared
When compiled as a shared
library, this will produce the library libjpeg.so
.
If WITH_GD is dynamic, then loading will be deferred until after gd is loaded.
WITH_ZLIB
static|shared|dynamic
When compiled as a dynamic
extension, this will produce the extension php-8.x-zlib.so
.
When compiled as a dynamic
or shared
extension, it will produce the library libz.so
.
WITH_YAML
static|shared|dynamic
When compiled as a dynamic
extension, this will produce the extension php-8.x-yaml.so
.
When compiled as a dynamic
or shared
extension, it will produce the library libyaml.so
.
WITH_TIDY
static|shared|dynamic
When compiled as a dynamic
extension, this will produce the extension php-8.x-tidy.so
.
When compiled as a dynamic
or shared
extension, it will produce the library libtidy.so
.
WITH_MBSTRING
static|dynamic
When compiled as a dynamic
extension, this will produce the extension php-8.x-mbstring.so
.
WITH_ONIGURUMA
static|shared|dynamic
Support library for mbstring
.
When compiled as a dynamic
or shared
library, this will produce the library libonig.so
.
If WITH_MBSTRING
is dynamic
, then loading will be deferred until after mbstring
is loaded.
WITH_OPENSSL
shared|dynamic
When compiled as a dynamic
extension, this will produce the extension php-8.x-openssl
.
When compiled as a dynamic
or shared
extension, it will produce the libraries libssl.so
& libcrypto.so
.
WITH_INTL
static|shared|dynamic
When compiled as a dynamic
, or shared
extension, this will produce the extension php-8.x-intl.so
& the following libraries:
- libicuuc.so
- libicutu.so
- libicutest.so
- libicuio.so
- libicui18n.so
- libicudata.so
- icudt72l.dat
php-wasm-builder commands
php-wasm-builder build
Use this to build custom version of php-wasm. Its recommended to build this to an empty directory using a .php-wasm-rc
file.
npx php-wasm-builder build
php-wasm-builder image
This will build the docker container used to build php-wasm.
npx php-wasm-builder image
php-wasm-builder copy-assets
This will scan the current package's node_modules directory for shared libraries & supporting files, and copy them to PHP_ASSET_DIR
.
You can use this with .php-wasm-rc
to copy assets even if you're not using a custom build.
npx php-wasm-builder copy-assets
php-wasm-builder build-assets
Similar to copy-assets
, but will actually compile the shared libaries, then copy them to PHP_ASSET_DIR
.
You can use this with .php-wasm-rc
to copy assets even if you're not using a custom build.
npx php-wasm-builder build-assets
php-wasm-builder clean
Clear cached build resources.
npx php-wasm-builder clean
php-wasm-builder deep-clean
Clear out all downloaded dependencies and start from scratch.
npx php-wasm-builder deep-clean
php-wasm-builder help
Print the help text for a given command
npx php-wasm-builder help COMMAND
🤝 php-wasm started as a fork of oraoto/PIB...
The repository pib-legacy was created to preserve the original state of the project.
The repository pib-legacy
was created to preserve the original state of the project: https://github.com/seanmorris/pib-legacy
🍻 Licensed under the Apache License, Version 2.0
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
http://www.apache.org/licenses/LICENSE-2.0
Special thanks to Alex Haussmann