Trait RegisteredClass

pub trait RegisteredClass: Sized + 'static {
    const CLASS_NAME: &'static str;
    const BUILDER_MODIFIER: Option<fn(ClassBuilder) -> ClassBuilder>;
    const EXTENDS: Option<ClassEntryInfo>;
    const IMPLEMENTS: &'static [ClassEntryInfo];
    const FLAGS: ClassFlags = _;
    const DOC_COMMENTS: DocComments = _;

    // Required methods
    fn get_metadata() -> &'static ClassMetadata<Self>;
    fn get_properties<'a>() -> HashMap<&'static str, PropertyInfo<'a, Self>>;
    fn method_builders() -> Vec<(FunctionBuilder<'static>, MethodFlags)>;
    fn constructor() -> Option<ConstructorMeta<Self>>;
    fn constants(    ) -> &'static [(&'static str, &'static dyn IntoZvalDyn, DocComments)];
}

Implemented on Rust types which are exported to PHP. Allows users to get and set PHP properties on the object.

Required Associated Constants

const CLASS_NAME: &'static str

PHP class name of the registered class.

const BUILDER_MODIFIER: Option<fn(ClassBuilder) -> ClassBuilder>

Function to be called when building the class. Allows user to modify the class at runtime (add runtime constants etc).

const EXTENDS: Option<ClassEntryInfo>

Parent class entry. Optional.

const IMPLEMENTS: &'static [ClassEntryInfo]

Interfaces implemented by the class.

Provided Associated Constants

const FLAGS: ClassFlags = _

PHP flags applied to the class.

const DOC_COMMENTS: DocComments = _

Doc comments for the class.

Required Methods

fn get_metadata() -> &'static ClassMetadata<Self>

Returns a reference to the class metadata, which stores the class entry and handlers.

This must be statically allocated, and is usually done through the macro@php_class macro.

fn get_properties<'a>() -> HashMap<&'static str, PropertyInfo<'a, Self>>

Returns a hash table containing the properties of the class.

The key should be the name of the property and the value should be a reference to the property with reference to self. The value is a [PropertyInfo].

Instead of using this method directly, you should access the properties through the ClassMetadata::get_properties function, which builds the hashmap one and stores it in memory.

fn method_builders() -> Vec<(FunctionBuilder<'static>, MethodFlags)>

Returns the method builders required to build the class.

fn constructor() -> Option<ConstructorMeta<Self>>

Returns the class constructor (if any).

fn constants() -> &'static [(&'static str, &'static dyn IntoZvalDyn, DocComments)]

Returns the constants provided by the class.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl RegisteredClass for Closure

Available on crate feature closure only.

const CLASS_NAME: &'static str = "RustClosure"

const BUILDER_MODIFIER: Option<fn(ClassBuilder) -> ClassBuilder> = None

const EXTENDS: Option<ClassEntryInfo> = None

const IMPLEMENTS: &'static [ClassEntryInfo]