acsiomatic / device-detector-bundle
Symfony Bundle for https://github.com/matomo-org/device-detector
Installs: 54 813
Dependents: 1
Suggesters: 0
Security: 0
Stars: 11
Watchers: 3
Forks: 1
Open Issues: 6
Type:symfony-bundle
Requires
- php: ^8.1
- friendsofphp/proxy-manager-lts: ^1.0
- matomo/device-detector: ^6.2
- symfony/framework-bundle: ^5.4 || ^6.4 || ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.49
- phpstan/phpstan: ^1.10
- phpstan/phpstan-phpunit: ^1.3
- phpstan/phpstan-strict-rules: ^1.5
- phpunit/phpunit: ^10.4
- rector/rector: ^1.0
- symfony/twig-bundle: ^5.4 || ^6.4 || ^7.0
README
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.
This bundle provides the DeviceDetector
class as service, and Twig global variable.
Installation
You can install the bundle using Composer:
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: # 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' 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' routing: # If null, it will not tag DeviceDetector as routing condition service condition_service_alias: 'device'
Usage
Usage in controllers
You can inject DeviceDetector
as a service.
This bundle sets up an instance of this class according to the configurations under the acsiomatic_device_detector
section in order to provide information about the main request.
use DeviceDetector\DeviceDetector; use Symfony\Component\HttpFoundation\Response; class MyController { public function index(DeviceDetector $device): Response { if ($device->isSmartphone()) { // ... } } }
Note
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 Symfony\Component\HttpFoundation\Response; class MyController { #[Route('/page', condition: "service('device').isSmartphone()")] public function index(): Response { // 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 methods that create fresh DeviceDetector
instances according to the configurations under the acsiomatic_device_detector
section, but it doesn't attach them to any request.
Custom parsers
You can inject custom parsers into DeviceDetector
by providing them as services.
If autoconfigure is enabled, the bundle injects custom parsers. 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
Release Policy
There is a single maintained branch per time. This branch targets a minor version.
A maintained version reaches its end-of-life when a new minor version is released.
Dependencies Compatibility Policy
This library is compatible with maintained versions of PHP, Device Detector, and Symfony.