add interfaces

Author: gregor-j

src/IConfig.php

@@ -0,0 +1,84 @@
+<?php
+/**
+ * File src/IConfig.php
+ *
+ * Basic configuration interface.
+ *
+ * @package interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+
+namespace phpsap\interfaces;
+
+/**
+ * Interface IConfig
+ *
+ * Interface to configure basic connection parameters for SAP remote function calls.
+ *
+ * @package phpsap\interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+interface IConfig
+{
+    /**
+     * If the connection needs to be made through a firewall using a SAPRouter,
+     * specify the SAPRouter parameters in the following format:
+     * /H/hostname/S/portnumber/H/
+     * @return string the saprouter
+     */
+    public function getSaprouter();
+
+    /**
+     * Get the trace level (0-3)
+     * @return int the trace level
+     */
+    public function getTrace();
+
+    /**
+     * Only needed it if you want to connect to a non-Unicode backend using a
+     * non-ISO-Latin-1 user name or password. The RFC library will then use that
+     * codepage for the initial handshake, thus preserving the characters in
+     * username/password.
+     *
+     * @return int the codepage
+     */
+    public function getCodepage();
+
+    /**
+     * Get the username to use for authentication.
+     * @return string the username
+     */
+    public function getUser();
+
+    /**
+     * Get the password to use for authentication.
+     * @return string the password
+     */
+    public function getPasswd();
+
+    /**
+     * Get the destination in RfcOpen.
+     * @return string Get the destination in RfcOpen.
+     */
+    public function getClient();
+
+    /**
+     * Get the logon Language.
+     * @return string the logon language
+     */
+    public function getLang();
+
+    /**
+     * Get the destination in RfcOpenConnection.
+     * @return string the logon language
+     */
+    public function getDest();
+
+    /**
+     * Generate the configuration needed for connecting.
+     * @return mixed
+     */
+    public function generateConfig();
+}

src/IConfigA.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * File src/IConfigA.php
+ *
+ * Type A configuration interface.
+ *
+ * @package interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+
+namespace phpsap\interfaces;
+
+/**
+ * Interface IConfigA
+ *
+ * Interface to configure connection parameters for SAP remote function calls using
+ * a specific SAP application server (type A).
+ *
+ * @package phpsap\interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+interface IConfigA extends IConfig
+{
+    /**
+     * @var string A: RFC server is a specific SAP application server
+     */
+    const TYPE = 'A';
+
+    /**
+     * Get the host name of a specific SAP application server.
+     * @return string host name of a specific SAP application server
+     */
+    public function getAshost();
+
+    /**
+     * Get the SAP system number.
+     * @return string SAP system number
+     */
+    public function getSysnr();
+
+    /**
+     * optional; default: gateway on application server
+     * @return string gateway on application server
+     */
+    public function getGwhost();
+
+    /**
+     * optional; default: gateway on application server
+     * @return string gateway on application server
+     */
+    public function getGwserv();
+}

src/IConfigB.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * File src/IConfigB.php
+ *
+ * Type B configuration interface.
+ *
+ * @package interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+
+namespace phpsap\interfaces;
+
+/**
+ * Interface IConfigB
+ *
+ * Interface to configure connection parameters for SAP remote function calls using
+ * load balancing (type B).
+ *
+ * @package phpsap\interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+interface IConfigB extends IConfig
+{
+    /**
+     * @var string B: use Load Balancing feature
+     */
+    const TYPE = 'B';
+
+    /**
+     * Get the name of SAP system, optional; default: destination
+     * @return string name of SAP system.
+     */
+    public function getR3name();
+
+    /**
+     * Get the host name of the message server.
+     * @return string host name of the message server
+     */
+    public function getMshost();
+
+    /**
+     * Get the group name of the application servers, optional; default: PUBLIC.
+     * @return string group name of the application servers
+     */
+    public function getGroup();
+}

src/IConnection.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * File src/IConnection.php
+ *
+ * PHP/SAP connection interface.
+ *
+ * @package interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+
+namespace phpsap\interfaces;
+
+/**
+ * Interface IConnection
+ *
+ * PHP/SAP connection interface.
+ *
+ * @package phpsap\interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+interface IConnection
+{
+    /**
+     * Inject connection configuration.
+     * @param \phpsap\interfaces\IConfig $config connection configuration
+     */
+    public function __construct(IConfig $config);
+
+    /**
+     * Returns the connection ID.
+     * The connection ID is derived from the configuration. The same configuration
+     * will result in the same connection ID.
+     * @return string
+     */
+    public function getId();
+
+    /**
+     * Send a ping request via an established connection to verify that the
+     * connection works.
+     * @return boolean success?
+     * @throws \phpsap\exceptions\ConnectionFailedException
+     */
+    public function ping();
+
+    /**
+     * Prepare a remote function call and return a function instance.
+     * @param string $functionName
+     * @return \phpsap\interfaces\IFunction
+     */
+    public function prepareFunction($functionName);
+
+    /**
+     * Closes the connection.
+     * @return void
+     */
+    public function close();
+}

src/IFunction.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * File src/IFunction.php
+ *
+ * PHP/SAP function interface.
+ *
+ * @package interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+
+namespace phpsap\interfaces;
+
+use kbATeam\TypeCast\ITypeCast;
+
+/**
+ * Interface IFunction
+ *
+ * PHP/SAP function interface.
+ *
+ * @package phpsap\interfaces
+ * @author  Gregor J.
+ * @license MIT
+ */
+interface IFunction
+{
+    /**
+     * Get the function name.
+     * @return string
+     */
+    public function getName();
+
+    /**
+     * Remove all parameters that have been set and start over.
+     * @return \phpsap\interfaces\IFunction
+     */
+    public function reset();
+
+    /**
+     * Set function call parameter.
+     * @param string $name
+     * @param array|string|float|int|bool|null $value
+     * @return \phpsap\interfaces\IFunction
+     */
+    public function setParam($name, $value);
+
+    /**
+     * Invoke the prepared function call.
+     * @param null|array $params Optional parameter array.
+     * @return array
+     */
+    public function invoke($params = null);
+}