documentation for functions

Author: jsoumelidis

functions/sap_connect.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * Creates a connection to a SAP backend.
+ * For documentation regarding logon parameters see the demo sapnwrfc.ini
+ * provided by your SAP Netweaver RFC SDK (available from SAP Marketplace).
+ *
+ * @param array $logonParameters
+ *
+ * @return resource
+ *
+ * @throws InvalidArgumentException If empty array provided
+ * @throws SapConnectionException   For invalid logon parameters or other error occured
+ */
+function sap_connect(array $logonParameters) {}

functions/sap_invoke_function.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Invokes a remote enabled function module on the backend and returns it's export parameters.
+ *
+ * @param string     $name    The remote function name to invoke
+ * @param array|null $imports import parameters
+ * @param bool|null  $rtrim   right-trim string fields, if null the global .ini setting will be used
+ *
+ * @return array export/changing/table parameters for this function
+ *
+ * @throws InvalidArgumentException if $connection is not a valid SAP Connection resource
+ * @throws LogicException           if no connection available, or function's description has not been fetched
+ *                                  through a Sap object
+ * @throws SapException             RFC raised exception or other error occured
+ */
+function sap_invoke_function(string $name, $connection, array $imports = null, bool $rtrim = null): array {}