PHP Opc Ua
Menu
Home Documentation About
Sign in
laravel-opcua · master
Docs · Configuration

Publishing and overriding

How to publish the config, what to commit, when to override at runtime, and how the package resolves config across cache and tests.

Publishing the config

The OpcuaServiceProvider registers config/opcua.php as a publishable resource tagged opcua-config:

bash terminal 
php artisan vendor:publish --tag=opcua-config

That copies the package's config/opcua.php into your application's config/ directory. After publishing:

  • Your config/opcua.php wins over the package default. The package's file becomes irrelevant.
  • Re-running vendor:publish with --force overwrites your copy (warning — destructive).
  • The published file is plain PHP — version-control it, keep env() calls in it, treat it as application code.

What to commit

  • ✅ config/opcua.php — published config file, intentional.
  • ✅ config/logging.php additions (the opcua channel).
  • ❌ .env — never. Use .env.example for the keys.
  • ❌ Resolved certificate paths pointing at local-only filesystem locations — use env() so each environment can resolve them differently.

Overriding at runtime

Three common reasons to override config at runtime:

1 — Per-tenant, per-request

If a multi-tenant app needs a different endpoint per tenant, define all tenants statically in config/opcua.php and resolve by name per request:

php app/Http/Middleware/SetOpcuaConnection.php 
public function handle(Request $request, Closure $next): Response
{
    $tenant = $request->user()->tenant_id;
    $request->merge(['opcua_connection' => "plc-tenant-{$tenant}"]);

    return $next($request);
}

…then in the controller:

php controller 
public function read(Request $request): JsonResponse
{
    $dv = Opcua::connection($request->input('opcua_connection'))
        ->read('ns=2;s=Speed');

    return response()->json(['value' => $dv->getValue()]);
}

No config mutation — just connection switching.

2 — Dynamic endpoint per call

If the endpoint is fundamentally dynamic (a fleet of identical PLCs reachable by serial number), use connectTo():

php ad-hoc connection 
$dv = Opcua::connectTo([
    'endpoint'        => "opc.tcp://plc-{$serial}.factory.local:4840",
    'security_policy' => 'Basic256Sha256',
    'security_mode'   => 'SignAndEncrypt',
    'username'        => config('opcua.connections.default.username'),
    'password'        => config('opcua.connections.default.password'),
])->read('ns=2;s=Speed');

connectTo() accepts the same array shape as a connections.* entry. See Using the client · Ad-hoc connections.

3 — Test-time overrides

In tests, use Laravel's Config::set():

php tests/Feature/OpcuaTest.php 
beforeEach(function () {
    Config::set('opcua.connections.default.endpoint', 'opc.tcp://127.0.0.1:14840');
    Config::set('opcua.session_manager.enabled', false);
});

For deeper test patterns see Testing · Pest setup and Mocking the facade.

Resolution order

The package reads config in this order, last-write-wins:

  1. Package defaults — vendor/.../config/opcua.php if not published.
  2. Application config — config/opcua.php if published.
  3. Environment — env() calls inside config/opcua.php resolve to .env values at boot.
  4. Cached config — bootstrap/cache/config.php if config:cache was run. Frozen until cleared.
  5. Runtime mutations — Config::set(), only in-process.

Config::set() does not persist across requests or workers unless wrapped in middleware/bootstrap. It is suitable for tests and per-request context, not for "remember this for next time".

Octane / FrankenPHP / Vapor implications

Long-running PHP processes (Octane, FrankenPHP, RoadRunner) read config once at boot. Config::set() lasts for the lifetime of the worker, which crosses request boundaries:

Note

Don't mutate global config from a request handler under Octane. The mutation will leak into the next request handled by the same worker. Use Opcua::connection() / Opcua::connectTo() instead — those are stateless and request-scoped.

See Integrations · Octane and FrankenPHP.

Forcing a config reload

If something feels wrong:

bash terminal — config reset 
php artisan config:clear     # remove the cached config
php artisan config:cache     # rebuild from the current state of .env + config/

For Octane:

bash terminal — octane reset 
php artisan octane:reload    # restart workers, picks up new config

What vendor:publish does not publish

  • Routes — the package ships none.
  • Migrations — the package ships none. If you need a plc_readings table, it's yours to design.
  • Views — none. There are no UI components.
  • Translations — none. Error messages are not localised.

The package's surface is a service, not a feature module. What you build on top is yours.

Removing the package

composer remove php-opcua/laravel-opcua. Optionally delete config/opcua.php afterwards — Laravel ignores it, but it makes the intent clear.

If you set up the opcua log channel, dedicated cache store, or custom artisan commands, those stay until you remove them — the package doesn't track what you wired around it.

You've finished Configuration. The next group, Using the client, goes through the four idiomatic ways to call OPC UA from Laravel code.

Last updated · 2026-05-25
Edit on GitHub Report issue

← Previous

Session manager

Next →

Facade vs injection

Documentation