add missing @throws tags in PHPDoc #11

Author: gregor-j

src/AbstractFunction.php

@@ -11,6 +11,10 @@
 use phpsap\exceptions\UnknownFunctionException;
 use phpsap\interfaces\Config\IConfiguration;
 use phpsap\interfaces\Api\IApi;
+use phpsap\interfaces\exceptions\IConnectionFailedException;
+use phpsap\interfaces\exceptions\IIncompleteConfigException;
+use phpsap\interfaces\exceptions\IInvalidArgumentException;
+use phpsap\interfaces\exceptions\IUnknownFunctionException;
 use phpsap\interfaces\IFunction;
 use phpsap\interfaces\Util\IJsonSerializable;
 
@@ -45,6 +49,7 @@ abstract class AbstractFunction extends JsonSerializable implements IFunction
      * @return array
      * @throws ConnectionFailedException
      * @throws IncompleteConfigException
+     * @throws InvalidArgumentException
      * @throws UnknownFunctionException
      */
     protected function getAllowedKeys(): array
@@ -68,11 +73,15 @@ protected function getAllowedKeys(): array
      * defined. In case no SAP remote function call API has been defined, it will be
      * queried on the fly by connecting to the SAP remote system. In order to
      * connect to the SAP remote system, you need a connection configuration.
-     * @param string                                        $name   SAP remote function name.
-     * @param array|null                                    $params SAP remote function call parameters. Default: null
+     * @param string $name SAP remote function name.
+     * @param array|null $params SAP remote function call parameters. Default: null
      * @param IConfiguration|null $config Connection configuration. Default: null
-     * @param IApi|null              $api    SAP remote function call API. Default: null
+     * @param IApi|null $api SAP remote function call API. Default: null
      * @throws InvalidArgumentException
