Struct ClassEntry

pub struct ClassEntry { /* private fields */ }

Wrapper of zend_class_entry.

Implementations

impl ClassEntry

pub unsafe fn from_ptr<'a>(ptr: *const zend_class_entry) -> &'a Self

Wraps a raw pointer.

Safety

Create from raw pointer.

Panics

Panics if pointer is null.

pub unsafe fn try_from_ptr<'a>(ptr: *const zend_class_entry) -> Option<&'a Self>

Wraps a raw pointer, return None if pointer is null.

Safety

Create from raw pointer.

pub unsafe fn from_mut_ptr<'a>(ptr: *mut zend_class_entry) -> &'a mut Self

Wraps a raw pointer.

Safety

Create from raw pointer.

Panics

Panics if pointer is null.

pub unsafe fn try_from_mut_ptr<'a>( ptr: *mut zend_class_entry, ) -> Option<&'a mut Self>

Wraps a raw pointer, return None if pointer is null.

Safety

Create from raw pointer.

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

Returns a raw pointer wrapped.

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

Returns a raw pointer wrapped.

pub fn from_globals(class_name: impl AsRef<str>) -> Result<&'static Self>

Create reference from global class name.

Examples

use phper::classes::ClassEntry;

let std_class = ClassEntry::from_globals("stdClass").unwrap();
let _obj = std_class.new_object([]).unwrap();

pub fn new_object(&self, arguments: impl AsMut<[ZVal]>) -> Result<ZObject>

Create the object from class and call __construct with arguments.

If the __construct is private, or protected and the called scope isn’t parent class, it will throw PHP Error.

pub fn init_object(&self) -> Result<ZObject>

Create the object from class, without calling __construct.

Be careful when __construct is necessary.

pub fn get_name(&self) -> &ZStr

Get the class name.

pub fn has_method(&self, method_name: &str) -> bool

Detect if the method is exists in class.

pub fn is_instance_of(&self, parent: &ClassEntry) -> bool

Detect if the class is instance of parent class.

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

Get the static property by name of class.

Return None when static property hasn’t register by ClassEntity::add_static_property.

pub fn set_static_property( &self, name: impl AsRef<str>, val: impl Into<ZVal>, ) -> Option<ZVal>

Set the static property by name of class.

Return Some(x) where x is the previous value of static property, or return None when static property hasn’t register by ClassEntity::add_static_property.

Trait Implementations

impl Clone for ClassEntry

fn clone(&self) -> ClassEntry

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClassEntry

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

Formats the value using the given formatter.

impl PartialEq for ClassEntry

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ClassEntry