Overview

What is it?

php-opcua/opcua-client-nodeset provides pre-generated PHP classes from the OPC Foundation UA-Nodeset companion specifications. It gives you NodeId constants, PHP enums, typed DTOs, binary codecs, and registrars for 51 companion specifications — 807 PHP files total. Zero configuration: install, load a registrar, and start reading typed data.

Installation

composer require php-opcua/opcua-client-nodeset

Requires php-opcua/opcua-client ^4.1.

Quick Start

use PhpOpcua\Client\ClientBuilder;
use PhpOpcua\Nodeset\Robotics\RoboticsRegistrar;
use PhpOpcua\Nodeset\Robotics\RoboticsNodeIds;
use PhpOpcua\Nodeset\Robotics\Enums\OperationalModeEnumeration;

$client = ClientBuilder::create()
    ->loadGeneratedTypes(new RoboticsRegistrar())  // loads DI + IA dependencies automatically
    ->connect('opc.tcp://192.168.1.100:4840');

// Enum values are auto-cast to PHP BackedEnum
$mode = $client->read(RoboticsNodeIds::OperationalMode)->getValue();
// OperationalModeEnumeration::MANUAL_REDUCED_SPEED (not int 1)

if ($mode === OperationalModeEnumeration::MANUAL_HIGH_SPEED) {
    echo "Robot in manual high speed mode\n";
}

What Gets Generated

Each companion specification produces up to five types of PHP files:

NodeId Constants

String constants for every node in the specification. Use them directly with read(), write(), and browse():

use PhpOpcua\Nodeset\DI\DINodeIds;

$value = $client->read(DINodeIds::DeviceType)->getValue();

PHP Enums

BackedEnum classes for OPC UA enumeration types. When loaded via loadGeneratedTypes(), reading an enum node returns the PHP enum directly instead of a raw int:

use PhpOpcua\Nodeset\Robotics\Enums\MotionDeviceCategoryEnumeration;

$category = MotionDeviceCategoryEnumeration::ARTICULATED_ROBOT; // int 1

Typed DTOs

Readonly classes with typed properties for structured data types. Enum fields are typed with the generated enum class, array fields use array, and optional fields are nullable:

$data = $client->read(DINodeIds::SomeStructuredNode)->getValue();
$data->Manufacturer;   // string
$data->SerialNumber;   // string
$data->Status;         // PHP enum (auto-cast)

Binary Codecs

ExtensionObjectCodec implementations that decode and encode OPC UA binary data into the typed DTOs. Registered automatically via the Registrar.

Registrar

Each specification has a Registrar implementing GeneratedTypeRegistrar. Pass it to loadGeneratedTypes() on the client builder:

use PhpOpcua\Nodeset\MachineTool\MachineToolRegistrar;

$client = ClientBuilder::create()
    ->loadGeneratedTypes(new MachineToolRegistrar())
    ->connect('opc.tcp://192.168.1.100:4840');

Automatic Dependency Resolution

OPC UA companion specifications depend on each other. When you load a Registrar, its dependencies are loaded automatically:

// Loading MachineTool automatically loads: Machinery, DI, IA
$client = ClientBuilder::create()
    ->loadGeneratedTypes(new MachineToolRegistrar())
    ->connect('opc.tcp://192.168.1.100:4840');

To load only the specification itself without dependencies:

$client = ClientBuilder::create()
    ->loadGeneratedTypes(new MachineToolRegistrar(only: true))
    ->connect('opc.tcp://192.168.1.100:4840');

Loading Multiple Specifications

Stack multiple registrars on the builder. Duplicates are handled gracefully:

$client = ClientBuilder::create()
    ->loadGeneratedTypes(new DIRegistrar())
    ->loadGeneratedTypes(new RoboticsRegistrar())
    ->loadGeneratedTypes(new MachineToolRegistrar())
    ->connect('opc.tcp://192.168.1.100:4840');

Available Specifications

51 companion specifications are included. Totals: 338 enums, 191 typed DTOs, 191 codecs, 51 registrars, 51 NodeId constant classes.

Backward Compatibility

Loading generated types is opt-in. Without loadGeneratedTypes(), everything works exactly as before — raw int values, array-based structures, no type wrapping.

Using with opcua-client

The package is designed as a companion to php-opcua/opcua-client. The workflow is:

1. Install both packages.
2. Identify which companion specifications your OPC UA server implements (e.g., Robotics, MachineTool, DI).
3. Load the corresponding registrars via loadGeneratedTypes() on the ClientBuilder.
4. Read, write, and browse using the generated NodeId constants and typed return values.

use PhpOpcua\Client\ClientBuilder;
use PhpOpcua\Nodeset\MachineTool\MachineToolRegistrar;
use PhpOpcua\Nodeset\MachineTool\MachineToolNodeIds;

$client = ClientBuilder::create()
    ->loadGeneratedTypes(new MachineToolRegistrar())
    ->connect('opc.tcp://192.168.1.100:4840');

$value = $client->read(MachineToolNodeIds::ProductionActiveProgramName)->getValue();

$client->disconnect();