prepare update to interface v2 and common v3 releases

Author: gregor-j

Diff for: abstract-rfc.md

@@ -16,7 +16,6 @@ The following common classes are available in namespace `phpsap\common`, and the
 ### Function
 
 * `AbstractFunction` Manages a PHP/SAP remote function call implementing `\phpsap\interfaces\IFunction`.
-* `AbstractRemoteFunctionCall` Proxy class to simplify PHP/SAP remote function calls implementing `\phpsap\interfaces\IFunction`.
 
 ### Exceptions
 

Diff for: common.md

@@ -26,6 +26,12 @@ Especially short explanation for people in a hurry.
 Use `composer require` to add PHP/SAP to your project. Depending on the
  [PHP module](php-modules) you need to require a certain PHP/SAP composer
  package.
+ 
+ Module Author            | Module      | supported PHP versions | composer require
+ ------------------------ | ----------- | ---------------------- | -------------------------
+ [Eduard Koucky][koucky]  | `saprfc`    | PHP 4.x - 5.5.x        | `composer require php-sap/saprfc-koucky`
+ [Piers Harding][harding] | `sapnwrfc`  | PHP 5.x                | `composer require php-sap/saprfc-harding`
+ [Gregor Kralik][kralik]  | `sapnwrfc`  | PHP 7.x                | `composer require php-sap/saprfc-kralik`
 
 ```php
 <?php
@@ -40,7 +46,8 @@ $result = (new SapRfcConnection(new SapRfcConfigA([
   'passwd' => 'password'
 ])))
     ->prepareFunction('MY_COOL_SAP_REMOTE_FUNCTION')
-    ->invoke(['INPUT_PARAM' => 'value']);
+    ->setParam('INPUT_PARAM', 'some input value')
+    ->invoke();
 ```
 
 ## Documentation
