Skip to content

Commit 69a85cc

Browse files
committed
add documentation link to readme and composer
1 parent 73bb29b commit 69a85cc

File tree

2 files changed

+5
-24
lines changed

2 files changed

+5
-24
lines changed

README.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,11 @@
99

1010
Exceptions and abstract classes containing logic for [PHP/SAP][phpsap] that is not specific to the underlying PHP module.
1111

12-
## Exceptions
13-
14-
The following exceptions are available in namespace `phpsap\exceptions`:
15-
16-
* `SapException` a generic exception inherited by all other exception.
17-
* `ConfigKeyNotFoundException` in case a configuration key could not be found.
18-
* `ConnectionFailedException` in case a connection could not be established.
19-
* `UnknownFunctionException` in case the remote function doesn't exist.
20-
* `FunctionCallException` in case the remote function call failed.
21-
22-
## Abstract classes
23-
24-
The abstract classes define the logic of the PHP/SAP library, that is not specific to the underlying PHP module used to talk to SAP.
25-
26-
These classes are available in namespace `phpsap\classes`:
27-
28-
* `AbstractConfigContainer` A JSON encodeable configuration container implementing PSR-11 for retrieving configuration parameters.
29-
* `AbstractConfig` Configure basic connection parameters for SAP remote function calls, that are common to both connection types (A, and B) implementing `\phpsap\interfaces\IConfig`.
30-
* `AbstractConfigA` Configure connection parameters for SAP remote function calls using a specific SAP application server (type A) implementing `\phpsap\interfaces\IConfigA`.
31-
* `AbstractConfigB` Configure connection parameters for SAP remote function calls using load balancing (type B) implementing `\phpsap\interfaces\IConfigB`.
32-
* `AbstractConnection` Manages a PHP/SAP connection instance implementing `\phpsap\interfaces\IConnection`.
33-
* `AbstractFunction` Manages a PHP/SAP remote function call implementing `\phpsap\interfaces\IFunction`.
34-
* `AbstractRemoteFunctionCall` Proxy class to simplify PHP/SAP remote function calls implementing `\phpsap\interfaces\IFunction`.
35-
* `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.
12+
[See PHP/SAP Common for documentation][doc]
3613

3714
[phpsap]: https://php-sap.github.io
3815
[license-mit]: https://img.shields.io/badge/license-MIT-blue.svg
16+
[doc]: https://php-sap.github.io/common "Common classes and exceptions | PHP/SAP"
3917
[travis-badge]: https://travis-ci.org/php-sap/common.svg?branch=master
4018
[travis-ci]: https://travis-ci.org/php-sap/common
4119
[maintainability-badge]: https://api.codeclimate.com/v1/badges/843db325cd8b83ff8eca/maintainability

composer.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
}
1212
],
1313
"homepage": "https://php-sap.github.io",
14+
"support": {
15+
"docs": "https://php-sap.github.io/common"
16+
},
1417
"keywords": [
1518
"phpsap",
1619
"php-sap"

0 commit comments

Comments
 (0)