add return type declarations #8

Author: gregor-j

src/Api/IApi.php

@@ -22,23 +22,23 @@ interface IApi extends IJsonSerializable
      * @param  IValue  $value
      * @return $this
      */
-    public function add(IValue $value);
+    public function add(IValue $value): IApi;
 
     /**
      * Get all input values of the remote function.
      * @return IValue[]
      */
-    public function getInputValues();
+    public function getInputValues(): array;
 
     /**
      * Get all output values of the remote function.
      * @return IValue[]
      */
-    public function getOutputValues();
+    public function getOutputValues(): array;
 
     /**
      * Get all tables of the remote function.
      * @return ITable[]
      */
-    public function getTables();
+    public function getTables(): array;
 }

src/Api/IArray.php

@@ -28,11 +28,11 @@ interface IArray extends IValue
      * @throws IArrayElementMissingException
      * @throws IInvalidArgumentException
      */
-    public function cast($value);
+    public function cast($value): array;
 
     /**
      * Return an array of member elements.
      * @return IElement[]
      */
-    public function getMembers();
+    public function getMembers(): array;
 }

src/Api/IElement.php

@@ -79,13 +79,13 @@ interface IElement extends IJsonSerializable
      * The PHP type of the element.
      * @return string
      */
-    public function getType();
+    public function getType(): string;
 
     /**
      * The name of the element.
      * @return string
      */
-    public function getName();
+    public function getName(): string;
 
     /**
      * Cast a given output value to the implemented value.

src/Api/IValue.php

@@ -39,11 +39,11 @@ interface IValue extends IElement
      * interface.
      * @return string
      */
-    public function getDirection();
+    public function getDirection(): string;
 
     /**
      * Is the element optional?
      * @return bool
      */
-    public function isOptional();
+    public function isOptional(): bool;
 }

src/Config/IConfigCommon.php

@@ -87,51 +87,51 @@ interface IConfigCommon extends IConfiguration
      * @return string The username.
      * @throws IIncompleteConfigException
      */
-    public function getUser();
+    public function getUser(): string;
 
     /**
      * Set the username to use for authentication.
      * @param  string  $user The username.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setUser(string $user);
+    public function setUser(string $user): IConfigCommon;
 
     /**
      * Get the password to use for authentication.
      * @return string The password.
      * @throws IIncompleteConfigException
      */
-    public function getPasswd();
+    public function getPasswd(): string;
 
     /**
      * Set the password to use for authentication.
      * @param  string  $passwd The password.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setPasswd(string $passwd);
+    public function setPasswd(string $passwd): IConfigCommon;
 
     /**
      * Get the client.
      * @return string The client
      * @throws IIncompleteConfigException
      */
-    public function getClient();
+    public function getClient(): string;
 
     /**
      * Set the client.
      * @param  string  $client The client.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setClient(string $client);
+    public function setClient(string $client): IConfigCommon;
 
     /**
      * Get the SAPRouter in case the connection needs to be made through a firewall.
      * @return string|null The saprouter or NULL in case the saprouter hasn't been set.
      */
-    public function getSaprouter();
+    public function getSaprouter(): ?string;
 
     /**
      * In case the connection needs to be made through a firewall using a SAPRouter,
@@ -141,21 +141,21 @@ public function getSaprouter();
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setSaprouter(string $saprouter);
+    public function setSaprouter(string $saprouter): IConfigCommon;
 
     /**
      * Get the trace level. See constants TRACE_*.
      * @return int|null The trace level or NULL in case the trace level hasn't been set.
      */
-    public function getTrace();
+    public function getTrace(): ?int;
 
     /**
      * Set the trace level. See constants TRACE_*.
      * @param  int  $trace The trace level.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setTrace(int $trace);
+    public function setTrace(int $trace): IConfigCommon;
 
     /**
      * Only needed it if you want to connect to a non-Unicode backend using a
@@ -164,7 +164,7 @@ public function setTrace(int $trace);
      * username/password.
      * @return int|null The codepage or NULL in case the codepage hasn't been set.
      */
-    public function getCodepage();
+    public function getCodepage(): ?int;
 
     /**
      * Only needed it if you want to connect to a non-Unicode backend using a
@@ -175,33 +175,33 @@ public function getCodepage();
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setCodepage(int $codepage);
+    public function setCodepage(int $codepage): IConfigCommon;
 
     /**
      * Get the logon Language.
      * @return string|null The logon language or NULL in case the logon language hasn't been set.
      */
-    public function getLang();
+    public function getLang(): ?string;
 
     /**
      * Set the logon language.
      * @param  string  $lang The logon language.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setLang(string $lang);
+    public function setLang(string $lang): IConfigCommon;
 
     /**
      * Get the destination in RfcOpenConnection.
      * @return string|null The destination or NULL in case the destination hasn't been set.
      */
-    public function getDest();
+    public function getDest(): ?string;
 
     /**
      * Set the destination in RfcOpenConnection.
      * @param  string  $dest The destination in RfcOpenConnection.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setDest(string $dest);
+    public function setDest(string $dest): IConfigCommon;
 }

src/Config/IConfigTypeA.php

@@ -42,56 +42,56 @@ interface IConfigTypeA extends IConfigCommon
      * @return string The hostname of a specific SAP application server.
      * @throws IIncompleteConfigException
      */
-    public function getAshost();
+    public function getAshost(): string;
 
     /**
      * Set the hostname of a specific SAP application server.
      * @param  string  $ashost The hostname of a specific SAP application server.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setAshost(string $ashost);
+    public function setAshost(string $ashost): IConfigTypeA;
 
     /**
      * Get the SAP system number.
      * @return string The SAP system number.
      * @throws IIncompleteConfigException
      */
-    public function getSysnr();
+    public function getSysnr(): string;
 
     /**
      * Set the SAP system number.
      * @param  string  $sysnr The SAP system number.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setSysnr(string $sysnr);
+    public function setSysnr(string $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.
      */
-    public function getGwhost();
+    public function getGwhost(): ?string;
 
     /**
      * Set the gateway host on the application server.
      * @param  string  $gwhost The gateway host.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setGwhost(string $gwhost);
+    public function setGwhost(string $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.
      */
-    public function getGwserv();
+    public function getGwserv(): ?string;
 
     /**
      * Set the gateway service on the application server.
      * @param  string  $gwserv The gateway service on the application server.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setGwserv(string $gwserv);
+    public function setGwserv(string $gwserv): IConfigTypeA;
 }

src/Config/IConfigTypeB.php

@@ -38,41 +38,41 @@ interface IConfigTypeB extends IConfigCommon
      * @return string
      * @throws IIncompleteConfigException
      */
-    public function getMshost();
+    public function getMshost(): string;
 
     /**
      * Set the host name of the message server.
      * @param  string  $mshost The host name of the message server.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setMshost(string $mshost);
+    public function setMshost(string $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.
      */
-    public function getR3name();
+    public function getR3name(): ?string;
 
     /**
      * Set the name of SAP system, optional; default: destination
      * @param  string  $r3name The name of the SAP system.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setR3name(string $r3name);
+    public function setR3name(string $r3name): IConfigTypeB;
 
     /**
      * Get the group name of the application servers, optional; default: PUBLIC.
      * @return string|null The name of the group  or NULL in case no group has been defined.
      */
-    public function getGroup();
+    public function getGroup(): ?string;
 
     /**
      * Set the group name of the application servers, optional; default: PUBLIC.
      * @param  string  $group The group name of the application servers.
      * @return $this
      * @throws IInvalidArgumentException
      */
-    public function setGroup(string $group);
+    public function setGroup(string $group): IConfigTypeB;
 }