abstractBasePHP

An environment-agnostic wrapper around the Emscripten PHP runtime that universals the super low-level API and provides a more convenient higher-level API.

It exposes a minimal set of methods to run PHP scripts and to interact with the PHP filesystem.

Implements

IsomorphicLocalPHP
Disposable

Properties

optionalrequestHandler

requestHandler?: PHPRequestHandler<any>

semaphore

semaphore: default

An exclusive lock that prevent multiple requests from running at the same time.

Accessors

absoluteUrl

get absoluteUrl(): string

Implementation of IsomorphicLocalPHP.absoluteUrl
@deprecated
Use PHPRequestHandler instead.
Returns string

documentRoot

get documentRoot(): string

Implementation of IsomorphicLocalPHP.documentRoot
@deprecated
Use PHPRequestHandler instead.
Returns string

Methods

[dispose]

[dispose](): void

Implementation of Disposable.__@dispose@3132
Returns void

addEventListener

addEventListener(eventType: request.end | request.error | runtime.initialized | runtime.beforedestroy, listener: PHPEventListener): void

Implementation of IsomorphicLocalPHP.addEventListener
Adds an event listener for a PHP event.
Parameters
- eventType: request.end | request.error | runtime.initialized | runtime.beforedestroy
  The type of event to listen for.
- listener: PHPEventListener
  The listener function to be called when the event is triggered.
Returns void

chdir

chdir(path: string): void

Implementation of IsomorphicLocalPHP.chdir
Changes the current working directory in the PHP filesystem. This is the directory that will be used as the base for relative paths. For example, if the current working directory is /root/php, and the path is data, the absolute path will be /root/php/data.
Parameters
- path: string
  The new working directory.
Returns void

defineConstant

defineConstant(key: string, value: null | string | number | boolean): void

Implementation of IsomorphicLocalPHP.defineConstant
Defines a constant in the PHP runtime.
Parameters
- key: string
  The name of the constant.
- value: null | string | number | boolean
  The value of the constant.
Returns void

dispatchEvent

dispatchEvent<Event>(event: Event): void

Type parameters
- Event: PHPEvent
Parameters
- event: Event
Returns void

exit

exit(code?: number): void

Parameters
- code: number = 0
Returns void

fileExists

fileExists(path: string): boolean

Implementation of IsomorphicLocalPHP.fileExists
Checks if a file (or a directory) exists in the PHP filesystem.
Parameters
- path: string
  The file path to check.
Returns boolean
True if the file exists, false otherwise.

hotSwapPHPRuntime

hotSwapPHPRuntime(runtime: number, cwd?: string): void

Hot-swaps the PHP runtime for a new one without interrupting the operations of this PHP instance.
Parameters
- runtime: number
- optionalcwd: string
Returns void

initializeRuntime

initializeRuntime(runtimeId: number): void

Parameters
- runtimeId: number
Returns void

internalUrlToPath

internalUrlToPath(internalUrl: string): string

Implementation of IsomorphicLocalPHP.internalUrlToPath
@deprecated
Use PHPRequestHandler instead.
Parameters
- internalUrl: string
Returns string

isDir

isDir(path: string): boolean

Implementation of IsomorphicLocalPHP.isDir
Checks if a directory exists in the PHP filesystem.
Parameters
- path: string
  – The path to check.
Returns boolean
True if the path is a directory, false otherwise.

listFiles

listFiles(path: string, options?: ListFilesOptions): string[]

Implementation of IsomorphicLocalPHP.listFiles
Lists the files and directories in the given directory.
Parameters
- path: string
  The directory path to list.
- options: ListFilesOptions = ...
  Options for the listing.
Returns string[]
The list of files and directories in the given directory.

mkdir

mkdir(path: string): void

Implementation of IsomorphicLocalPHP.mkdir
Recursively creates a directory with the given path in the PHP filesystem. For example, if the path is /root/php/data, and /root already exists, it will create the directories /root/php and /root/php/data.
Parameters
- path: string
  The directory path to create.
Returns void

mkdirTree

mkdirTree(path: string): void

Implementation of IsomorphicLocalPHP.mkdirTree
@deprecated
Use mkdir instead.
Parameters
- path: string
Returns void

mv

mv(fromPath: string, toPath: string): void

Implementation of IsomorphicLocalPHP.mv
Moves a file or directory in the PHP filesystem to a new location.
Parameters
- fromPath: string
  The path to rename.
- toPath: string
  The new path.
Returns void

onMessage

onMessage(listener: MessageListener): Promise<void>

Listens to message sent by the PHP code.

To dispatch messages, call:

post_message_to_js(string $data)

Arguments:
    $data (string) – Data to pass to JavaScript.

@example

const php = await PHP.load('8.0');

php.onMessage(
    // The data is always passed as a string
    function (data: string) {
        // Let's decode and log the data:
        console.log(JSON.parse(data));
    }
);

// Now that we have a listener in place, let's
// dispatch a message:
await php.run({
    code: `<?php
        post_message_to_js(
            json_encode([
                'post_id' => '15',
                'post_title' => 'This is a blog post!'
            ])
        ));
    `,
});

Parameters

listener: MessageListener
Callback function to handle the message.

Returns Promise<void>

pathToInternalUrl

pathToInternalUrl(path: string): string

Implementation of IsomorphicLocalPHP.pathToInternalUrl
@deprecated
Use PHPRequestHandler instead.
Parameters
- path: string
Returns string

readFileAsBuffer

readFileAsBuffer(path: string): Uint8Array

Implementation of IsomorphicLocalPHP.readFileAsBuffer
Reads a file from the PHP filesystem and returns it as an array buffer.
@throws
@php-wasm/universal:ErrnoError – If the file doesn’t exist.
Parameters
- path: string
  The file path to read.
