WebPHP

Hierarchy

• BasePHP
  • WebPHP

Index

Properties

• requestHandler
• semaphore

Accessors

• absoluteUrl
• documentRoot

Methods

• [dispose]
• addEventListener
• chdir
• defineConstant
• dispatchEvent
• exit
• fileExists
• hotSwapPHPRuntime
• initializeRuntime
• internalUrlToPath
• isDir
• listFiles
• mkdir
• mkdirTree
• mv
• onMessage
• pathToInternalUrl
• readFileAsBuffer
• readFileAsText
• removeEventListener
• request
• rmdir
• run
• setPhpIniEntry
• setPhpIniPath
• setSapiName
• setSpawnHandler
• unlink
• writeFile
• load
• loadRuntime

Properties

optionalrequestHandler

requestHandler?: PHPRequestHandler<any>

Inherited from BasePHP.requestHandler

semaphore

semaphore: default

Inherited from BasePHP.semaphore

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

Accessors

absoluteUrl

• get absoluteUrl(): string

• Inherited from BasePHP.absoluteUrl

  @inheritDoc

  ---

  Returns string

documentRoot

• get documentRoot(): string

• Inherited from BasePHP.documentRoot

  @inheritDoc

  ---

  Returns string

Methods

[dispose]

• [dispose](): void

• Inherited from BasePHP.__@dispose@1651

  Returns void

addEventListener

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

• Inherited from BasePHP.addEventListener

  Parameters

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

  • listener: PHPEventListener

  Returns void

chdir

• chdir(path: string): void

• Inherited from BasePHP.chdir

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns void

defineConstant

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

• Inherited from BasePHP.defineConstant

  Parameters

  • key: string

  • value: null | string | number | boolean

  Returns void

dispatchEvent

• dispatchEvent<Event>(event: Event): void

• Inherited from BasePHP.dispatchEvent

  Type parameters

  • Event: PHPEvent

  Parameters

  • event: Event

  Returns void

exit

• exit(code?: number): void

• Inherited from BasePHP.exit

  Parameters

  • code: number = 0

  Returns void

fileExists

• fileExists(path: string): boolean

• Inherited from BasePHP.fileExists

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns boolean

hotSwapPHPRuntime

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

• Inherited from BasePHP.hotSwapPHPRuntime

  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

• Inherited from BasePHP.initializeRuntime

  Parameters

  • runtimeId: number

  Returns void

internalUrlToPath

• internalUrlToPath(internalUrl: string): string

• Inherited from BasePHP.internalUrlToPath

  @inheritDoc

  ---

  Parameters

  • internalUrl: string

  Returns string

isDir

• isDir(path: string): boolean

• Inherited from BasePHP.isDir

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns boolean

listFiles

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

• Inherited from BasePHP.listFiles

  @inheritDoc

  ---

  Parameters

  • path: string

  • options: ListFilesOptions = ...

  Returns string[]

mkdir

• mkdir(path: string): void

• Inherited from BasePHP.mkdir

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns void

mkdirTree

• mkdirTree(path: string): void

• Inherited from BasePHP.mkdirTree

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns void

mv

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

• Inherited from BasePHP.mv

  @inheritDoc

  ---

  Parameters

  • fromPath: string

  • toPath: string

  Returns void

onMessage

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

• Inherited from BasePHP.onMessage

  @inheritDoc

  ---

  Parameters

  • listener: MessageListener

  Returns Promise<void>

pathToInternalUrl

• pathToInternalUrl(path: string): string

• Inherited from BasePHP.pathToInternalUrl

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns string

readFileAsBuffer

• readFileAsBuffer(path: string): Uint8Array

• Inherited from BasePHP.readFileAsBuffer

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns Uint8Array

readFileAsText

• readFileAsText(path: string): string

• Inherited from BasePHP.readFileAsText

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns string

removeEventListener

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

• Inherited from BasePHP.removeEventListener

  Parameters

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

  • listener: PHPEventListener

  Returns void

request

• request(request: PHPRequest): Promise<PHPResponse>

• Inherited from BasePHP.request

  Do not use. Use new PHPRequestHandler() instead.

  @deprecated

  ---

  Parameters

  • request: PHPRequest

  Returns Promise<PHPResponse>

rmdir

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

• Inherited from BasePHP.rmdir

  @inheritDoc

  ---

  Parameters

  • path: string

  • options: RmDirOptions = ...

  Returns void

run

• run(request: PHPRunOptions): Promise<PHPResponse>

• Inherited from BasePHP.run

  @inheritDoc

  ---

  Parameters

  • request: PHPRunOptions

  Returns Promise<PHPResponse>

setPhpIniEntry

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

• Inherited from BasePHP.setPhpIniEntry

  @inheritDoc

  ---

  Parameters

  • key: string

  • value: string

  Returns void

setPhpIniPath

• setPhpIniPath(path: string): void

• Inherited from BasePHP.setPhpIniPath

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns void

setSapiName

• setSapiName(newName: string): Promise<void>

• Inherited from BasePHP.setSapiName

  @inheritDoc

  ---

  Parameters

  • newName: string

  Returns Promise<void>

setSpawnHandler

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

• Inherited from BasePHP.setSpawnHandler

  @inheritDoc

  ---

  Parameters

  • handler: string | SpawnHandler

  Returns Promise<void>

unlink

• unlink(path: string): void

• Inherited from BasePHP.unlink

  @inheritDoc

  ---

  Parameters

  • path: string

  Returns void

writeFile

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

• Inherited from BasePHP.writeFile

  @inheritDoc

  ---

  Parameters

  • path: string

  • data: string | Uint8Array

  Returns void

staticload

• load(phpVersion: 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2 | 7.1 | 7.0, options?: PHPWebLoaderOptions): Promise<WebPHP>

• Creates a new PHP instance.

  Dynamically imports the PHP module, initializes the runtime, and sets up networking. It’s a shorthand for the lower-level functions like getPHPLoaderModule, loadPHPRuntime, and PHP.initializeRuntime

  ---

  Parameters

  • phpVersion: 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2 | 7.1 | 7.0

    The PHP Version to load

  • options: PHPWebLoaderOptions = {}

    The options to use when loading PHP

  Returns Promise<WebPHP>

  A new PHP instance

staticloadRuntime

• loadRuntime(phpVersion: 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2 | 7.1 | 7.0, options?: PHPWebLoaderOptions): Promise<number>

• Parameters

  • phpVersion: 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2 | 7.1 | 7.0

  • options: PHPWebLoaderOptions = {}

  Returns Promise<number>