Type Alias ext_php_rs::zend::ExecuteData

pub type ExecuteData = zend_execute_data;

Execute data passed when a function is called from PHP.

This generally contains things related to the call, including but not limited to:

• Arguments
• $this object reference
• Reference to return value
• Previous execute data

Aliased Type

struct ExecuteData {
    pub opline: *const _zend_op,
    pub call: *mut _zend_execute_data,
    pub return_value: *mut _zval_struct,
    pub func: *mut _zend_function,
    pub This: _zval_struct,
    pub prev_execute_data: *mut _zend_execute_data,
    pub symbol_table: *mut _zend_array,
    pub run_time_cache: *mut *mut c_void,
    pub extra_named_params: *mut _zend_array,
}

Fields

opline: *const _zend_op

call: *mut _zend_execute_data

return_value: *mut _zval_struct

func: *mut _zend_function

This: _zval_struct

prev_execute_data: *mut _zend_execute_data

symbol_table: *mut _zend_array

run_time_cache: *mut *mut c_void

extra_named_params: *mut _zend_array

Implementations

impl ExecuteData

pub fn parser(&mut self) -> ArgParser<'_, '_>

Returns an ArgParser pre-loaded with the arguments contained inside self.

Example

use ext_php_rs::{types::Zval, zend::ExecuteData, args::Arg, flags::DataType};

#[no_mangle]
pub extern "C" fn example_fn(ex: &mut ExecuteData, retval: &mut Zval) {
    let mut a = Arg::new("a", DataType::Long);

    // The `parse_args!()` macro can be used for this.
    let parser = ex.parser()
        .arg(&mut a)
        .parse();

    if parser.is_err() {
        return;
    }

    dbg!(a);
}

pub fn parser_object(&mut self) -> (ArgParser<'_, '_>, Option<&mut ZendObject>)

Returns an ArgParser pre-loaded with the arguments contained inside self.

A reference to $this is also returned in an Option, which resolves to None if this function is not called inside a method.

Example

use ext_php_rs::{types::Zval, zend::ExecuteData, args::Arg, flags::DataType};

#[no_mangle]
pub extern "C" fn example_fn(ex: &mut ExecuteData, retval: &mut Zval) {
    let mut a = Arg::new("a", DataType::Long);

    let (parser, this) = ex.parser_object();
    let parser = parser
        .arg(&mut a)
        .parse();

    if parser.is_err() {
        return;
    }

    dbg!(a, this);
}

pub fn parser_method<T: RegisteredClass>( &mut self ) -> (ArgParser<'_, '_>, Option<&mut ZendClassObject<T>>)

Returns an ArgParser pre-loaded with the arguments contained inside self.

A reference to $this is also returned in an Option, which resolves to None if this function is not called inside a method.

This function differs from parse_object in the fact that it returns a reference to a ZendClassObject, which is an object that contains an arbitrary Rust type at the start of the object. The object will also resolve to None if the function is called inside a method that does not belong to an object with type T.

Example

use ext_php_rs::{types::Zval, zend::ExecuteData, args::Arg, flags::DataType, prelude::*};

#[php_class]
#[derive(Debug)]
struct Example;

#[no_mangle]
pub extern "C" fn example_fn(ex: &mut ExecuteData, retval: &mut Zval) {
    let mut a = Arg::new("a", DataType::Long);

    let (parser, this) = ex.parser_method::<Example>();
    let parser = parser
        .arg(&mut a)
        .parse();

    if parser.is_err() {
        return;
    }

    dbg!(a, this);
}

#[php_module]
pub fn module(module: ModuleBuilder) -> ModuleBuilder {
    module
}

pub fn get_object<T: RegisteredClass>( &mut self ) -> Option<&mut ZendClassObject<T>>

Attempts to retrieve a reference to the underlying class object of the Zend object.

Returns a ZendClassObject if the execution data contained a valid object of type T, otherwise returns None.

Example

use ext_php_rs::{types::Zval, zend::ExecuteData, prelude::*};

#[php_class]
#[derive(Debug)]
struct Example;

#[no_mangle]
pub extern "C" fn example_fn(ex: &mut ExecuteData, retval: &mut Zval) {
    let this = ex.get_object::<Example>();
    dbg!(this);
}

#[php_module]
pub fn module(module: ModuleBuilder) -> ModuleBuilder {
    module
}

pub fn get_self(&mut self) -> Option<&mut ZendObject>

Attempts to retrieve the ‘this’ object, which can be used in class methods to retrieve the underlying Zend object.

Example

use ext_php_rs::{types::Zval, zend::ExecuteData};

#[no_mangle]
pub extern "C" fn example_fn(ex: &mut ExecuteData, retval: &mut Zval) {
    let this = ex.get_self();
    dbg!(this);
}

pub fn function(&self) -> Option<&Function>

Attempt to retrieve the function that is being called.

pub fn previous(&self) -> Option<&Self>

Attempt to retrieve the previous execute data on the call stack.