xref: /plugin/statistics/vendor/matomo/device-detector/Parser/Device/HbbTv.php (revision d5ef99ddb7dfb0cfae33e9257bd1d788f682c50f)
1*d5ef99ddSAndreas Gohr<?php
2*d5ef99ddSAndreas Gohr
3*d5ef99ddSAndreas Gohr/**
4*d5ef99ddSAndreas Gohr * Device Detector - The Universal Device Detection library for parsing User Agents
5*d5ef99ddSAndreas Gohr *
6*d5ef99ddSAndreas Gohr * @link https://matomo.org
7*d5ef99ddSAndreas Gohr *
8*d5ef99ddSAndreas Gohr * @license http://www.gnu.org/licenses/lgpl.html LGPL v3 or later
9*d5ef99ddSAndreas Gohr */
10*d5ef99ddSAndreas Gohr
11*d5ef99ddSAndreas Gohrdeclare(strict_types=1);
12*d5ef99ddSAndreas Gohr
13*d5ef99ddSAndreas Gohrnamespace DeviceDetector\Parser\Device;
14*d5ef99ddSAndreas Gohr
15*d5ef99ddSAndreas Gohr/**
16*d5ef99ddSAndreas Gohr * Class HbbTv
17*d5ef99ddSAndreas Gohr *
18*d5ef99ddSAndreas Gohr * Device parser for hbbtv detection
19*d5ef99ddSAndreas Gohr */
20*d5ef99ddSAndreas Gohrclass HbbTv extends AbstractDeviceParser
21*d5ef99ddSAndreas Gohr{
22*d5ef99ddSAndreas Gohr    /**
23*d5ef99ddSAndreas Gohr     * @var string
24*d5ef99ddSAndreas Gohr     */
25*d5ef99ddSAndreas Gohr    protected $fixtureFile = 'regexes/device/televisions.yml';
26*d5ef99ddSAndreas Gohr
27*d5ef99ddSAndreas Gohr    /**
28*d5ef99ddSAndreas Gohr     * @var string
29*d5ef99ddSAndreas Gohr     */
30*d5ef99ddSAndreas Gohr    protected $parserName = 'tv';
31*d5ef99ddSAndreas Gohr
32*d5ef99ddSAndreas Gohr    /**
33*d5ef99ddSAndreas Gohr     * Parses the current UA and checks whether it contains HbbTv or SmartTvA information
34*d5ef99ddSAndreas Gohr     *
35*d5ef99ddSAndreas Gohr     * @see televisions.yml for list of detected televisions
36*d5ef99ddSAndreas Gohr     *
37*d5ef99ddSAndreas Gohr     * @return array|null
38*d5ef99ddSAndreas Gohr     */
39*d5ef99ddSAndreas Gohr    public function parse(): ?array
40*d5ef99ddSAndreas Gohr    {
41*d5ef99ddSAndreas Gohr        // only parse user agents containing fragments: hbbtv or SmartTvA
42*d5ef99ddSAndreas Gohr        if (null === $this->isHbbTv()) {
43*d5ef99ddSAndreas Gohr            return null;
44*d5ef99ddSAndreas Gohr        }
45*d5ef99ddSAndreas Gohr
46*d5ef99ddSAndreas Gohr        parent::parse();
47*d5ef99ddSAndreas Gohr
48*d5ef99ddSAndreas Gohr        // always set device type to tv, even if no model/brand could be found
49*d5ef99ddSAndreas Gohr        if (null === $this->deviceType) {
50*d5ef99ddSAndreas Gohr            $this->deviceType = self::DEVICE_TYPE_TV;
51*d5ef99ddSAndreas Gohr        }
52*d5ef99ddSAndreas Gohr
53*d5ef99ddSAndreas Gohr        return $this->getResult();
54*d5ef99ddSAndreas Gohr    }
55*d5ef99ddSAndreas Gohr
56*d5ef99ddSAndreas Gohr    /**
57*d5ef99ddSAndreas Gohr     * Returns if the parsed UA was identified as a HbbTV device
58*d5ef99ddSAndreas Gohr     *
59*d5ef99ddSAndreas Gohr     * @return string|null
60*d5ef99ddSAndreas Gohr     */
61*d5ef99ddSAndreas Gohr    public function isHbbTv(): ?string
62*d5ef99ddSAndreas Gohr    {
63*d5ef99ddSAndreas Gohr        $regex = '(?:HbbTV|SmartTvA)/([1-9]{1}(?:\.[0-9]{1}){1,2})';
64*d5ef99ddSAndreas Gohr        $match = $this->matchUserAgent($regex);
65*d5ef99ddSAndreas Gohr
66*d5ef99ddSAndreas Gohr        return $match[1] ?? null;
67*d5ef99ddSAndreas Gohr    }
68*d5ef99ddSAndreas Gohr}
69