mintware-de/v8world

A wrapper for the ext-v8js php extension.

v1.0.0 2022-11-27 16:25 UTC

Requires

• php: ^8.1
• ext-v8js: ^2.1.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.13
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^9.5

MIT

• Julian Finkler

README

A wrapper for the v8js extension.

Why

Without V8 World

graph LR
  PHP-->|Typed|V8js-->|Untyped|JS
  JS-->|Typed|V8js-->|Rarely typed|PHP

With V8 World

graph LR
  PHP-->|Typed|V8World-->|Typed|V8js-->|Untyped|JS
  JS-->|Typed|V8js-->|Untyped|V8World-->|Fully Typed*|PHP

*: The real instance of objects is still an V8Object but the type hints will help you to reduce possible bugs.

How?

1. The wrapper takes an instance of \V8Js + an $initialState¹ class.
2. The phpdoc tells your IDE that the wrapper is an instance of \V8Js&InitialState.
3. Your IDE provides autocomplete features and your static analyzer should detect common typing problems.

Example

See _docs/example.md.

Important notes

This package is just a "band-aid for a bullet hole".

• Since V8World::modify() will not create a new instance of the V8Js object, the old V8World is also affected
  • The IDE will not provide autocompletion for the old V8World object but for the new one.
• Keep in mind that changing the stubs will not affect the underlying JS code - not even vice versa.
• Don't trust the stubs if you're working with objects and functions.
  • If a method returns an object or a property holds an instance of an object, V8Js always return an \V8Object
  • If a method returns an function or a property holds an instance of an function, V8Js always return an \V8Function

Footnotes

1. Usually this should be a stub interface ↩