Struct phper::classes::ClassEntity

pub struct ClassEntity<T: 'static> { /* private fields */ }

Builder for registering class.

<T> means the type of holding state.

It is a common practice for PHP extensions to use PHP objects to package third-party resources.

Implementations

impl ClassEntity<()>

pub fn new(class_name: impl Into<String>) -> Self

Construct a new ClassEntity with class name, do not own state.

impl<T: Default + 'static> ClassEntity<T>

pub fn new_with_default_state_constructor(class_name: impl Into<String>) -> Self

Construct a new ClassEntity with class name and default state constructor.

impl<T: 'static> ClassEntity<T>

pub fn new_with_state_constructor( class_name: impl Into<String>, state_constructor: impl Fn() -> T + 'static ) -> Self

Construct a new ClassEntity with class name and the constructor to build state.

pub fn add_method<F, Z, E>( &mut self, name: impl Into<String>, vis: Visibility, handler: F ) -> &mut MethodEntity

where F: Fn(&mut StateObj<T>, &mut [ZVal]) -> Result<Z, E> + 'static, Z: Into<ZVal> + 'static, E: Throwable + 'static,

Add member method to class, with visibility and method handler.

pub fn add_static_method<F, Z, E>( &mut self, name: impl Into<String>, vis: Visibility, handler: F ) -> &mut MethodEntity

where F: Fn(&mut [ZVal]) -> Result<Z, E> + 'static, Z: Into<ZVal> + 'static, E: Throwable + 'static,

Add static method to class, with visibility and method handler.

pub fn add_abstract_method( &mut self, name: impl Into<String>, vis: Visibility ) -> &mut MethodEntity

Add abstract method to class, with visibility (shouldn’t be private).

pub fn add_property( &mut self, name: impl Into<String>, visibility: Visibility, value: impl Into<Scalar> )

Declare property.

The argument value should be Copy because ‘zend_declare_property’ receive only scalar zval , otherwise will report fatal error: “Internal zvals cannot be refcounted”.

pub fn add_static_property( &mut self, name: impl Into<String>, visibility: Visibility, value: impl Into<Scalar> )

Declare static property.

The argument value should be Copy because ‘zend_declare_property’ receive only scalar zval , otherwise will report fatal error: “Internal zvals cannot be refcounted”.

pub fn extends(&mut self, parent: impl Fn() -> &'static ClassEntry + 'static)

Register class to extends the parent class.

Because in the MINIT phase, the class starts to register, so the closure is used to return the ClassEntry to delay the acquisition of the class.

Examples

use phper::classes::{ClassEntity, ClassEntry};

let mut class = ClassEntity::new("MyException");
class.extends(|| ClassEntry::from_globals("Exception").unwrap());

pub fn implements( &mut self, interface: impl Fn() -> &'static ClassEntry + 'static )

Register class to implements the interface, due to the class can implement multi interface, so this method can be called multi time.

Because in the MINIT phase, the class starts to register, so the closure is used to return the ClassEntry to delay the acquisition of the class.

Examples

use phper::classes::{ClassEntity, ClassEntry};

let mut class = ClassEntity::new("MyClass");
class.implements(|| ClassEntry::from_globals("Stringable").unwrap());

// Here you have to the implement the method `__toString()` in `Stringable`
// for `MyClass`, otherwise `MyClass` will become abstract class.
// ...

pub fn bind(&mut self, cls: &'static StaticStateClass<T>)

Bind to static StaticStateClass.

When the class registered, the StaticStateClass will be initialized, so you can use the StaticStateClass to new stateful object, etc.

pub fn state_cloner(&mut self, clone_fn: impl Fn(&T) -> T + 'static)

Add the state clone function, called when cloning PHP object.

By default, the object registered by phper is uncloneable, if you clone the object in PHP like this:

$foo = new Foo();
$foo2 = clone $foo;

Will throw the Error: Uncaught Error: Trying to clone an uncloneable object of class Foo.

And then, if you want the object to be cloneable, you should register the state clone method for the class.

Examples

use phper::classes::ClassEntity;

fn make_foo_class() -> ClassEntity<i64> {
    let mut class = ClassEntity::new_with_state_constructor("Foo", || 123456);
    class.state_cloner(Clone::clone);
    class
}