AcsiomaticDeviceDetectorBundle

The AcsiomaticDeviceDetectorBundle provides integration of the DeviceDetector library into the Symfony framework.

DeviceDetector is a Universal Device Detection library that parses User Agents and Browser Client Hints to detect devices (desktop, tablet, mobile, tv, cars, console, etc.), clients (browsers, feed readers, media players, PIMs, ...), operating systems, brands and models.

From https://github.com/matomo-org/device-detector

This bundle provides the DeviceDetector class as a service, and a Twig global variable.

Installation
Configuration
Usage in controllers
Usage in Twig

Installation

This bundle is compatible with Symfony from 3.4 to 6.x, and DeviceDetector from 4.0 to 6.x.

You can install the bundle using Symfony Flex:

composer require acsiomatic/device-detector-bundle

Configuration

You can configure the bundle using the acsiomatic_device_detector configuration section:

# config/packages/acsiomatic_device_detector.yaml

acsiomatic_device_detector:

    cache:

        # If null, it will disable caching
        pool: 'cache.app'

    bot:

        # If true getBot() will only return true if a bot was detected (speeds up detection a bit)
        discard_information: false

        # If true, bot detection will completely be skipped (bots will be detected as regular devices then)
        skip_detection: false

    twig:

        # If null, it will not assign Twig variable
        variable_name: 'device'

    # If true, DeviceDetector will trigger parser() when necessary
    auto_parse: true

    # Version truncation behavior, it may assume: major, minor, patch, build, or none
    # By default minor versions will be returned (e.g. X.Y)
    version_truncation: 'minor'

    routing:

        # If null, it will not tag DeviceDetector as routing condition service
        condition_service_alias: 'device'

Usage in controllers

You can inject DeviceDetector as a service. This bundle sets up this class according to the configurations under the acsiomatic_device_detector section in order to provide information about the current request.

use DeviceDetector\DeviceDetector;

class MyController
{
    public function index(DeviceDetector $device)
    {
        if ($device->isSmartphone()) {
            // ...
        }
    }
}

Note that you need to call $device->parse() before asking for device's information if auto_parse configuration is false.

Usage in Twig

The DeviceDetector service is assigned to the Twig templates as device variable.

{% if device.isSmartphone %}
    {# ... #}
{% endif %}

Usage in route condition

The DeviceDetector is tagged as routing condition service.

use DeviceDetector\DeviceDetector;

class MyController
{
    #[Route('/page', condition: "service('device').isSmartphone()")]
    public function index()
    {
        // this endpoint is available only for smartphone devices
    }
}

Parsing custom request

You might want to parse other request than the current one. This bundle provides a service that implements DeviceDetectorFactoryInterface. This service provides a method that creates fresh DeviceDetector instances according to the configurations under the acsiomatic_device_detector section, but it doesn't attach them to any request.

use Acsiomatic\DeviceDetectorBundle\Contracts\DeviceDetectorFactoryInterface;

class SmartphoneDeterminer
{
    /**
     * @var DeviceDetectorFactoryInterface
     */
    private $deviceDetectorFactory;

    public function __construct(DeviceDetectorFactoryInterface $factory)
    {
        $this->deviceDetectorFactory = $factory;
    }

    public function isSmartphone(string $userAgent): bool
    {
        $deviceDetector = $this->deviceDetectorFactory->createDeviceDetector();
        $deviceDetector->setUserAgent($userAgent);

        return $deviceDetector->isSmartphone();
    }
}

Custom parsers

You can inject custom parsers to the DeviceDetector instance by providing them as services.

If autoconfigure is enabled, they will be injected automatically. Otherwise, you need to add the corresponding tag to each custom parsers:

acsiomatic.device_detector.bot_parser
acsiomatic.device_detector.client_parser
acsiomatic.device_detector.device_parser

koekaverna / device-detector-bundle