ext-php-rs 0.5.0

Bindings for the Zend API to build PHP extensions natively in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# Object

Objects can be returned from functions as instances or references. You can only
return a reference when you are returning an immutable reference to the object
the method is implemented on.

| `T` parameter | `&T` parameter | `T` Return type | `&T` Return type      | PHP representation               |
| ------------- | -------------- | --------------- | --------------------- | -------------------------------- |
| No            | No             | Yes             | Yes, as `ClassRef<T>` | A Rust struct and a Zend object. |

## Examples

### Returning a reference to `self`

```rust
# extern crate ext_php_rs;
use ext_php_rs::prelude::*;
use ext_php_rs::php::types::object::ClassRef;

#[php_class]
#[derive(Default)]
pub struct Example {
    foo: i32,
    bar: i32
}

#[php_impl]
impl Example {
    pub fn builder_pattern(&self) -> ClassRef<Example> {
        // As long as you return `self` from a method, you can unwrap this option.
        ClassRef::from_ref(self).unwrap()
    }
}
# #[php_module]
# pub fn get_module(module: ModuleBuilder) -> ModuleBuilder {
#     module
# }
```

### Creating a new class instance

```rust
# extern crate ext_php_rs;
use ext_php_rs::prelude::*;

#[php_class]
#[derive(Default)]
pub struct Example {
    foo: i32,
    bar: i32
}

#[php_impl]
impl Example {
    pub fn make_new(&self, foo: i32, bar: i32) -> Example {
        Example { foo, bar }
    }
}
# #[php_module]
# pub fn get_module(module: ModuleBuilder) -> ModuleBuilder {
#     module
# }
```