Skip to main content

PHPWorker

A PHP client that can be used to run PHP code in the browser.

Implements

LimitedPHPApi
AsyncDisposable

Constructors

constructor

new PHPWorker(requestHandler?: PHPRequestHandler, monitor?: EmscriptenDownloadMonitor): PHPWorker

@inheritDoc
Parameters
- optionalrequestHandler: PHPRequestHandler
- optionalmonitor: EmscriptenDownloadMonitor
Returns PHPWorker

Properties

absoluteUrl

absoluteUrl: string = ''

@inheritDoc

documentRoot

documentRoot: string = ''

@inheritDoc

onMessageListeners

onMessageListeners: MessageListener[] = []

Methods

[asyncDispose]

[asyncDispose](): Promise<void>

Implementation of AsyncDisposable.[asyncDispose]
Returns Promise<void>

public__internal_setRequestHandler

__internal_setRequestHandler(requestHandler: PHPRequestHandler): void

Parameters
- requestHandler: PHPRequestHandler
Returns void

addEventListener

addEventListener(eventType: string, listener: PHPWorkerEventListener): void

Implementation of LimitedPHPApi.addEventListener
@inheritDoc
Parameters
- eventType: string
- listener: PHPWorkerEventListener
Returns void

chdir

chdir(path: string): void

Implementation of LimitedPHPApi.chdir
@inheritDoc
Parameters
- path: string
Returns void

cli

cli(argv: string[], options?: { env?: Record<string, string> }): Promise<StreamedPHPResponse>

@inheritDoc
Parameters
- argv: string[]
- optionaloptions: { env?: Record<string, string> }
Returns Promise<StreamedPHPResponse>

cwd

cwd(): string

@inheritDoc
Returns string

defineConstant

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

Implementation of LimitedPHPApi.defineConstant
@inheritDoc
Parameters
- key: string
- value: string | number | boolean
Returns void

fileExists

fileExists(path: string): boolean

Implementation of LimitedPHPApi.fileExists
@inheritDoc
Parameters
- path: string
Returns boolean

internalUrlToPath

internalUrlToPath(internalUrl: string): string

@inheritDoc
Parameters
- internalUrl: string
Returns string

isDir

isDir(path: string): boolean

Implementation of LimitedPHPApi.isDir
@inheritDoc
Parameters
- path: string
Returns boolean

isFile

isFile(path: string): boolean

@inheritDoc
Parameters
- path: string
Returns boolean

listFiles

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

Implementation of LimitedPHPApi.listFiles
@inheritDoc
Parameters
- path: string
- optionaloptions: ListFilesOptions
Returns string[]

mkdir

mkdir(path: string): void

Implementation of LimitedPHPApi.mkdir
@inheritDoc
Parameters
- path: string
Returns void

mkdirTree

mkdirTree(path: string): void

Implementation of LimitedPHPApi.mkdirTree
@inheritDoc
Parameters
- path: string
Returns void

mv

mv(fromPath: string, toPath: string): Promise<void>

Implementation of LimitedPHPApi.mv
@inheritDoc
Parameters
- fromPath: string
- toPath: string
Returns Promise<void>

onDownloadProgress

onDownloadProgress(callback: (progress: CustomEvent<ProgressEvent<EventTarget>>) => void): Promise<void>

The onDownloadProgress event listener.
Parameters
- callback: (progress: CustomEvent<ProgressEvent<EventTarget>>) => void
Returns Promise<void>

onMessage

onMessage(listener: MessageListener): () => Promise<void>

Implementation of LimitedPHPApi.onMessage
@inheritDoc
Parameters
- listener: MessageListener
Returns () => Promise<void>
- - (): Promise<void>
  - Returns Promise<void>

pathToInternalUrl

pathToInternalUrl(path: string): string

@inheritDoc
Parameters
- path: string
Returns string

readFileAsBuffer

readFileAsBuffer(path: string): Uint8Array

Implementation of LimitedPHPApi.readFileAsBuffer
@inheritDoc
Parameters
- path: string
Returns Uint8Array

readFileAsText

readFileAsText(path: string): string

Implementation of LimitedPHPApi.readFileAsText
@inheritDoc
Parameters
- path: string
Returns string

removeEventListener

removeEventListener(eventType: string, listener: PHPWorkerEventListener): void

Implementation of LimitedPHPApi.removeEventListener
Removes an event listener for a PHP event.
Parameters
- eventType: string
  The type of event to remove the listener from.
- listener: PHPWorkerEventListener
  The listener function to be removed.
Returns void

request

request(request: PHPRequest): Promise<PHPResponse>

Implementation of LimitedPHPApi.request
@inheritDoc
Parameters
- request: PHPRequest
Returns Promise<PHPResponse>

requestStreamed

requestStreamed(request: PHPRequest): Promise<StreamedPHPResponse>

Handles a request with streaming support for large responses. Returns a StreamedPHPResponse that allows processing the response body incrementally without buffering the entire response in memory.

This is useful for large file downloads (>2GB) that would otherwise exceed JavaScript's Uint8Array size limits.
Parameters
- request: PHPRequest
  PHP Request data.
Returns Promise<StreamedPHPResponse>

rmdir

rmdir(path: string, options?: RmDirOptions): Promise<void>

Implementation of LimitedPHPApi.rmdir
@inheritDoc
Parameters
- path: string
- optionaloptions: RmDirOptions
Returns Promise<void>

run

run(request: PHPRunOptions): Promise<PHPResponse>

Implementation of LimitedPHPApi.run
@inheritDoc
Parameters
- request: PHPRunOptions
Returns Promise<PHPResponse>

setPrimaryPHP

setPrimaryPHP(php: PHP): Promise<void>

Parameters
- php: PHP
Returns Promise<void>

setSapiName

setSapiName(newName: string): void

@inheritDoc
Parameters
- newName: string
Returns void

unlink

unlink(path: string): void

Implementation of LimitedPHPApi.unlink
@inheritDoc
Parameters
- path: string
Returns void

writeFile

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

Implementation of LimitedPHPApi.writeFile
@inheritDoc
Parameters
- path: string
- data: string | Uint8Array
Returns void