+     * @throws IConnectionFailedException
+     * @throws IIncompleteConfigException
+     * @throws IInvalidArgumentException
+     * @throws IUnknownFunctionException
      */
     public function __construct($name, array $params = null, IConfiguration $config = null, IApi $api = null)
     {
@@ -267,6 +276,10 @@ public function jsonSerialize(): array
      * Decode a formerly JSON encoded SAP remote function object.
      * @param string $json
      * @return AbstractFunction
+     * @throws IConnectionFailedException
+     * @throws IIncompleteConfigException
+     * @throws IInvalidArgumentException
+     * @throws IUnknownFunctionException
      * @throws InvalidArgumentException
      */
     public static function jsonDecode($json): IJsonSerializable

src/Api/Element.php

@@ -60,6 +60,7 @@ public function __construct($type, $name)
     /**
      * The PHP type of the element.
      * @return string
+     * @throws InvalidArgumentException
      */
     public function getType(): string
     {
@@ -72,6 +73,7 @@ public function getType(): string
     /**
      * The name of the element.
      * @return string
+     * @throws InvalidArgumentException
      */
     public function getName(): string
     {
@@ -121,6 +123,7 @@ protected function setName($name)
      * Cast a given output value to the type defined in this class.
      * @param mixed $value
      * @return bool|int|float|string|SapDateTime|SapDateInterval
+     * @throws InvalidArgumentException
      */
     public function cast($value)
     {

src/Api/RemoteApi.php

@@ -37,6 +37,7 @@ public function add(IValue $value): IApi
     /**
      * Get all input values of the remote function.
      * @return Value[]
+     * @throws InvalidArgumentException
      */
     public function getInputValues(): array
     {
@@ -46,6 +47,7 @@ public function getInputValues(): array
     /**
      * Get all output values of the remote function.
      * @return Value[]
+     * @throws InvalidArgumentException
      */
     public function getOutputValues(): array
     {
@@ -55,6 +57,7 @@ public function getOutputValues(): array
     /**
      * Get all tables of the remote function.
      * @return Table[]
+     * @throws InvalidArgumentException
      */
     public function getTables(): array
     {
@@ -65,6 +68,7 @@ public function getTables(): array
      * Get the API values according to their direction: input, output, table.
      * @param string $direction
      * @return array
+     * @throws InvalidArgumentException
      */
     protected function getValues($direction): array
     {

src/Api/Struct.php

@@ -65,6 +65,7 @@ public function __construct($name, $direction, $isOptional, $members)
      * @param array $value The output array to typecast.
      * @return array
      * @throws ArrayElementMissingException
+     * @throws InvalidArgumentException
      */
     public function cast($value): array
     {
@@ -88,6 +89,7 @@ public function cast($value): array
     /**
      * Return an array of member elements.
      * @return array
+     * @throws InvalidArgumentException
      */
     public function getMembers(): array
     {

src/Api/Table.php

@@ -64,6 +64,7 @@ public function __construct($name, $direction, $isOptional, $members)
      * @param array $value
      * @return array
      * @throws ArrayElementMissingException
+     * @throws InvalidArgumentException
      */
     public function cast($value): array
     {
@@ -90,6 +91,7 @@ public function cast($value): array
     /**
      * Return an array of member elements.
      * @return array
+     * @throws InvalidArgumentException
      */
     public function getMembers(): array
     {

src/Api/Value.php

@@ -53,6 +53,7 @@ public function __construct($type, $name, $direction, $isOptional)
     /**
      * Get the direction of the API value.
      * @return string
+     * @throws InvalidArgumentException
      */
     public function getDirection(): string
     {
@@ -65,6 +66,7 @@ public function getDirection(): string
     /**
      * Is the value optional?
      * @return bool
+     * @throws InvalidArgumentException
      */
     public function isOptional(): bool
     {

src/Config/ConfigCommon.php

@@ -35,6 +35,7 @@ abstract class ConfigCommon extends AbstractConfiguration implements IConfigComm
      * Get the username to use for authentication.
      * @return string
      * @throws IncompleteConfigException
+     * @throws InvalidArgumentException
      */
     public function getUser(): string
     {
@@ -66,6 +67,7 @@ public function setUser($user): IConfigCommon
      * Get the password to use for authentication.
      * @return string
      * @throws IncompleteConfigException
+     * @throws InvalidArgumentException
      */
     public function getPasswd(): string
     {
@@ -97,6 +99,7 @@ public function setPasswd($passwd): IConfigCommon
      * Get the client.
      * @return string
      * @throws IncompleteConfigException
+     * @throws InvalidArgumentException
      */
     public function getClient(): string
     {
@@ -129,6 +132,7 @@ public function setClient($client): IConfigCommon
      * the parameters are in the following format:
      * /H/hostname/S/portnumber/H/
      * @return string|null The saprouter or NULL in case the saprouter hasn't been set.
+     * @throws InvalidArgumentException
      */
     public function getSaprouter(): ?string
     {
@@ -165,6 +169,7 @@ public function setSaprouter($saprouter): IConfigCommon
     /**
      * Get the trace level (0-3). See constants TRACE_*.
      * @return int|null The trace level or NULL in case the trace level hasn't been set.
+     * @throws InvalidArgumentException
      */
     public function getTrace(): ?int
     {
@@ -200,6 +205,7 @@ public function setTrace($trace): IConfigCommon
      * codepage for the initial handshake, thus preserving the characters in
      * username/password.
      * @return int|null The codepage or NULL in case the codepage hasn't been set.
+     * @throws InvalidArgumentException
      */
     public function getCodepage(): ?int
     {
@@ -227,6 +233,7 @@ public function setCodepage($codepage): IConfigCommon
     /**
      * Get the logon Language.
      * @return string|null The logon language or NULL in case the logon language hasn't been set.
+     * @throws InvalidArgumentException
      */
     public function getLang(): ?string
     {
@@ -259,6 +266,7 @@ public function setLang($lang): IConfigCommon
     /**
      * Get the destination in RfcOpenConnection.
      * @return string|null The destination or NULL in case the destination hasn't been set.
+     * @throws InvalidArgumentException
      */
     public function getDest(): ?string
     {

src/Config/ConfigTypeA.php

@@ -40,6 +40,7 @@ class ConfigTypeA extends ConfigCommon implements IConfigTypeA
      * Get the host name of a specific SAP application server.
      * @return string The hostname of a specific SAP application server.
      * @throws IncompleteConfigException
+     * @throws InvalidArgumentException
      */
     public function getAshost(): string
     {
@@ -71,6 +72,7 @@ public function setAshost($ashost): IConfigTypeA
      * Get the SAP system number.
      * @return string The SAP system number.
      * @throws IncompleteConfigException
+     * @throws InvalidArgumentException
      */
     public function getSysnr(): string
     {
@@ -101,6 +103,7 @@ public function setSysnr($sysnr): IConfigTypeA
     /**
      * Get the gateway host on the application server.
      * @return string|null The gateway host or NULL in case no gateway host has been defined.
+     * @throws InvalidArgumentException
      */
     public function getGwhost(): ?string
     {
@@ -125,6 +128,7 @@ public function setGwhost($gwhost): IConfigTypeA
     /**
      * Get the gateway service on the application server.
      * @return string|null The gateway service or NULL in case no gateway service has been defined.
+     * @throws InvalidArgumentException
      */
     public function getGwserv(): ?string
     {

src/Config/ConfigTypeB.php

@@ -39,6 +39,7 @@ class ConfigTypeB extends ConfigCommon implements IConfigTypeB
      * Get the host name of the message server.
      * @return string
      * @throws IncompleteConfigException
+     * @throws InvalidArgumentException
      */
     public function getMshost(): string
     {
@@ -69,6 +70,7 @@ public function setMshost($mshost): IConfigTypeB
     /**
      * Get the name of SAP system, optional; default: destination
      * @return string|null The name of the SAP system or NULL in case no name has been defined.
+     * @throws InvalidArgumentException
      */
     public function getR3name(): ?string
     {
@@ -93,6 +95,7 @@ public function setR3name($r3name): IConfigTypeB
     /**
      * Get the group name of the application servers, optional; default: PUBLIC.
      * @return string group name of the application servers
+     * @throws InvalidArgumentException
      */
     public function getGroup(): ?string
     {