PHP Toolkit Overview

Important:

Using PHP scripts with SOAP web services requires PHP version 5.6 or later.

NetSuite provides a library and tools to assist in the development of PHP applications that interface to the SOAP web services platform.

The NetSuite PHP toolkit for SOAP web services is a core library containing all classes, objects and methods parsed from the WSDL of a SOAP web services endpoint. The toolkit also comes with several helper functions that can be used to simplify working with arrays and objects.

Important:

Each PHP Toolkit is specific to a SOAP web services endpoint. You must download the correct version of the toolkit for the endpoint you are using. Also, updating to a new endpoint requires an update of the toolkit. To use the 2023.2 PHP Toolkit, you must upgrade to the 2023.2 WSDL. The 2023.2 PHP Toolkit does not officially support different WSDL versions.

Updating Existing PHP Code

NetSuite offered a completely revamped PHP Toolkit as part of 2012.2. As of 2012.2, the PHP Toolkit has the ability to generate proxy classes for every new NetSuite WSDL, creating a development environment similar to Axis or .NET.

Additionally, the new toolkit uses a different programming model (the use of proxy classes over pure associative arrays, though the latter is still supported).

If you upgrade to any version of the PHP Toolkit later than 2012.2, existing PHP applications created using previous versions of the toolkit will need to be updated. To understand the nature of the coding changes, see the table below. Also see the sample applications that come with the new toolkit.

	PHP Toolkit 2012.2 and Later	PHP Toolkit Versions Older than 2012.2
Record object initialization	Each record type can now be initialized using the same record type name. Example - To initialize a Customer record object: $CustomerRec = new Customer();	Initialize the object using the object nsComplexObject. Example - To initialize a Customer record object: $CustomerRec = new nsComplexObject(‘Customer');
Object type Initialization All object types are listed and explained in Platform Enumerations.	Each complex, search and custom field type is initialized using the same object type name: Example - To initialize a basic search for customers: $selectTypeField = new RecordRef(); To initialize a recordRef object: $selectTypeField = new RecordRef();	These objects are initialized using the object nsComplexObject. Example - To initialize a basic search for customers: $search = new nsComplexObject(‘CustomerSearchBasic'); To initialize a recordRef object: $selectTypeField = new nsComplexObject (‘RecordRef');
Calling the NetSuite SOAP web services operations	The operations are called from the service object instantiated from the NetSuiteService class (NetSuiteService.php). Example - $service = new NetSuiteService(); … $addResponse = $service->add($request);	The operations are called from the client object instantiated from the nsClient class (declared on the phptoolkit.php). Example - $myNSclient = new nsClient( nsHost::live ); … $addResponse = $myNSclient->add($contact);
Request object	You must instantiate a request object depending on the kind of operation. This request object will accept the Record object, which will then be set to the operation. Each operation has a corresponding request type. AddRequest for add operation AddListRequest for addList operation SearchRequest for search operation. Example - To add a customer: $service = new NetSuiteService(); $CustomerRec = new Customer(); … $request = new AddRequest(); $request->record = $CustomerRec; … $addResponse = $service->add($request);	None. The record object is directly set to the operation. Example - To add a customer: $CustomerRec = new nsComplexObject(‘Customer'); … $addResponse = $myNSclient->add($CustomerRec);
The setFields method	A function to set an array of field objects to the record object. Example - $customerRec = new Customer(); $customerFields = array ( 'isPerson' => true, 'firstName' => $firstName, 'lastName' => $lastName, 'companyName' => $companyName ); setFields($customerRec, $ customerFields);	This is a method of the record object used to set the array of field values to the record. Example - $customerFields = array ( 'isPerson' => true, 'firstName' => $firstName, 'lastName' => $lastName, 'companyName' => $companyName ); // create Customer record $customer = new nsComplexObject('Customer'); // set fields $customer->setFields($customerFields);

PHP Toolkit 2012.2 and Later

PHP Toolkit Versions Older than 2012.2

Record object initialization

Each record type can now be initialized using the same record type name.

Example - To initialize a Customer record object:

$CustomerRec = new Customer();

Initialize the object using the object nsComplexObject.

Example - To initialize a Customer record object:

$CustomerRec = new nsComplexObject(‘Customer');

Object type Initialization

All object types are listed and explained in Platform Enumerations.

Each complex, search and custom field type is initialized using the same object type name:

Example - To initialize a basic search for customers:

$selectTypeField = new RecordRef();

To initialize a recordRef object:

$selectTypeField = new RecordRef();

These objects are initialized using the object nsComplexObject.

Example - To initialize a basic search for customers:

$search = new nsComplexObject(‘CustomerSearchBasic');

To initialize a recordRef object:

$selectTypeField = new nsComplexObject (‘RecordRef');

Calling the NetSuite SOAP web services operations

The operations are called from the service object instantiated from the NetSuiteService class (NetSuiteService.php).

Example -

$service = new NetSuiteService();

…

$addResponse = $service->add($request);

The operations are called from the client object instantiated from the nsClient class (declared on the phptoolkit.php).

Example -

$myNSclient = new nsClient( nsHost::live );

…

$addResponse = $myNSclient->add($contact);

Request object

You must instantiate a request object depending on the kind of operation. This request object will accept the Record object, which will then be set to the operation. Each operation has a corresponding request type.

AddRequest for add operation
AddListRequest for addList operation
SearchRequest for search operation.

Example - To add a customer:

$service = new NetSuiteService();

$CustomerRec = new Customer();

…

$request = new AddRequest();

$request->record = $CustomerRec;

…

$addResponse = $service->add($request);

None. The record object is directly set to the operation.

Example - To add a customer:

$CustomerRec = new nsComplexObject(‘Customer');

…

$addResponse = $myNSclient->add($CustomerRec);

The setFields method

A function to set an array of field objects to the record object.

Example -

$customerRec = new Customer();

$customerFields = array (

'isPerson' => true,

'firstName' => $firstName,

'lastName' => $lastName,

'companyName' => $companyName

);

setFields($customerRec, $ customerFields);

This is a method of the record object used to set the array of field values to the record.

Example -

$customerFields = array (

'isPerson' => true,

'firstName' => $firstName,

'lastName' => $lastName,

'companyName' => $companyName

);

// create Customer record

$customer = new nsComplexObject('Customer');

// set fields

$customer->setFields($customerFields);

Updating Existing PHP Code

Related Topics