Struct ext_php_rs::types::ZendCallable

pub struct ZendCallable<'a>(/* private fields */);

Acts as a wrapper around a callable Zval. Allows the owner to call the Zval as if it was a PHP function through the try_call method.

Implementations

impl<'a> ZendCallable<'a>

pub fn new(callable: &'a Zval) -> Result<Self>

Attempts to create a new ZendCallable from a zval.

Parameters

• callable - The underlying Zval that is callable.

Errors

Returns an error if the Zval was not callable.

pub fn new_owned(callable: Zval) -> Result<Self>

Attempts to create a new ZendCallable by taking ownership of a Zval. Returns a result containing the callable if the zval was callable.

Parameters

• callable - The underlying Zval that is callable.

pub fn try_from_name(name: &str) -> Result<Self>

Attempts to create a new ZendCallable from a function name. Returns a result containing the callable if the function existed and was callable.

Parameters

• name - Name of the callable function.

Example

use ext_php_rs::types::ZendCallable;

let strpos = ZendCallable::try_from_name("strpos").unwrap();
let result = strpos.try_call(vec![&"hello", &"e"]).unwrap();
assert_eq!(result.long(), Some(1));

pub fn try_call(&self, params: Vec<&dyn IntoZvalDyn>) -> Result<Zval>

Attempts to call the callable with a list of arguments to pass to the function.

You should not call this function directly, rather through the call_user_func macro.

Parameters

• params - A list of parameters to call the function with.

Returns

Returns the result wrapped in Ok upon success. If calling the callable fails, or an exception is thrown, an Err is returned.

Example

use ext_php_rs::types::ZendCallable;

let strpos = ZendCallable::try_from_name("strpos").unwrap();
let result = strpos.try_call(vec![&"hello", &"e"]).unwrap();
assert_eq!(result.long(), Some(1));

Trait Implementations

impl<'a> Debug for ZendCallable<'a>

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

Formats the value using the given formatter.

impl<'a> FromZval<'a> for ZendCallable<'a>

const TYPE: DataType = DataType::Callable

The corresponding type of the implemented value in PHP.

fn from_zval(zval: &'a Zval) -> Option<Self>

Attempts to retrieve an instance of Self from a reference to a Zval.

impl<'a> TryFrom<_zval_struct> for ZendCallable<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Zval) -> Result<Self>

Performs the conversion.