Class PhpStatic

autoTransaction

binary

onerror

onoutput

onready

phpArgs

OptionalphpVersion

queue

transactionStarted

analyzePath

• analyzePath(path: string): Promise<PhpPathAnalysis>

  Parameters

  • path: string

  Returns Promise<PhpPathAnalysis>

commitTransaction

• commitTransaction(readOnly?: boolean): Promise<void>

  Parameters

  • OptionalreadOnly: boolean

  Returns Promise<void>

exec

• exec(phpCode: string): Promise<PhpRuntimeValue>

  Parameters

  • phpCode: string

  Returns Promise<PhpRuntimeValue>

flush

• flush(): void

  Returns void

input

• input(items: Iterable<number>): void

  Parameters

  • items: Iterable<number>

  Returns void

inputString

• inputString(byteString: string): void

  Parameters

  • byteString: string

  Returns void

mkdir

• mkdir(path: string): Promise<PhpFileNode>

  Parameters

  • path: string

  Returns Promise<PhpFileNode>

r

• r(
      fragments: TemplateStringsArray,
      ...values: PhpTemplateValue[],
  ): Promise<number>

  Parameters

  • fragments: TemplateStringsArray
  • ...values: PhpTemplateValue[]

  Returns Promise<number>

readdir

• readdir(
      path: string,
      options?: PhpReadDirectoryOptions & { withFileTypes?: false },
  ): Promise<string[]>

  Parameters

  • path: string
  • Optionaloptions: PhpReadDirectoryOptions & { withFileTypes?: false }

  Returns Promise<string[]>

• readdir(
      path: string,
      options: PhpReadDirectoryOptions & { withFileTypes: true },
  ): Promise<PhpDirectoryEntry[]>

  Parameters

  • path: string
  • options: PhpReadDirectoryOptions & { withFileTypes: true }

  Returns Promise<PhpDirectoryEntry[]>

• readdir(
      path: string,
      options?: PhpReadDirectoryOptions,
  ): Promise<string[] | PhpDirectoryEntry[]>

  Parameters

  • path: string
  • Optionaloptions: PhpReadDirectoryOptions

  Returns Promise<string[] | PhpDirectoryEntry[]>

readFile

• readFile(
      path: string,
      options: PhpReadFileOptions & { encoding: "utf8" },
  ): Promise<string>

  Parameters

  • path: string
  • options: PhpReadFileOptions & { encoding: "utf8" }

  Returns Promise<string>

• readFile(
      path: string,
      options?: PhpReadFileOptions & { encoding?: "binary" },
  ): Promise<Uint8Array<ArrayBufferLike>>

  Parameters

  • path: string
  • Optionaloptions: PhpReadFileOptions & { encoding?: "binary" }

  Returns Promise<Uint8Array<ArrayBufferLike>>

• readFile(
      path: string,
      options?: PhpReadFileOptions,
  ): Promise<string | Uint8Array<ArrayBufferLike>>

  Parameters

  • path: string
  • Optionaloptions: PhpReadFileOptions

  Returns Promise<string | Uint8Array<ArrayBufferLike>>

refresh

• refresh(): Promise<number>

  Returns Promise<number>

rename

• rename(path: string, newPath: string): Promise<void>

  Parameters

  • path: string
  • newPath: string

  Returns Promise<void>

rmdir

• rmdir(path: string): Promise<void>

  Parameters

  • path: string

  Returns Promise<void>

run

• run(...args: [phpCode: string]): Promise<number>

  Parameters

  • ...args: [phpCode: string]

  Returns Promise<number>

startTransaction

• startTransaction(): Promise<void>

  Returns Promise<void>

stat

• stat(path: string): Promise<PhpFileStat>

  Parameters

  • path: string

  Returns Promise<PhpFileStat>

tokenize

• tokenize(phpCode: string): Promise<string>

  Parameters

  • phpCode: string

  Returns Promise<string>

unlink

• unlink(path: string): Promise<void>

  Parameters

  • path: string

  Returns Promise<void>

writeFile

• writeFile(
      path: string,
      data: string | ArrayBufferView<ArrayBufferLike>,
      options?: object,
  ): Promise<void>

  Parameters

  • path: string
  • data: string | ArrayBufferView<ArrayBufferLike>
  • Optionaloptions: object

  Returns Promise<void>

x

• x(
      fragments: TemplateStringsArray,
      ...values: PhpTemplateValue[],
  ): Promise<PhpRuntimeValue>

  Parameters

  • fragments: TemplateStringsArray
  • ...values: PhpTemplateValue[]

  Returns Promise<PhpRuntimeValue>