Skip to content

Commit 9aa5f37

Browse files
committed
replace link to common repo with page describing common classes
1 parent d6c1e07 commit 9aa5f37

File tree

2 files changed

+33
-4
lines changed

2 files changed

+33
-4
lines changed

common.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Common classes and exceptions
2+
3+
The following common classes are available in namespace `phpsap\common`, and the exceptions are available in namespace `phpsap\exceptions`. See the [php-sap/common repository on github][common].
4+
5+
### Config
6+
7+
* `AbstractConfigContainer` A JSON encodeable configuration container implementing PSR-11 for retrieving configuration parameters.
8+
* `AbstractConfig` Configure basic connection parameters for SAP remote function calls, that are common to both connection types (A, and B) implementing `\phpsap\interfaces\IConfig`.
9+
* `AbstractConfigA` Configure connection parameters for SAP remote function calls using a specific SAP application server (type A) implementing `\phpsap\interfaces\IConfigA`.
10+
* `AbstractConfigB` Configure connection parameters for SAP remote function calls using load balancing (type B) implementing `\phpsap\interfaces\IConfigB`.
11+
12+
### Connection
13+
14+
* `AbstractConnection` Manages a PHP/SAP connection instance implementing `\phpsap\interfaces\IConnection`.
15+
* `ConnectionPool` Provides a static pool of available PHP/SAP connections. The connections are organized using their connection IDs. The connection ID ensures, that only one connection per configuration is established.
16+
17+
### Function
18+
19+
* `AbstractFunction` Manages a PHP/SAP remote function call implementing `\phpsap\interfaces\IFunction`.
20+
* `AbstractRemoteFunctionCall` Proxy class to simplify PHP/SAP remote function calls implementing `\phpsap\interfaces\IFunction`.
21+
22+
### Exceptions
23+
24+
* `SapException` a generic exception inherited by all other exception.
25+
* `ConfigKeyNotFoundException` in case a configuration key could not be found.
26+
* `IncompleteConfigException` in case `generateConfig()` cannot get all mandatory keys for the configuration.
27+
* `ConnectionFailedException` in case a connection could not be established.
28+
* `UnknownFunctionException` in case the remote function doesn't exist.
29+
* `FunctionCallException` in case the remote function call failed.
30+
31+
32+
[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."

index.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,8 @@ 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

16-
The [common classes and exceptions][common] add logic that is not specific to
16+
The [common classes and exceptions](common) add logic that is not specific to
1717
the underlying PHP module.
1818

1919
The module specific implementations contain code that is specific to [the
2020
underlying PHP-module](php-modules).
21-
22-
23-
[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."

0 commit comments

Comments
 (0)