Previous topic

Change Log

Next topic

Command Line Tools

DOCUMENTATION
Last updated 19-Aug-2016

PHP Runtime Library

APS team recommends to use the APS PHP runtime library to make your development process more effective and efficient. PHP runtime methods make the low level REST communication and security procedures on the interface between the APS controller and APS applications transparent for APS packagers. Otherwise, they have to develop the whole stack of communication protocols themselves or customize a third party solution.

Download

Download the latest version of the APS PHP Runtime.

Once the package is downloaded, configure it as described in the Installation section.

Requirements

Make sure the following packages are installed on the system:

  • PHP 5.3 or later
  • PHP-XML

Details of PHP setup on Windows are available in the Setup document.

Installation

APS PHP Runtime provides a way to simplify creation of PHP-based APS applications.

  • On RPM-based Linux (RedHat/CentOS):

    rpm -ivh aps-php-runtime-{version}.noarch.rpm
    

    The /usr/share/aps/php folder will be added to the system php.ini file automatically.

  • On other systems:

    1. Extract aps-php-runtime-x.x-yyy.zip to a directory, which is included in the include_path declared in the php.ini configuration file. For example, include_path=".:/php/includes".
    2. Path aps/2/... should be inside the directory referred by the include_path variable. In accordance with the above example, the PHP runtime aps folder must be placed to the /php/includes/ folder.

Utilization

Use the following directive at the very beginning of your APS PHP application:

<?
    require_once "aps/2/runtime.php";
    ...
?>

Follow documentation on APS PHP runtime to use the library effectively in your applications.