Examples / How To
Modify User-Agent In Request Headers

4min
Introduction
The UserAgentProvider is responsible for collating and returning all configured components separated by a space character. This class is a composite provider, that can be configured via DI to inject additional providers into the constructor which are included in the User-Agent header value used in API calls.
There should be no need to replace this class with your own implementation, and doing so may break other packages which inject their own providers. Instead, create additional class(es) implementing the UserAgentProviderInterface which return the user agent information (either new components or additional information for an existing component, where supported).
Inject Additional Components
First, create a new class which implements Provider\UserAgentProviderInterface and add the execute method, returning the desired string.
If you wish to allow other modules to inject their own system information into your component, you can should implement the Provider\ComposableUserAgentProviderInterface interface, which extends the base interface.
You can also use theProvider\ComposableUserAgentProviderTrait to include implementation of child providers.
﻿
Basic
Composable
<?php

declare(strict_types=1);

namespace Acme\MyModule\Provider\UserAgent;

use Klevu\PhpSDK\Provider\UserAgentProviderInterface;

class PhpSDKUserAgentProvider implements UserAgentProviderInterface
{
    /**
     * @return string
     */
    public function execute(): string
    {
        return 'MyModule/1.0.0';
    }
}

<?php

declare(strict_types=1);

namespace Acme\MyModule\Provider\UserAgent;

use Klevu\PhpSDK\Provider\UserAgentProviderInterface;

class PhpSDKUserAgentProvider implements UserAgentProviderInterface
{
    /**
     * @return string
     */
    public function execute(): string
    {
        return 'MyModule/1.0.0';
    }
}
﻿
Once you have your user agent provider, create a new instance of UserAgentProvider and inject it into the constructor. 
Note: If you are integrating into a modern framework, you should implement this via your dependency injection system
This User Agent Provider instance can then be passed into any service which interacts with Klevu's APIs
PHP
<?php

declare(strict_types=1);

use Acme\MyModule\Provider\UserAgent\MyUserAgentProvider;
use Klevu\PhpSDK\Provider\UserAgentProvider;
use Klevu\PhpSDK\Service\Account\AccountFeaturesService;
use Klevu\PhpSDK\Service\Account\AccountLookupService;
use Klevu\PhpSDK\Service\Account\UpdateStoreFeedUrlService;
use Klevu\PhpSDK\Service\Analytics\CollectService as AnalyticsCollectService;
use Klevu\PhpSDK\Service\Indexing\AttributesService;
use Klevu\PhpSDK\Service\Indexing\Batch\DeleteService as BatchDeleteService;
use Klevu\PhpSDK\Service\Indexing\BatchService;

$userAgentProvider = new UserAgentProvider(
    userAgentProviders: [
        new MyUserAgentProvider(),
    ],
);

// Or, if using the composable templates

$userAgentProvider = new UserAgentProvider(
    userAgentProviders: [
        new MyUserAgentProvider(
            systemInformationProviders: [
                new MySystemInformationProvider(),
            ],
        ),
    ],
);

// Account
$accountFeatureService = new AccountFeaturesService(
    userAgentProvider: $userAgentProvider,
);
$accountLookupService = new AccountLookupService(
    userAgentProvider: $userAgentProvider,
);
$updateStoreFeedUrlService = new UpdateStoreFeedUrlService(
    userAgentProvider: $userAgentProvider,
);

// Analytics
$collectService = new AnalyticsCollectService(
    userAgentProvider: $userAgentProvider,
);

// Indexing
$attributesService = new AttributesService(
    userAgentProvider: $userAgentProvider,
);
$batchService = new BatchService(
    userAgentProvider: $userAgentProvider,
);
$batchDeleteService = new BatchDeleteService(
    userAgentProvider: $userAgentProvider,
);
<?php

declare(strict_types=1);

use Acme\MyModule\Provider\UserAgent\MyUserAgentProvider;
use Klevu\PhpSDK\Provider\UserAgentProvider;
use Klevu\PhpSDK\Service\Account\AccountFeaturesService;
use Klevu\PhpSDK\Service\Account\AccountLookupService;
use Klevu\PhpSDK\Service\Account\UpdateStoreFeedUrlService;
use Klevu\PhpSDK\Service\Analytics\CollectService as AnalyticsCollectService;
use Klevu\PhpSDK\Service\Indexing\AttributesService;
use Klevu\PhpSDK\Service\Indexing\Batch\DeleteService as BatchDeleteService;
use Klevu\PhpSDK\Service\Indexing\BatchService;

$userAgentProvider = new UserAgentProvider(
    userAgentProviders: [
        new MyUserAgentProvider(),
    ],
);

// Or, if using the composable templates

$userAgentProvider = new UserAgentProvider(
    userAgentProviders: [
        new MyUserAgentProvider(
            systemInformationProviders: [
                new MySystemInformationProvider(),
            ],
        ),
    ],
);

// Account
$accountFeatureService = new AccountFeaturesService(
    userAgentProvider: $userAgentProvider,
);
$accountLookupService = new AccountLookupService(
    userAgentProvider: $userAgentProvider,
);
$updateStoreFeedUrlService = new UpdateStoreFeedUrlService(
    userAgentProvider: $userAgentProvider,
);

// Analytics
$collectService = new AnalyticsCollectService(
    userAgentProvider: $userAgentProvider,
);

// Indexing
$attributesService = new AttributesService(
    userAgentProvider: $userAgentProvider,
);
$batchService = new BatchService(
    userAgentProvider: $userAgentProvider,
);
$batchDeleteService = new BatchDeleteService(
    userAgentProvider: $userAgentProvider,
);
﻿
In the above scenario, the expected user agent string result would look like
klevu-php-sdk/0.0.0.1 (PHP 8.1.999) MyModule/1.0.0
or, if composble
klevu-php-sdk/0.0.0.1 (PHP 8.1.999) MyModule/1.0.0 (MySystem)
﻿
Source Code Reference
Provider\ComposableUserAgentProviderInterface﻿
Provider\ComposableUserAgentProviderTrait﻿
Provider\UserAgentProvider﻿
Provider\UserAgentProviderInterface﻿
﻿
Updated 23 Sep 2024
Did this page help you?
Delete Records from Index
Logging