SAPNWRFC extension for PHP

  +----------------------------------------------------------------------+
  | PHP Version 7                                                        |
  +----------------------------------------------------------------------+
  | Copyright (c) 2009-2015 Piers Harding                                |
  +----------------------------------------------------------------------+
  | This source file is subject to version 3.01 of the PHP license,      |
  | that is bundled with this package in the file LICENSE, and is        |
  | available through the world-wide-web at the following url:           |
  | http://www.php.net/license/3_01.txt                                  |
  | If you did not receive a copy of the PHP license and are unable to   |
  | obtain it through the world-wide-web, please send a note to          |
  | license@php.net so we can mail you a copy immediately.               |
  +----------------------------------------------------------------------+
  | Author: Piers Harding <piers@ompka.net>                              |
  +----------------------------------------------------------------------+

Summary

Welcome to the sapnwrfc PHP package. This package is intended to facilitate RFC calls to an SAP R/3 system of release NW2004x and above. It may work for earlier versions but it hasn't been tested. The fundamental purpose of the production of this package, is to provide a clean object oriented interface to RFC calls from within PHP. This will hopefully have a number of effects:

make it really easy to do RFC calls to SAP from PHP in an object oriented fashion (Doh!)
promote PHP as the interface/scripting/glue language of choice for interaction with SAP R/3.
make the combination of Linux, Apache, and PHP the killer app for internet connectivity with SAP.
Establish a small fun open source project that people are more than welcome to contribute to, if they so wish.

Installation

Please see INSTALL.md

Check if it works

Listed as module?

Should list sapnwrfc in the extension list

php -m

Display the installed versions

var_dump(sapnwrfc_version());
var_dump(sapnwrfc_rfcversion());

Examples

We provides here some examples, to try your connection and do some RFC calls.

Execute unit tests

If you have downloaded the complete repository and you have phpunit installed globaly, you can execute from this repo root directory

phpunit

Getting started

use sapnwrfc;
use sapnwrfcConnectionException;
use sapnwrfcCallException;

// see parameters here: http://help.sap.com/saphelp_nwpi711/helpdata/en/48/c7bb09da5e31ebe10000000a42189b/content.htm
// example when using a message server
$config = [
    'MSHOST' => '...',

    'CLIENT' => '...',

    'R3NAME' => '...',
    'GROUP' => '...',

    'CODEPAGE' => '...',

    'LANG' => 'en',

    'LCHECK' => true,
    'TRACE' => true,

    'user' => '...',
    'passwd' => '...'
];

try {
    $conn = new sapnwrfc($config);
} catch(sapnwrfcConnectionException $ex){
    // do something!
}

if($conn->ping() === true){
    //call a real method
    try {
        $func = $conn->function_lookup('RFC_PING');

        /**
         * Call the function and return the result
         * @return array
         */
        $result = $func->invoke([]);
    } catch (sapnwrfcCallException $ex){
        // do something
    }
}

Documentation

Hint: change the log directory

The sapnwrfc will create a logfile, if you enable TRACE It will by default use the current working dir. You can view your with getcwd()

If you want to log it in the directory where you have your logfiles, just change the directory when you connect

$cwd = getcwd();
chdir('../your/log/folder');
try {
    $conn = new sapnwrfc($config);
} catch(sapnwrfcConnectionException $ex){
    // do something! e.g. log it
}
chdir($cwd); //change the cwd back to the previous value

Functions and classes

A list of all available functions/methods and their parameters + return values

<?php

/**
 * Get the version of this module
 * 
 * @return string
 */
function sapnwrfc_version()
{}

/**
 * Get the version of this module
 * Array keys: major, minor, cvs, ver
 *
 * @return array
 */
function sapnwrfc_version_array()
{}

/**
 * Get the sapnwrfc version
 *
 * @return string
 */
function sapnwrfc_rfcversion()
{}

/**
 * Set the ini file path for the RFC SDK
 *
 * @param string $path            
 * @return boolean
 */
function sapnwrfc_setinipath($path)
{}

/**
 * Reload the INI file for the NW RFC SDK
 *
 * @return boolean
 */
function sapnwrfc_reloadinifile()
{}

/**
 * Remove a function description from the cache RFC SDK
 *
 * @param string $systemId            
 * @param string $functionName            
 *
 * @return boolean
 */
function sapnwrfc_removefunction($systemId = '', $functionName)
{}

/**
 * Connect exception
 */
class sapnwrfcConnectionException extends Exception
{
    // @ todo define the error codes here
}

/**
 * Call exception
 */
class sapnwrfcCallException extends Exception
{
    // @ todo define the error codes here
}

/**
 * Connection class
 */
class sapnwrfc
{

    /**
     * Create a connection with SAP NW RFC
     *
     * @see http://help.sap.com/saphelp_nwpi711/helpdata/en/48/c7bb09da5e31ebe10000000a42189b/content.htm
     * @param array $config            
     * @throws sapnwrfcConnectionException
     */
    public function __construct(array $config);

    /**
     * Get the used connection parameters
     *
     * @return array
     */
    public function connection_attributes();

    /**
     *
     * @return boolean
     */
    public function close();

    /**
     * Is the server around?
     *
     * @return boolean
     */
    public function ping();

    /**
     * Get the SSO ticket
     *
     * @return string
     */
    public function get_sso_ticket();

    /**
     *
     * @param string $functionName            
     * @throws sapnwrfcConnectionException
     * @throws sapnwrfcCallException
     *
     * @return sapnwrfc_function
     */
    public function function_lookup($functionName);
}

/**
 * Function call class
 */
class sapnwrfc_function
{
    /**
     * @var string 
     */
    public $name;

    public function __construct();

    /**
     * 
     * @param array $parameters
     * @return array
     */
    public function invoke(array $parameters);

    /**
     * @param string $parameterName
     */
    public function activate($parameterName);

    /**
     * @param string $parameterName
     */
    public function deactivate($parameterName);

}

piersharding / php-sapnwrfc

readme