Appendix F - I5 Toolkit Templates

Zend Studio IDE for i5 comes complete with the following code templates containing i5 PHP API Toolkit functions:

I5 Template

Explanation

i5ActiveJobs

Enables retrieving the system's active jobs, it:

  1. Connects to i5 server

  2. Opens active job list

  3. Gets array for an active job entry

  4. Closes handle received from i5_job_list function

  5. Closes connection to i5 server

i5Connect

Enables connecting to the i5 server, it:

  1. Connects to i5 server

  2. Closes connection to i5 server

i5DataAreaCreate

Creates the data area, it:

  1. Connects to i5 server

  2. Creates data area of given size

  3. Closes connection to i5 server

i5DataAreaDelete

Enables deleting the data area, it:

  1. Connects to i5 server

  2. Deletes data area

  3. Closes connection to i5 server

i5DataAreaRead

Enables reading from a data area, it:

  1. Connects to i5 server

  2. Reads from data area

  3. Closes connection to i5 server

i5DataAreaWrite

Enables reading from a data area, it:

  1. Connects to i5 server

  2. Reads from the data area

  3. Closes connection to i5 server

i5DtaqReceive

Enables reading data from the data queue without key, it:

  1. Connects to i5 server

  2. Reads data from the data queue without key

  3. Closes connection to i5 server

i5DtaqReceiveKey

Enables reading data from the data queue with key, it:

  1. Connects to i5 server

  2. Reads data from the data queue with key

  3. Closes connection to i5 server

i5DtaqSend

Enables putting data to the data queue without key, it:

  1. Connects to i5 server

  2. Puts data to the data queue without key

  3. Closes connection to i5 server

i5DtaqSendKey

Enables putting data into the data queue without a key, it

  1. Connects to i5 server

  2. Puts data to the data queue without key

  3. Closes connection to i5 server

i5JobLogs

Enables retrieving job log entries, it:

  1. Connects to i5 server

  2. Opens job log

  3. Gets array for a job log entry

  4. Closes handle received from i5_jobLog_list function

  5. Closes connection to i5 server

i5ObjectListing

Enables getting an array with the message element for an object list entry, it:

  1. Connects to i5 server

  2. Opens object list

  3. Gets for a object list entry

  4. Closes handle received from i5_objects_list function

  5. Closes connection to i5 server

i5Program

Enables calling a program and accept results from it, it:

  1. Connects to i5 server

  2. Opens a program or service procedure and prepares it to be run

  3. Calls the program and optionally accepts results

  4. Free program resource handle

  5. Closes connection to i5 server

i5ProgramService

Creates Web Services class enabling invoking an RPG program, it:

  1. Connects to i5 server

  2. Opens a program or service procedure and prepares it to be run

  3. Calls the program and optionally accepts results

  4. Free program resource handle

  5. Closes connection to i5 server

i5Spool

Enables getting spool file data from the queue and getting the data from the spool file, it:

  1. Connects to i5 server

  2. Creates an pool file lists, of certain output queue or for all queues

  3. Gets spool file data from the queue

  4. Get the data from the spool file

  5. Free spool list resource

  6. Closes connection to i5 server

i5UserSpaceCreate

Creates a new user space object, it:

  1. Connects to i5 server

  2. Creates new user space object

  3. Closes connection to i5 server

i5UserSpaceDelete

Enables deleting a user space object, it:

  1. Connects to i5 server

  2. Deletes user space object

  3. Closes connection to i5 server

i5UserSpaceGet

Retrieves user space data, it:

  1. Connects to i5 server

  2. Opens a user space and prepares it to be run

  3. Retrieves user space data

  4. Closes connection to i5 server

i5UserSpacePut

Enables to add user space data, it:

  1. Connects to i5 server

  2. Opens a user space and prepares it to be run

  3. Adds user space data

  4. Closes connection to i5 server