Skip to content

Commit d6c1e07

Browse files
committed
replace link to interfaces repo with page describing interfaces
1 parent 92630d4 commit d6c1e07

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ PHP/SAP defines a layer of abstraction between actual SAP remote function calls
99

1010
[![PHP/SAP](res/php-sap.svg)](res/php-sap.svg)
1111

12-
The [interfaces][interfaces] define a common denominator on how to configure a
12+
The [interfaces](interfaces) define a common denominator on how to configure a
1313
connection to SAP, prepare a SAP remote function call, and invoke a SAP remote
1414
function call.
1515

@@ -20,5 +20,4 @@ The module specific implementations contain code that is specific to [the
2020
underlying PHP-module](php-modules).
2121

2222

23-
[interfaces]: https://github.com/php-sap/interfaces "Interfaces for implementing the PHP/SAP API."
2423
[common]: https://github.com/php-sap/common "Exceptions and abstract classes containing logic for PHP/SAP that is not specific to the underlying PHP module."

interfaces.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Interfaces
2+
3+
The following PHP/SAP interfaces are available in namespace `phpsap\interfaces`. See the [php-sap/interfaces repository on github][interfaces].
4+
5+
### Config
6+
7+
The configuration interfaces are separated into a generic SAP configuration, that contains connection parameters that are common to both connection types (A and B), and connection type specific SAP configuration.
8+
9+
* `IConfig` Configure basic connection parameters for SAP remote function calls, that are common to both connection types (A, and B) and require a `generateConfig()` method, that returns the specific configuration structure of the underlying PHP module.
10+
* `IConfigA` Configure connection parameters for SAP remote function calls using a specific SAP application server (type A).
11+
* `IConfigB` Configure connection parameters for SAP remote function calls using load balancing (type B).
12+
13+
### Connection
14+
15+
* `IConnection` Manage a PHP/SAP connection instance.
16+
17+
### Function
18+
19+
* `IFunction` Manage a PHP/SAP remote function call.
20+
21+
### Exceptions
22+
23+
* `ISapException` Generic SAP exception.
24+
* `IIncompleteConfigException` The configuration is incomplete.
25+
* `IConnectionFailedException` The SAP connection failed.
26+
* `IUnknownFunctionException` The requested remote function could not be found.
27+
* `IFunctionCallException` The SAP remote function call failed.
28+
29+
[interfaces]: https://github.com/php-sap/interfaces "Interfaces for implementing the PHP/SAP API."

0 commit comments

Comments
 (0)