Open topic with navigation

You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.

PHP Toolkit Data Description

Short Data Format

Data structures are defined via PHP as follows:

Main data is an array of key-value pairs, where key is the parameter name and value is the array of:

• type - one of Data types
• type modifier
• • for CHAR, BYTE - integer describing length. Length can be number or name of the variable holding the length in the data structure.
  • for PACKED, ZONED - string "NUMBER.NUMBER" defining length and precision
  • for STRUCT - array containing data definition of the structure
  • for INT, FLOAT - ignored
• direction (optional) - one of I/O values
• count (optional)
• if integer - repetition count if the field is an array
• if string - reference to the repetition count field

Example:

<?php

$person = array(

    "name" => array(I5_TYPE_CHAR, 50),

    "age" => array(I5_TYPE_INT, 0),

    "ID" => array(I5_TYPE_BYTE, 10)

);

$data = array(

"person" => array(I5_TYPE_STRUCT, $person),

"last_accesses" => array(I5_TYPE_INT, 0, I5_OUT, 3),

"account_balance" => array(I5_TYPE_PACKED, "10.3", I5_OUT)

);

$prg = i5_program_prepare("MYLIB/PERSONPGM", $data);

?>

In any place data description is required; the name of the file with external data structure description can be used instead.

  Back to Top

Long Data Format

Data structure is defined via PHP as follows:

Main data is the array of values, having following fields:

• Name - name of the field
• Type - type of the field, can be one of Data types  
• Length
• • for CHAR, BYTE - integer describing length. Length can be number or name of the variable holding the length in the data structure.
  • for PACKED, ZONED - string "NUMBER.NUMBER" defining length and precision
  • for STRUCT - array containing data definition of the structure
  • for INT, FLOAT - ignored
• IO - can be one of I/O values
• Data structure is defined via PHP as follows:
• • DSName - name of the parameter
  • DSParm (optional) - array of the parameter of the Data structure. Each parameter is defined by a data definition in the same format as described here.
  • Count (optional) - repetition count if the field is an array
  • CountRef (optional) - reference to the repetition count if the field is an array

Example:

<?php

$description = Array(

                         array("Name"=>"P1", "IO"=>I5_INOUT, "Type"=>I5_TYPE_CHAR, "Length"=>"10", "count"=>5),

                         array("Name"=>"P2C", "IO"=>I5_INOUT, "Type"=>I5_TYPE_LONG),

                         array("Name"=>"P2", "IO"=>I5_INOUT, "Type"=>I5_TYPE_CHAR, "Length"=>"1", "countRef"=>"P2C"),

                         array("DSName"=>"PS", "count"=>2, "DSParm"=>array(

                                  array("Name"=>"PS1", "IO"=>I5_IN|I5_OUT, "Type"=>I5_TYPE_CHAR, "Length"=>"10"),

                                  array("Name"=>"PS2", "IO"=>I5_IN|I5_OUT, "Type"=>I5_TYPE_CHAR, "Length"=>"10"),

                                  array("Name"=>"PS3", "IO"=>I5_IN|I5_OUT, "Type"=>I5_TYPE_CHAR, "Length"=>"10"),

                                  )

                         )

                 );

$prg = eac_program_prepare("MYLIB/PERSONPGM", $description);

?>

  Back to Top

Data Types

  Back to Top

 I/O Values

• I5_IN
• I5_OUT

These values can be OR'ed together to get input-output value:

• I5_TYPE_RETVAL - return value for procedure call
• I5_TYPE_BYVAL - by-value parameter for procedure call
• default is input

Error Types

Data structures are defined via PHP as follows:

Main data is the array of values, having the following fields:

• Name - name of the field
• Type - type of the field, can be:
• • I5_TYPE_SHORT
  • I5_TYPE_LONG
  • I5_TYPE_DOUBLE
  • I5_TYPE_BIN
  • I5_TYPE_DATE
  • I5_TYPE_TIME
  • I5_TYPE_TIMESTP
  • I5_TYPE_DBCS
  • I5_TYPE_LONG8
  • I5_TYPE_NUMERICCHAR
  • I5_TYPE_BLOB
  • I5_TYPE_CLOB
  • I5_TYPE_UNICODE
  • I5_TYPE_VARCHAR
  • I5_TYPE_VARBIN
• Length
• • For CHAR, BYTE - integer describing length. Length can be number or name of the variable holding the length in the data structure.
  • For PACKED, ZONED - string "NUMBER.NUMBER" defining length and precision
  • For STRUCT - array containing data definition of the structure
  • For INT, FLOAT - ignored
• IO
• • I5_IN
  • I5_OUT
  • default is input, these values can be OR'ed together to get input-output value
• Count (optional) - repetition count if the field is an array
• CountRef (optional) - reference to the repetition count if the field is an array

Data structure is defined via PHP as follows:

• DSName - name of the parameter
• DSParm (optional) - array of the parameter of the Data structure. Each parameter is defined by a simple data definition.

Example:

<?php

$description = Array(

array("Name"=>"P1", "IO"=>I5_INOUT,

"Type"=>I5_TYPE_CHAR, "Length"=>"10", "count"=>5),

array("Name"=>"P2C", "IO"=>I5_INOUT, "Type"=>I5_TYPE_LONG),

array("Name"=>"P2", "IO"=>I5_INOUT, "Type"=>I5_TYPE_CHAR,

"Length"=>"1", "countRef"=>"P2C"),

array("DSName"=>"PS", "count"=>2, "DSParm"=>array(

array("Name"=>"PS1", "IO"=>I5_IN|I5_OUT, "Type"=>I5_TYPE_CHAR,

"Length"=>"10"),

array("Name"=>"PS2", "IO"=>I5_IN|I5_OUT, "Type"=>I5_TYPE_CHAR,

"Length"=>"10"),

array("Name"=>"PS3", "IO"=>I5_IN|I5_OUT, "Type"=>I5_TYPE_CHAR,

"Length"=>"10"),

                     )

                  )

             );

$prg = i5_program_prepare("MYLIB/PERSONPGM", $description);

?>

  Back to Top

Command Constants

I5_CURLIB (Default Value = "*CURLIB")

I5_ALL_OBJECTS (Default value = "*ALL")

I5_ALL_NAMES (Default value = "*")

I5_LIST_MINIMAL

I5_LIST_DETAILED

I5_LIST_FULL

  Back to Top

Active Job (i5_job_list) array elements constants

  Back to Top

Job Log Constants (i5_jobLog_list) array elements constants

  Back to Top

Errors

I5_TYPE_CHAR

I5_ERR_OK

I5_ERR_ERROR

I5_ERR_TOOMUCHOPENFILE

I5_ERR_MEMALLOC

  Back to Top

Data Retrieval Errors

  Back to Top

Function Errors

© 1999-2013 Zend Technologies, Ltd. All rights reserved.