added optional variadic arguments example in docs and added directly passed arguments tests

Author: yoramdelangen

guide/src/macros/function.md

@@ -108,14 +108,27 @@ the `...$args` syntax.
 # use ext_php_rs::prelude::*;
 # use ext_php_rs::types::Zval;
 /// This can be called from PHP as `add(1, 2, 3, 4, 5)`
+/// note: it requires to set numbers with one or arguments
 #[php_function]
 pub fn add(number: u32, numbers:&[&Zval]) -> u32 {
+    println!("Extra numbers: {:?}", numbers);
+    // numbers is a slice of 4 Zvals all of type long
+    number
+}
+
+/// Having optional numbers can be done like:
+/// This can be called from PHP as `add(1)`, with no addional numbers given
+#[php_function(optional = "numbers")]
+pub fn add(number: u32, numbers:&[&Zval]) -> u32 {
+    println!("Optional numbers: {:?}", numbers);
     // numbers is a slice of 4 Zvals all of type long
     number
 }
 # fn main() {}
 ```
 
+Checkout more example in our [tests](https://github.com/davidcole1340/ext-php-rs/tree/master/tests/src/integration/variadic_args.php) location.
+
 ## Returning `Result<T, E>`
 
 You can also return a `Result` from the function. The error variant will be

tests/src/integration/variadic_args.php

@@ -25,3 +25,17 @@
 // } catch (ArgumentCountError $e) {
 //     var_dump($e->getMessage());
 // }
+
+// Values directly passed
+test_variadic_add_optional(1, 2, 3); // 1
+
+$count = test_variadic_add_optional(11); // 11
+assert($count === 11, 'Allow only one argument');
+
+$numbers = test_variadic_add_required(1, 2, 3, 4);
+assert($numbers === [1, 2, 3, 4], 'Must return a array of numbers');
+
+$types = test_variadic_all_types('a', 1, ['abc', 'def', 0.01], true, new stdClass);
+assert(gettype(end($types[2])) === 'double', 'Type of argument 2 and its last element should be a float of 0.01');
+assert($types[3], 'Arg 4 should be boolean true');
+assert($types[4] instanceof stdClass, 'Last argument is an instance of an StdClass');

tests/src/lib.rs

@@ -88,13 +88,33 @@ pub fn test_variadic_args(params: &[&Zval]) -> Vec<Zval> {
     params.iter().map(|x| x.shallow_clone()).collect()
 }
 
+#[php_function(optional = "numbers")]
+pub fn test_variadic_add_optional(number: u32, numbers:&[&Zval]) -> u32 {
+    println!("Optional numbers: {:?}", numbers);
+    // numbers is a slice of 4 Zvals all of type long
+    number
+}
+
+#[php_function]
+pub fn test_variadic_add_required(numbers:&[&Zval]) -> Vec<Zval> {
+    // numbers is a slice of 4 Zvals all of type long
+    // *numbers[0].as_number()
+    numbers.iter().map(|x| x.shallow_clone()).collect()
+}
+
+#[php_function(optional = "everything")]
+pub fn test_variadic_all_types(everything: &[&Zval]) -> Vec<Zval> {
+    everything.iter().map(|x| x.shallow_clone()).collect()
+}
+
 // Rust type &[&Zval] must be converted because to Vec<Zval> because
 // of lifetime hell...  #[php_function] does not support lifetime.
 // error1: error[E0261]: use of undeclared lifetime name `'a`
 // error2: lifetime `'a` is missing in item created through this procedural
 // macro #[php_function]
-// pub fn test_variadic_optional2_args<'a>(params: &'a [&'a Zval]) -> &'a [&'a
-// Zval] {     println!("Hiero: {:#?}", params);
+// pub fn test_variadic_optional_args<'a>(params: &'a [&'a Zval]) -> &'a [&'a
+// Zval] {
+//     println!("Params: {:#?}", params);
 //     params
 // }