PHP Toolkit for IBM i

https://github.com/zendtech/ibmitoolkit
Admin
The PHP Toolkit for IBM i is a PHP-based front end to XMLSERVICE that helps programmers call RPG and...
Tokens:3,177
Snippets:40
Trust Score:8.2
License:BSD-3-Clause
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Composer Dependencies

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

Before making any code changes, ensure all project dependencies are installed using Composer.

```bash
$ composer install
```

--------------------------------

### Install Composer Dependencies

Source: https://github.com/zendtech/ibmitoolkit/wiki/Installation

Run this command after adding composer.json to your project to install the IBMiToolkit and enable classmap autoloading.

```bash
$ php composer.phar install
```

--------------------------------

### Run Unit Tests

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

Execute the project's unit tests to ensure your changes have not introduced regressions. This command assumes you have PHPUnit installed via Composer.

```bash
$ vendor/bin/phpunit
```

--------------------------------

### PHP Toolkit Parameter Functions

Source: https://github.com/zendtech/ibmitoolkit/blob/master/samples/data-types.md

Demonstrates how to use various AddParameter methods to define different data types for XMLService calls. Includes examples for character, zoned, packed decimal, float, real, binary, hole, boolean, time, timestamp, and date types.

```php
$tk->AddParameterChar( "both",32,  "char",       "mychar",    "");
$tk->AddParameterChar( "both",32,  "varchar2",   "myvchar2",  "",  "on");
$tk->AddParameterChar( "both",32,  "varchar4",   "myvchar4",  "",     4);
$tk->AddParameterZoned(      "both",12,2,"packed",     "mydec",    0.0);
$tk->AddParameterPackDec(      "both",12,2,"zoned",      "myzone",   0.0);
$tk->AddParameterFloat(      "both",     "float",      "myfloat",  0.0);
$tk->AddParameterReal(      "both",     "real",       "myreal",   0.0);
$tk->AddParameterBin(      "both", 9,  "binary",     "mybin", bin2hex(0xF1F2F3)); // to binary pack("H*", $hex)
$tk->AddParameterHole(             40,  "hole"                       );            // no output (zero input)
$tk->AddParameterChar(     "both",  4,  "boolean",    "mybool",   "1");
$tk->AddParameterChar(     "both",  8,  "time",       "mytime",   "09.45.29");
$tk->AddParameterChar(     "both", 26,  "timestamp",  "mystamp",  "2011-12-29-12.45.29.000000");
$tk->AddParameterChar(     "both", 10,  "date",       "mydate",   "2009-05-11");
```

--------------------------------

### Extract IBMiToolkit Archive

Source: https://github.com/zendtech/ibmitoolkit/wiki/Installation

Use this command to extract the downloaded IBMiToolkit tar.gz archive to your project directory.

```bash
$ cd /var/www/html/myproject/
$ tar -xzvf 1.6.0.tar.gz
```

--------------------------------

### Clone Forked Repository

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

Clone your forked copy of the repository to your local machine to begin making changes.

```bash
$ git clone https://github.com/yourGitHubUserName/repo.git
```

--------------------------------

### Add and Commit Changes Locally

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

Stage your modified files using 'git add' and then commit them with a descriptive message using 'git commit'.

```bash
$ git add [selection]
$ git commit -m ‘[commit message]’
```

--------------------------------

### Generate Composer Autoloader

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

If you add new classes, you must update the classmap autoloader in `/ToolkitApi/autoload.php` by running this command.

```bash
$ composer dump-autoload
```

--------------------------------

### Update Composer Dependencies

Source: https://github.com/zendtech/ibmitoolkit/wiki/Installation

If your project already has a composer.lock file, use this command to update the IBMi Toolkit and other dependencies.

```bash
$ php composer.phar update
```

--------------------------------

### Data Type Equivalents Table

Source: https://github.com/zendtech/ibmitoolkit/blob/master/samples/data-types.md

This table shows the mapping between C, RPG, XMLSERVICE, and SQL data types. It is useful for understanding data representation across different systems.

