Struct ZObject

pub struct ZObject { /* private fields */ }

Wrapper of zend_object.

Implementations

impl ZObject

pub fn new( class_entry: &ClassEntry, arguments: impl AsMut<[ZVal]>, ) -> Result<Self>

Another way to new object like crate::classes::ClassEntry::new_object.

pub fn new_by_class_name( class_name: impl AsRef<str>, arguments: &mut [ZVal], ) -> Result<Self>

New object, like new, but get class by ClassEntry::from_globals.

pub fn new_by_std_class() -> Self

New object with class stdClass.

pub unsafe fn from_raw(ptr: *mut zend_object) -> Self

Create owned object From raw pointer, usually used in pairs with into_raw.

Safety

This function is unsafe because improper use may lead to memory problems. For example, a double-free may occur if the function is called twice on the same raw pointer.

pub fn into_raw(self) -> *mut zend_object

Consumes and returning a wrapped raw pointer.

Methods from Deref<Target = ZObj>

pub fn as_ptr(&self) -> *const zend_object

Returns a raw pointer wrapped.

pub fn as_mut_ptr(&mut self) -> *mut zend_object

Returns a raw pointer wrapped.

pub unsafe fn as_state_obj<T>(&self) -> &StateObj<T>

Upgrade to state obj.

Safety

Should only call this method for the class of object defined by the extension created by phper, otherwise, memory problems will caused.

pub unsafe fn as_mut_state_obj<T>(&mut self) -> &mut StateObj<T>

Upgrade to mutable state obj.

Safety

Should only call this method for the class of object defined by the extension created by phper, otherwise, memory problems will caused.

pub fn handle(&self) -> u32

Get the inner handle of object.

pub fn get_class(&self) -> &ClassEntry

Get the class reference of object.

pub fn get_mut_class(&mut self) -> &mut ClassEntry

Get the mutable class reference of object.

pub fn get_property(&self, name: impl AsRef<str>) -> &ZVal

Get the property by name of object.

pub fn get_mut_property(&mut self, name: impl AsRef<str>) -> &mut ZVal

Get the mutable property by name of object.

pub fn set_property(&mut self, name: impl AsRef<str>, val: impl Into<ZVal>)

Set the property by name of object.

pub fn call( &mut self, method_name: &str, arguments: impl AsMut<[ZVal]>, ) -> Result<ZVal>

Call the object method by name.

Examples

use phper::{alloc::EBox, classes::ClassEntry, values::ZVal};

fn example() -> phper::Result<ZVal> {
    let mut memcached = ClassEntry::from_globals("Memcached")?.new_object(&mut [])?;
    memcached.call(
        "addServer",
        &mut [ZVal::from("127.0.0.1"), ZVal::from(11211)],
    )?;
    let r = memcached.call("get", &mut [ZVal::from("hello")])?;
    Ok(r)
}

Trait Implementations

impl Borrow<ZObj> for ZObject

fn borrow(&self) -> &ZObj

Immutably borrows from an owned value.

impl Debug for ZObject

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ZObject

type Target = ZObj

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ZObject

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for ZObject

fn drop(&mut self)

Executes the destructor for this type.

impl From<ZObject> for ZVal

fn from(obj: ZObject) -> Self

Converts to this type from the input type.

impl RefClone for ZObject

fn ref_clone(&mut self) -> Self

Returns a refcount value with same reference of the value.