Returns Uint8Array
The file contents.

readFileAsText

readFileAsText(path: string): string

Implementation of IsomorphicLocalPHP.readFileAsText
Reads a file from the PHP filesystem and returns it as a string.
@throws
@php-wasm/universal:ErrnoError – If the file doesn’t exist.
Parameters
- path: string
  The file path to read.
Returns string
The file contents.

removeEventListener

removeEventListener(eventType: request.end | request.error | runtime.initialized | runtime.beforedestroy, listener: PHPEventListener): void

Implementation of IsomorphicLocalPHP.removeEventListener
Removes an event listener for a PHP event.
Parameters
- eventType: request.end | request.error | runtime.initialized | runtime.beforedestroy
  The type of event to remove the listener from.
- listener: PHPEventListener
  The listener function to be removed.
Returns void

request

request(request: PHPRequest): Promise<PHPResponse>

Implementation of IsomorphicLocalPHP.request
Do not use. Use new PHPRequestHandler() instead.
@deprecated
Parameters
- request: PHPRequest
Returns Promise<PHPResponse>

rmdir

rmdir(path: string, options?: RmDirOptions): void

Implementation of IsomorphicLocalPHP.rmdir
Removes a directory from the PHP filesystem.
Parameters
- path: string
  The directory path to remove.
- options: RmDirOptions = ...
  Options for the removal.
Returns void

run

run(request: PHPRunOptions): Promise<PHPResponse>

Implementation of IsomorphicLocalPHP.run
Runs PHP code.

This low-level method directly interacts with the WebAssembly PHP interpreter.

Every time you call run(), it prepares the PHP environment and:
- Resets the internal PHP state
- Populates superglobals ($_SERVER, $_GET, etc.)
- Handles file uploads
- Populates input streams (stdin, argv, etc.)
- Sets the current working directory
You can use run() in two primary modes:

Code snippet mode
In this mode, you pass a string containing PHP code to run.
const result = await php.run({ code: `<?php echo "Hello world!";` }); // result.text === "Hello world!"
In this mode, information like DIR or FILE isn’t very useful because the code is not associated with any file.

Under the hood, the PHP snippet is passed to the zend_eval_string C function.

File mode
In the file mode, you pass a scriptPath and PHP executes a file found at a that path:
php.writeFile( "/www/index.php", `<?php echo "Hello world!";"` ); const result = await php.run({ scriptPath: "/www/index.php" }); // result.text === "Hello world!"
In this mode, you can rely on path-related information like DIR or FILE.

Under the hood, the PHP file is executed with the php_execute_script C function.

The run() method cannot be used in conjunction with cli().
@example
const result = await php.run(`<?php $fp = fopen('php://stderr', 'w'); fwrite($fp, "Hello, world!"); `); // result.errors === "Hello, world!"
Parameters
- request: PHPRunOptions
  PHP runtime options.
Returns Promise<PHPResponse>

setPhpIniEntry

setPhpIniEntry(key: string, value: string): void

Implementation of IsomorphicLocalPHP.setPhpIniEntry
Sets a value for a specific key in the php.ini file for the PHP instance.
Parameters
- key: string
  The key to set the value for.
- value: string
  The value to set for the key.
Returns void

setPhpIniPath

setPhpIniPath(path: string): void

Implementation of IsomorphicLocalPHP.setPhpIniPath
Sets the path to the php.ini file to use for the PHP instance.
Parameters
- path: string
  The path to the php.ini file.
Returns void

setSapiName

setSapiName(newName: string): Promise<void>

Implementation of IsomorphicLocalPHP.setSapiName
Sets the SAPI name exposed by the PHP module.
Parameters
- newName: string
  The new SAPI name.
Returns Promise<void>

setSpawnHandler

setSpawnHandler(handler: string | SpawnHandler): Promise<void>

@inheritDoc
Parameters
- handler: string | SpawnHandler
Returns Promise<void>

unlink

unlink(path: string): void

Implementation of IsomorphicLocalPHP.unlink
Removes a file from the PHP filesystem.
@throws
@php-wasm/universal:ErrnoError – If the file doesn’t exist.
Parameters
- path: string
  The file path to remove.
Returns void

writeFile

writeFile(path: string, data: string | Uint8Array): void

Implementation of IsomorphicLocalPHP.writeFile
Overwrites data in a file in the PHP filesystem. Creates a new file if one doesn’t exist yet.
Parameters
- path: string
  The file path to write to.
- data: string | Uint8Array
  The data to write to the file.
Returns void

Implements

Index

Properties

Accessors

Methods

Properties

optionalrequestHandler

semaphore

Accessors

absoluteUrl

Returns string

documentRoot

Returns string

Methods

[dispose]

Returns void

addEventListener

Parameters

eventType: request.end | request.error | runtime.initialized | runtime.beforedestroy

listener: PHPEventListener

Returns void

chdir

Parameters

path: string

Returns void

defineConstant

Parameters

key: string

value: null | string | number | boolean

Returns void

dispatchEvent

Type parameters

Parameters

event: Event

Returns void

exit

Parameters

code: number = 0

Returns void

fileExists

Parameters

path: string

Returns boolean

hotSwapPHPRuntime

Parameters

runtime: number

optionalcwd: string

Returns void

initializeRuntime

Parameters

runtimeId: number

Returns void

internalUrlToPath

Parameters

internalUrl: string

Returns string

isDir

Parameters

path: string

Returns boolean

listFiles

Parameters

path: string

options: ListFilesOptions = ...

Returns string[]

mkdir

Parameters

path: string

Returns void

mkdirTree

Parameters

path: string

Returns void

mv

Parameters

fromPath: string

toPath: string

Returns void

onMessage

Parameters