danog/ext-php-rs
1
0
Fork 0
mirror of https://github.com/danog/ext-php-rs.git synced 2024-11-30 04:39:04 +01:00
Code Issues Packages Projects Releases Wiki Activity
de326e3171
ext-php-rs/README.md

73 lines
2.7 KiB
Markdown
Raw Normal View History

Rename crate to ext-php-rs
2021-04-02 07:12:30 +02:00
# ext-php-rs
added readme, license, updated cargo.toml
2021-03-09 08:56:14 +01:00
Bindings for the Zend API to build PHP extensions natively in Rust. Inspired by [killertux/solder](https://github.com/killertux/solder) and its predecessors.
Updated Discord invite to use vanity URL
2021-04-18 07:02:04 +02:00
[![PHP Discorders](https://discord.com/api/guilds/115233111977099271/widget.png?style=banner1)](https://discord.gg/dphp)
Added Discord link to README
2021-04-09 02:36:30 +02:00
Build and deploy docs to Github pages (#35) * Added Github action for building and publishing docs * Create index redirect page for docs * Only deploy on master, fixed redirect
2021-05-04 01:42:52 +02:00
## Documentation
We are currently unable to deploy our documentation to `docs.rs` due to the crate requiring PHP 8.0, which is unavailable in the default Ubuntu repositories.
Documentation can be viewed [here](https://davidcole1340.github.io/ext-php-rs/). It is generated from the latest `master` branch. Documentation will be moved to `docs.rs` when Ubuntu updates its repositories
to PHP 8.0.
Updated README
2021-04-02 07:18:08 +02:00
## Features
This is not a set feature list, but these are the features on my roadmap. Create an issue if there's something you'd like to see!
- [x] Module definitions
- [x] Function implementation
- [x] Class implementation
- [x] Class methods
- [ ] Class properties
- [x] Class constants
Added ability to register constants (#22)
2021-04-18 06:48:58 +02:00
- [x] Module constants
Updated README
2021-04-02 07:18:08 +02:00
- [x] Calling PHP functions
added readme, license, updated cargo.toml
2021-03-09 08:56:14 +01:00
Implemented classes (#17) * Add PHP thread safety to build matrix * Revert "Add PHP thread safety to build matrix" This reverts commit 7de868e6b6e329b87c412af8daf61cba1a3e29c5. * Fixed arguments not being reconized by PHP * Added function to create interned Zend string * Changed statup/shutdown function types to Rust types Prevents users having to import from bindings * Added flags for classes * WIP: class builder * Added properties to classes * Added class constants * Added PHP base extensions Added class inheritance * Fixed memory leak with constants Created C wrapper which is compiled and linked in the `build.rs` script. In the process removed the `build_id()` function as now we can just export the macro via a function which is defined in `wrapper.c`. * Fixed lint issue * Added functions to set zval as different strings Regular strings, persistent strings and interned strings * Updated README with requirements * Fixed lint issues * Changed properties to use proper function * Free zend string when it is changed for a persistent one * WIP: overriding zend objects * Added comments to the top of modules. * Fixed some comments * Initialize hash map with initial size when converting from HashMap and Vec * Removed unused imports * WIP: object overrides * Added DerefMut implementation for ZendClassObject Tidied up lints that clippy was complaining about, removed debugging statements. * Fixed pointer dereference error in macro * Added missing comments for trait * All functions now take mutable references vs ptr Removed SetZval implementation for *mut Zval. Made bindings public, removed duplicate bindings. Fixed `create_object` handler not working. Note to self: smaller commits. * Showcase ability to use shared object * WIP: debugging property errors Changed `function` to `method` in classes Fixed doctest for `c_str` * Disabled class properties temporarily See #16 * Initialize args array with size
2021-04-02 03:18:45 +02:00
## Requirements
Updated README
2021-04-02 07:19:37 +02:00
- PHP 8.0 or later
- No support is planned for lower versions.
Added Clang to requirements
2021-04-20 06:40:35 +02:00
- Linux or Darwin-based OS
Implemented classes (#17) * Add PHP thread safety to build matrix * Revert "Add PHP thread safety to build matrix" This reverts commit 7de868e6b6e329b87c412af8daf61cba1a3e29c5. * Fixed arguments not being reconized by PHP * Added function to create interned Zend string * Changed statup/shutdown function types to Rust types Prevents users having to import from bindings * Added flags for classes * WIP: class builder * Added properties to classes * Added class constants * Added PHP base extensions Added class inheritance * Fixed memory leak with constants Created C wrapper which is compiled and linked in the `build.rs` script. In the process removed the `build_id()` function as now we can just export the macro via a function which is defined in `wrapper.c`. * Fixed lint issue * Added functions to set zval as different strings Regular strings, persistent strings and interned strings * Updated README with requirements * Fixed lint issues * Changed properties to use proper function * Free zend string when it is changed for a persistent one * WIP: overriding zend objects * Added comments to the top of modules. * Fixed some comments * Initialize hash map with initial size when converting from HashMap and Vec * Removed unused imports * WIP: object overrides * Added DerefMut implementation for ZendClassObject Tidied up lints that clippy was complaining about, removed debugging statements. * Fixed pointer dereference error in macro * Added missing comments for trait * All functions now take mutable references vs ptr Removed SetZval implementation for *mut Zval. Made bindings public, removed duplicate bindings. Fixed `create_object` handler not working. Note to self: smaller commits. * Showcase ability to use shared object * WIP: debugging property errors Changed `function` to `method` in classes Fixed doctest for `c_str` * Disabled class properties temporarily See #16 * Initialize args array with size
2021-04-02 03:18:45 +02:00
- Rust - no idea which version
Added Clang to requirements
2021-04-20 06:40:35 +02:00
- Clang 3.9 or greater
Implemented classes (#17) * Add PHP thread safety to build matrix * Revert "Add PHP thread safety to build matrix" This reverts commit 7de868e6b6e329b87c412af8daf61cba1a3e29c5. * Fixed arguments not being reconized by PHP * Added function to create interned Zend string * Changed statup/shutdown function types to Rust types Prevents users having to import from bindings * Added flags for classes * WIP: class builder * Added properties to classes * Added class constants * Added PHP base extensions Added class inheritance * Fixed memory leak with constants Created C wrapper which is compiled and linked in the `build.rs` script. In the process removed the `build_id()` function as now we can just export the macro via a function which is defined in `wrapper.c`. * Fixed lint issue * Added functions to set zval as different strings Regular strings, persistent strings and interned strings * Updated README with requirements * Fixed lint issues * Changed properties to use proper function * Free zend string when it is changed for a persistent one * WIP: overriding zend objects * Added comments to the top of modules. * Fixed some comments * Initialize hash map with initial size when converting from HashMap and Vec * Removed unused imports * WIP: object overrides * Added DerefMut implementation for ZendClassObject Tidied up lints that clippy was complaining about, removed debugging statements. * Fixed pointer dereference error in macro * Added missing comments for trait * All functions now take mutable references vs ptr Removed SetZval implementation for *mut Zval. Made bindings public, removed duplicate bindings. Fixed `create_object` handler not working. Note to self: smaller commits. * Showcase ability to use shared object * WIP: debugging property errors Changed `function` to `method` in classes Fixed doctest for `c_str` * Disabled class properties temporarily See #16 * Initialize args array with size
2021-04-02 03:18:45 +02:00
See the following links for the dependency crate requirements:
- [`cc`](https://github.com/alexcrichton/cc-rs#compile-time-requirements)
- [`bindgen`](https://rust-lang.github.io/rust-bindgen/requirements.html)
added readme, license, updated cargo.toml
2021-03-09 08:56:14 +01:00
## Usage
Added argument parsing for functions (#6) * Moved not required argument logic into function Seemed more logical, as you can't have a required argument after the not required argument. Usage: ```rs FunctionBuilder::new("skeleton_version", skeleton_version) .arg(Arg::new("req_arg1", DataType::String)) .arg(Arg::new("req_arg1", DataType::String)) .not_required() .arg(Arg::new("not_req_arg1", DataType::String)) .build() ``` * Added zend_value implementation Helper functions to retrieve the value from zvals * Started work on argument parser * Added PHP version support notice Due to the way the Zend API changes and the fact that the stable interface is exposed via C macros, there is no support for versions lower than PHP 8.0. In the future we can support PHP 7.4 through Rust features. * Added TryFrom implementations for Zval -> Types * Added ability to select arguments from ExecutionData * Added ability to parse arguments and retrieve val See `example/skel/src/lib.rs` for usage.
2021-03-10 07:50:44 +01:00
This project only works for PHP >= 8.0 (for now). Due to the fact that the PHP extension system relies heavily on C macros (which cannot be exported to Rust easily), structs have to be hard coded in.
Added opus-php to examples
2021-04-18 07:01:31 +02:00
There is only inline documentation for the time being. Starting by creating a C extension is a good start as well.
Check out one of the example projects:
- [ext-skel](example/skel) - Testbed for testing the library. Check out previous commits as well to see what else is possible.
- [opus-php](https://github.com/davidcole1340/opus-php/tree/rewrite_rs) - Work-in-progress extension to use the Opus library in PHP.
added readme, license, updated cargo.toml
2021-03-09 08:56:14 +01:00
added contributing clause
2021-03-09 08:58:07 +01:00
## Contributions
Contributions are very much welcome. I am a novice Rust developer and any suggestions are wanted and welcome. Feel free to file issues and PRs through Github.
Moved contribution section of `README`
2021-05-16 05:27:32 +02:00
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
Returning from functions (#9) * Added ability to set value of zval This allows the return value to now be set. See the example in `example/skel/src.lib`. * Added PHP internals book to resources * Pass self as pointer to keep consistency
2021-03-10 13:06:58 +01:00
## Resources
- [PHP Internals Book](https://www.phpinternalsbook.com/)
added readme, license, updated cargo.toml
2021-03-09 08:56:14 +01:00
## License
Relicense under MIT or Apache 2.0 (#27) * Relicense under MIT or Apache 2.0 * Updated license in README to match Rust guidelines
2021-04-22 10:01:30 +02:00
Licensed under either of
* Apache License, Version 2.0
([LICENSE_APACHE](LICENSE_APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE_MIT](LICENSE_MIT) or http://opensource.org/licenses/MIT)
at your option.
Reference in New Issue Copy Permalink