PHPackages symplely/zend-ffi - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. symplely/zend-ffi ActiveProject[API Development](/categories/api) symplely/zend-ffi ================= Provides the base API for creating extensions, or modifying Zend/PHP internal core with FFI. 0.12.8(3y ago)132.4k31MITCPHP >7.4 Since Dec 26Pushed 3y ago2 watchersCompare [ Source](https://github.com/symplely/zend-ffi)[ Packagist](https://packagist.org/packages/symplely/zend-ffi)[ Docs](https://github.com/symplely/zend-ffi)[ RSS](/packages/symplely-zend-ffi/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)DependenciesVersions (41)Used By (1) zend-ffi ======== [](#zend-ffi) [![zend-ffi tests](https://github.com/symplely/zend-ffi/actions/workflows/zend-ffi.yml/badge.svg)](https://github.com/symplely/zend-ffi/actions/workflows/zend-ffi.yml) Provides the base **API** for creating *extensions*, or modifying `Zend/PHP` internal *core* with FFI. - **For PHP 7.4, 8.0, 8.1, 8.2, Windows, Mac, Linux** It allows loading of shared libraries (`.dll` or `.so`), calling of **C functions** and accessing of **C type** data structures in pure `PHP`. This package breaks down the `Zend extension API` into *PHP classes* getting direct access to all PHP internal actions. You can actually change PHP default behaviors. You will be able to get the behavior of [componere](http://docs.php.net/manual/en/intro.componere.php) extension without needing it. Many routines here is a rewrite of [Z-Engine library](https://github.com/lisachenko/z-engine) package that use different terminology and setup structure. This package follow/keep PHP `C` source code style with a skeleton FFi installation process. There are many extensions on [Pecl](https://pecl.php.net/package-stats.php) that hasn't been updated. Installation ------------ [](#installation) *For normal standalone usage.* ``` composer require symplely/zend-ffi ``` *To setup a skeleton for FFI integration.* ``` composer create-project symplely/zend-ffi . ``` Minimum `php.ini` setting: ``` extension=ffi extension=openssl extension=sockets zend_extension=opcache [opcache] ; Determines if Zend OPCache is enabled opcache.enable=1 ; Determines if Zend OPCache is enabled for the CLI version of PHP opcache.enable_cli=1 [ffi] ; FFI API restriction. Possible values: ; "preload" - enabled in CLI scripts and preloaded files (default) ; "false" - always disabled ; "true" - always enabled ffi.enable="true" ; List of headers files to preload, wildcard patterns allowed. `ffi.preload` has no effect on Windows. ; See headers directory for `your-php-version`, this feature is untested, since not enabled for Windows. ;ffi.preload=path/to/vendor/symplely/zend-ffi/headers/ze(your-php-version).h ;This feature is untested. ;opcache.preload==path/to/vendor/symplely/zend-ffi/preload.php ``` For a simple FFI integration process **create/edit**: - `ffi_extension.json` each *package/library* should list the files to preload, will be process by `ffi_preloader.php` script. - `.ignore_autoload.php` will be called/executed by `composer create-project your_package .cdef/foldername` event. - This event is only called when your *package* is installed by `composer create-project` command. - `.preload.php` for general common FFI functions to be used, change the `tag_changeMe` skeleton name. - `.github\workflows\*.yml` these GitHub Actions is designed for cross-compiling and committing the `binary` back to your **repo**, change `some_lib` and `some_repo` skeleton names. - The idea of this is to make installation totally self-contained, the necessary third party library binary is bundled in. - The CI build Actions is setup for manually runs only. ``` // Skeleton for `ffi_extension.json` file { // The same name to be used in `composer create-project package .cdef/foldername` "name": "foldername", // Either "preload": { "files": [ "path/to/file.php", "...", "..." ], // Or "directory": [ "path/to/directory" ] } } ``` Documentation ------------- [](#documentation) The functions in [preload.php](https://github.com/symplely/zend-ffi/blob/main/preload.php) and [Functions.php](https://github.com/symplely/zend-ffi/blob/main/zend/Functions.php) should be used or expanded upon. See [tests](https://github.com/symplely/zend-ffi/tree/main/tests) folder for examples. Copy/paste the code between `--FILE--` and `--EXPECT--` blocks in the **.phpt** files. For general FFI `C data` handling see **CStruct** [*class*](https://github.com/symplely/zend-ffi/blob/main/zend/CStruct.php). Functions `c_int_type()`, `c_struct_type()`, `c_array_type()` and `c_typedef()` are wrappers for any *C data typedef* turning it into PHP **CStruct** class instance, with all **FFI** functions as methods with additional features. For [AST handling](https://dev.to/mrsuh/how-php-engine-builds-ast-1nc4): - `zend_parse_string()` will convert PHP source code into native *C data* `zend_ast` *node* held in **ZendAst** class, use `print_ast()` to display results. - `zend_ast_process(function(\ZE\AstProcess $hook){})` to intercept and modify AST after compilation process. Get the behavior of PHP extensions like [nikic/php-ast](https://github.com/nikic/php-ast) and [sgolemon/astkit](https://github.com/sgolemon/astkit/) that provide low-level bindings to the underlying AST structures, without any addition library. The whole PHP lifecycle process can be achieved by just extending **StandardModule** [*abstract class*](https://github.com/symplely/zend-ffi/blob/main/zend/StandardModule.php). ``` declare(strict_types=1); require 'vendor/autoload.php'; final class SimpleCountersModule extends \StandardModule { protected string $module_version = '0.4'; //Represents ZEND_DECLARE_MODULE_GLOBALS macro. protected string $global_type = 'unsigned int[10]'; // Do module startup? protected bool $m_startup = true; protected bool $r_startup = true; // Represents PHP_MINIT_FUNCTION() macro. public function module_startup(int $type, int $module_number): int { echo 'module_startup' . \PHP_EOL; return \ZE::SUCCESS; } // Represents PHP_RINIT_FUNCTION() macro. public function request_startup(...$args): int { echo 'request_startup' . \PHP_EOL; $data = $this->get_globals(); $data[5] = 25; return \ZE::SUCCESS; } // Represents PHP_GINIT_FUNCTION() macro. public function global_startup(\FFI\CData $memory): void { if (\PHP_ZTS) { \tsrmls_activate(); } echo 'global_startup' . \PHP_EOL; \FFI::memset($this->get_globals(), 0, $this->globals_size()); } } $module = new SimpleCountersModule(); if (!$module->is_registered()) { $module->register(); $module->startup(); } // Represents ZEND_MODULE_GLOBALS_ACCESSOR() macro. $data = $module->get_globals(); $module->get_globals('4', 20); $data[0] = 5; $data[9] = 15; var_dump($data); ob_start(); phpinfo(8); $value = ob_get_clean(); preg_match('/simple_counters support => enabled/', $value, $matches); var_dump($matches[0]); ``` A hack for `headers_sent()` like errors: **PHP Warning: Cannot modify header information - headers already sent by (output started at xxxxxxxx** ``` require 'vendor/autoload.php'; function headers_sent_reset() { zend_sg('headers_sent', 0); } echo 'any non-buffered output'; var_dump(headers_sent()); // true headers_sent_reset(); var_dump(headers_sent()); // false // This would have otherwise produced warning/errors! header('Location: http://www.example.com/'); ``` To create proper *FFI* C library headers from any `C` **ABI** library `*.h` file -------------------------------------------------------------------------------- [](#to-create-proper-ffi-c-library-headers-from-any-c-abi-library-h-file) Linux: `cpp -P -D"__attribute__(ARGS)=" path/to/original/header.h -o ffi_header.h`Windows: First download [mcpp](http://mcpp.sourceforge.net/)`mcpp -P -D"__attribute__(ARGS)=" path/to/original/header.h -o ffi_header.h` The option `-I ` might be needed to search/find additional include sources, and the output file will still need editing, mostly 96% proper headers, `FFI` will complain, just edit/check the 2 lines after the indicated line. Reference/Credits ----------------- [](#referencecredits) - [Introduction to PHP FFI](https://dev.to/verkkokauppacom/introduction-to-php-ffi-po3) - [How to Use PHP FFI in Programming](https://spiralscout.com/blog/how-to-use-php-ffi-in-programming) - [PHP FFI and what it can do for you](https://phpconference.com/blog/php-ffi-and-what-it-can-do-for-you/) - [Getting Started with PHP-FFI](https://www.youtube.com/watch?v=7pfjvRupoqg) **Youtube** - [Zend API - Hacking the Core of PHP](https://www.cs.helsinki.fi/u/laine/php/zend.html) - [PHP at the Core A Hacker's Guide - Manual](http://php.adamharvey.name/manual/en/internals2.php) - [PHP Internals Book](https://www.phpinternalsbook.com/index.html) - [Upgrading PHP extensions from PHP5 to NG](https://wiki.php.net/phpng-upgrading) - [Extending and Embedding PHP](https://flylib.com/books/en/2.565.1/) - [Whitepaper: Writing PHP Extensions - Zend](https://www.zend.com/sites/zend/files/pdfs/whitepaper-zend-php-extensions.pdf) **PDF** - [Part V: Extensibility](http://php.find-info.ru/php/016/part05.html) - [In-depth study of PHP & Zend Engine TSRM Algorithms](https://r00thunt.com/2015/10/02/in-depth-study-of-php-zend-engine-tsrm-algorithms/) - [Threads and PHP](http://blog.jpauli.tech/2017-01-12-threads-and-php-html/) - [Awesome PHP FFI](https://github.com/gabrielrcouto/awesome-php-ffi) - [Z-Engine library](https://github.com/lisachenko/z-engine) ### Possible Security Risks [](#possible-security-risks) - [Down the FFI Rabbit Hole](https://pwnfirstsear.ch/2020/07/20/0ctf2020-noeasyphp.html) ### The Beginning [](#the-beginning) - [About Zeev’s proposal of PHP superset](https://william-pinaud.medium.com/about-zeevs-proposal-of-php-superset-9e291f0de630) - [Low-Level Programming](https://startupnextdoor.com/low-level-programming/) - [Low-Level Programming: C, Assembly, and Program Execution](https://www.amazon.com/Low-Level-Programming-Assembly-Execution-Architecture/dp/1484224027) Contributing ------------ [](#contributing) Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on Github :) Create [Github Issues](https://github.com/symplely/uv-ffi/issues) for bugs and new features and comment on the ones you are interested in. License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE) for more information. ### Health Score 29 — LowBetter than 60% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community14 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 99.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~2 days Recently: every ~8 days Total 39 Last Release 1121d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/b1a9d88c23f07f785e0358746ae2384950a6f8dac0c3bd4fbbc910e94f7eb637?d=identicon)[techno-express](/maintainers/techno-express) --- Top Contributors [![TheTechsTech](https://avatars.githubusercontent.com/u/29784725?v=4)](https://github.com/TheTechsTech "TheTechsTech (302 commits)")[![DaGhostman](https://avatars.githubusercontent.com/u/2286949?v=4)](https://github.com/DaGhostman "DaGhostman (1 commits)") --- Tags apicoreextensionsextphp-extensionfficdatac-typezend-apizend-extension ### Embed Badge ![Health badge](/badges/symplely-zend-ffi/health.svg) ``` [![Health](https://phpackages.com/badges/symplely-zend-ffi/health.svg)](https://phpackages.com/packages/symplely-zend-ffi) ``` ### Alternatives [m165437/laravel-blueprint-docs API Blueprint Renderer for Laravel 22779.0k](/packages/m165437-laravel-blueprint-docs) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)