@@ -49,5 +56,8 @@ $result = (new SapRfcConnection(new SapRfcConfigA([
     - [Configure a connection](saprfc-config)
     - [Establish a connection](saprfc-connection)
     - [Invoke a function call](saprfc-function)
-* [Extend `AbstractRemoteFunctionCall`](abstract-rfc)
 * [DateTime conversions for SAP](datetime)
+
+[koucky]: http://saprfc.sourceforge.net/ "SAPRFC extension module for PHP"
+[harding]: https://github.com/piersharding/php-sapnwrfc "SAP RFC Connector using the SAP NW RFC SDK for PHP"
+[kralik]: https://github.com/gkralik/php7-sapnwrfc "SAP NW RFC SDK extension for PHP7"

Diff for: index.md

@@ -3,7 +3,7 @@
 I inherited a project running on PHP 5.5.x containing undocumented code dealing
  with SAP remote function calls. As a way to connect, [Eduard Kouckys SAPRFC
  module][koucky] had been used. In order to switch to a more current PHP
- version, I had rewrite the PHP code and replace the PHP module too. The
+ version, I had to rewrite the PHP code and replace the PHP module too. The
  question was: How can I be sure, that the code of this project dealing with
  SAP remote function calls will not be the source of errors?
 
@@ -14,13 +14,10 @@ That lead to the following requirements:
 2. The code in my project dealing with SAP remote function calls has to work
    for several [PHP modules](php-modules) and it still has to work, in case
    of a switch to a different way of communicating with SAP.
-3. Any parameters of a SAP remote function call have to be defined as methods
-   as a way of documenting the API of a SAP remote function call via the
-   editors autocomplete functionality.
-4. The configuration has to be as interchangeable as possible between the PHP
+3. The configuration has to be as interchangeable as possible between the PHP
    modules.
 
-### Example 1: connect ➔ prepare ➔ invoke
+### Example: connect ➔ prepare ➔ invoke
 
 ```php
 <?php
@@ -41,75 +38,7 @@ $connection = new SapRfcConnection(new SapRfcConfigA($config));
 //prepare a function call
 $function = $connection->prepareFunction('MY_COOL_SAP_REMOTE_FUNCTION');
 //call the remote function
-$result = $function->invoke(['paramName' => 'value']);
-```
-
-### Example 2: extend remote function call
-
-```php
-<?php
-
-use phpsap\saprfc\AbstractRemoteFunctionCall;
-
-class MyCoolSapRemoteFunction extends AbstractRemoteFunctionCall
-{
-    /**
-     * Define the name of the remote function.
-     * @return string
-     */
-    public function getName()
-    {
-        return 'MY_COOL_SAP_REMOTE_FUNCTION';
-    }
-
-    /**
-     * Create the SAP remote function call parameters as code.
-     * @param int $value
-     * @return $this
-     */
-    public function paramA($value)
-    {
-        if (!is_int($value)) {
-            throw new InvalidArgumentException('Expected value to be int.');
-        }
-        return $this->setParam('paramA', $value);
-    }
-    
-    /**
-     * Call SAP remote function to see, if paramA succeeds.
-     * @param null|array $params Optional parameter array.
-     * @return bool success?
-     * @throws \phpsap\interfaces\exceptions\IConnectionFailedException
-     * @throws \phpsap\interfaces\exceptions\IUnknownFunctionException
-     * @throws \phpsap\exceptions\FunctionCallException
-     */
-    protected function invoke($params = null)
-    {
-        //parent returns array
-        $result = parent::invoke($params);
-        return $result['E_OK'] !== 'X';
-    }
-}
-```
-```php
-<?php
-
-use phpsap\saprfc\SapRfcConfigA;
-
-//stored configuration, JSON encoded
-$config = '{
-    "ashost": "sap.example.com",
-    "sysnr": "001",
-    "client": "01",
-    "user": "username",
-    "passwd": "password"
-}';
-//create a new SAP remote function instance using the stored configuration
-$remoteFunction = new MyCoolSapRemoteFunction(new SapRfcConfigA($config));
-//set the parameter for the SAP remote function
-$remoteFunction->paramA(123);
-//call the SAP remote function
-$result = $remoteFunction->invoke();
+$result = $function->setParam('paramName', 'value')->invoke();
 ```
 
 [koucky]: http://saprfc.sourceforge.net/ "SAPRFC extension module for PHP"

Diff for: motivation.md

@@ -2,7 +2,7 @@
 
 The following PHP modules are currently supported by PHP/SAP.
 
-Author                   | Module      | supported PHP versions | PHP/SAP composer package
+Module Author            | Module      | supported PHP versions | PHP/SAP composer package
 ------------------------ | ----------- | ---------------------- | -------------------------
 [Eduard Koucky][koucky]  | `saprfc`    | PHP 4.x - 5.5.x        | [![Packagist][koucky-version-badge]][koucky-packagist]
 [Piers Harding][harding] | `sapnwrfc`  | PHP 5.x                | [![Packagist][harding-version-badge]][harding-packagist]

Diff for: php-modules.md

@@ -31,10 +31,8 @@ digraph G {
         color=red;
         node [color=red];
         label="your code";
-        yourcode1 [label="connect ➔ prepare ➔ invoke"];
-        yourcode2 [label="extending AbstractRemoteFunctionCall"];
+        yourcode [label="connect ➔ prepare ➔ invoke"];
     }
-    yourcode1 -> "php-sap/saprfc-koucky" [lhead=cluster2 color=red];
-    yourcode2 -> "php-sap/saprfc-kralik" [lhead=cluster2 color=red];
+    yourcode -> "php-sap/saprfc-koucky" [lhead=cluster2 color=red];
 }
 @enduml

Diff for: res/php-sap.svg

@@ -112,7 +112,6 @@ $config = new SapRfcConfigA($configArray);
 
 [Go back to usage overview](usage)
  | [Continue with establishing a connection](saprfc-connection)
- | [Continue reading about extending `AbstractRemoteFunctionCall`](abstract-rfc)
 
 [jsonserializable]: http://php.net/manual/en/class.jsonserializable.php
 [parse_ini_file]: http://php.net/manual/de/function.parse-ini-file.php

Diff for: res/php-sap.txt

@@ -94,10 +94,10 @@ $remoteFunction->setParam('IV_BLUE', 'blue');
 
 /**
  * Invoke a remote function call using the parameters IV_RED='red' and
- * IV_BLUE='green' by overwriting IV_BLUE upon invoke.
+ * IV_BLUE='blue'.
  */ 
 try {
-    $result1 = $remoteFunction->invoke(['IV_BLUE' => 'green']);
+    $result1 = $remoteFunction->invoke();
 } catch (\phpsap\interfaces\exceptions\IFunctionCallException $exception) {
     printf(
         'The remote function call failed. Message: %s',
@@ -110,7 +110,7 @@ $remoteFunction->setParam('IV_RED', 'green');
 
 /**
  * Invoke a remote function call using the parameters IV_RED='green' and
- * IV_BLUE='green'.
+ * IV_BLUE='blue'.
  */ 
 try {
     $result2 = $remoteFunction->invoke();

Diff for: saprfc-config.md

@@ -10,9 +10,4 @@ In order to call a SAP remote function, you need to
  [configure](saprfc-config) a [connection](saprfc-connection) and then invoke a
  [function](saprfc-function).
 
-In case you want to use the SAP remote function API like any other PHP class,
- you can [extend `AbstractRemoteFunctionCall`](abstract-rfc) and you will get
- implicit documentation of your SAP remote function call parameters and the
- return value(s).
-
 [Continue reading on how to configure a connection](saprfc-config).