```text
C types          RPG types                     XMLSERVICE types                                   SQL types
===============  ============================  ================================================   =========
char             D mychar   32a                <data type='32a'/>                                 CHAR(32)
varchar2         D myvchar2 32a   varying      <data type='32a' varying='on'/>                    VARCHAR(32)
varchar4         D myvchar4 32a   varying(4)   <data type='32a' varying='4'/>
packed           D mydec    12p 2              <data type='12p2'/>                                DECIMAL(12,2)
zoned            D myzone   12s 2              <data type='12s2'/>                                NUMERIC(12,2)
float            D myfloat   4f                <data type='4f2'/>                                 FLOAT
real/double      D myreal    8f                <data type='8f4'/>                                 DOUBLE
binary           D mybin    (any)              <data type='9b'>F1F2F3</data>                      BINARY
hole (no out)    D myhole   (any)              <data type='40h'/>
boolean          D mybool    1n                <data type='4a'/>                                  CHAR(4)
time             D mytime     T   timfmt(*iso) <data type='8A'>09.45.29</data>                    TIME
timestamp        D mystamp    Z                <data type='26A'>2011-12-29-12.45.29.000000</data> TIMESTAMP
date             D mydate     D   datfmt(*iso) <data type='10A'>2009-05-11</data>                 DATE
int8/byte        D myint8    3i 0              <data type='3i0'/>                                 TINYINT   (unsupported DB2)
int16/short      D myint16   5i 0 (4b 0)       <data type='5i0'/>                                 SMALLINT
int32/int        D myint32  10i 0 (9b 0)       <data type='10i0'/>                                INTEGER
int64/longlong   D myint64  20i 0              <data type='20i0'/>                                BIGINT
uint8/ubyte      D myuint8   3u 0              <data type='3u0'/>
uint16/ushort    D myuint16  5u 0              <data type='5u0'/>
uint32/uint      D myuint32 10u 0              <data type='10u0'/>
uint64/ulonglong D myuint64 20u 0              <data type='20u0'/>
[indicator]      D myind     1a                <data type='1a'/>
```

--------------------------------

### PHP Toolkit Indicator and Data Structure Parameters

Source: https://github.com/zendtech/ibmitoolkit/blob/master/samples/data-types.md

Illustrates adding an indicator parameter, which is a 1-byte character representing a boolean ('0' or '1'), and adding a data structure parameter composed of an array of other parameters.

```php
$tk->AddParameterChar(      "out",  1,  "ind '0'/'1'" "myind",     ""); // indicator type is boolean 1-byte character
$tk->AddDataStruct      ([array of parameters],          "myds"         );
```

--------------------------------

### Create New Feature Branch

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

Create a new local branch for your feature or bugfix. Use a descriptive name that reflects the changes you are making.

```bash
$ git checkout -b [branch name]
```

--------------------------------

### Include Composer Autoloader

Source: https://github.com/zendtech/ibmitoolkit/wiki/Installation

Include the generated autoloader file in your PHP application to use the IBMi Toolkit via namespaces.

```php
require 'vendor/autoload.php';
```

--------------------------------

### PHP Toolkit Integer Parameter Functions

Source: https://github.com/zendtech/ibmitoolkit/blob/master/samples/data-types.md

Shows how to add integer parameters using ProgramParameter for types not directly supported by AddParameter methods (byte, short, ubyte, ushort) and using AddParameterInt32/64 for standard int and long long types.

```php
new ProgramParameter    ("3i0","both",     "byte",       "myint8",     0); // work around missing $tk->AddParameterInt8
new ProgramParameter    ("5i0","both",     "short",      "myint16",    0); // work around missing $tk->AddParameterInt16
$tk->AddParameterInt32  (      "both",     "int",        "myint32",    0);
$tk->AddParameterInt64  (      "both",     "longlong",   "myint64",    0);
new ProgramParameter    ("3u0","both",     "ubyte",      "myuint8",    0); // work around missing $tk->AddParameterUInt8
new ProgramParameter    ("5u0","both",     "ushort",     "myuint16",   0); // work around missing $tk->AddParameterUInt16
$tk->AddParameterUInt32 (      "both",     "uint",       "myuint32",   0);
$tk->AddParameterUInt64 (      "both",     "ulonglong",  "myuint64",   0);
```

--------------------------------

### Add Original Repository as Remote

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

Optionally, add the original repository as a remote named 'base'. This is useful for rebasing your local branch with changes from the main repository.

```bash
$ git remote add base https://github.com/zendtech/IbmiToolkit.git
```

--------------------------------

### Push Changes to Remote Feature Branch

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

Push your locally committed changes to the feature branch on your forked repository on GitHub.

```bash
$ git push origin [branch name]
```

--------------------------------

### Delete Local and Remote Branches

Source: https://github.com/zendtech/ibmitoolkit/wiki/Contributor-Guide

After your pull request is merged, you can optionally delete both your local and remote feature branches.

```bash
$ git branch -D [branch name]
$ git push origin --delete [branch name]
```
Tokens:
Raw