Struct FunctionBuilder

pub struct FunctionBuilder<'a> { /* private fields */ }

Builder for registering a function in PHP.

Implementations

impl<'a> FunctionBuilder<'a>

pub fn new<T: Into<String>>( name: T, handler: extern "C" fn(execute_data: &mut ExecuteData, retval: &mut Zval), ) -> Self

Creates a new function builder, used to build functions to be exported to PHP.

Parameters

• name - The name of the function.
• handler - The handler to be called when the function is invoked from PHP.

pub fn new_abstract<T: Into<String>>(name: T) -> Self

Create a new function builder for an abstract function that can be used on an abstract class or an interface.

Parameters

• name - The name of the function.

pub fn constructor( handler: extern "C" fn(execute_data: &mut ExecuteData, retval: &mut Zval), ) -> Self

Creates a constructor builder, used to build the constructor for classes.

Parameters

• handler - The handler to be called when the function is invoked from PHP.

pub fn arg(self, arg: Arg<'a>) -> Self

Adds an argument to the function.

Parameters

• arg - The argument to add to the function.

pub fn not_required(self) -> Self

Sets the rest of the given arguments as not required.

pub fn returns(self, type_: DataType, as_ref: bool, allow_null: bool) -> Self

Sets the return value of the function.

Parameters

• type_ - The return type of the function.
• as_ref - Whether the function returns a reference.
• allow_null - Whether the function return value is nullable.

pub fn docs(self, docs: DocComments) -> Self

Sets the documentation for the function. This is used to generate the PHP stubs for the function.

Parameters

• docs - The documentation for the function.

pub fn build(self) -> Result<FunctionEntry>

Builds the function converting it into a Zend function entry.

Returns a result containing the function entry if successful.

Errors

• Error::InvalidCString - If the function name is not a valid C string.
• Error::IntegerOverflow - If the number of arguments is too large.
• If arg info for an argument could not be created.
• If the function name contains NUL bytes.

Trait Implementations

impl<'a> Debug for FunctionBuilder<'a>

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

Formats the value using the given formatter.

impl From<FunctionBuilder<'_>> for Function

fn from(val: FunctionBuilder<'_>) -> Self

Converts to this type from the input type.