Jenssegers Agent

https://github.com/jenssegers/agent
Admin
Jenssegers Agent is a PHP desktop and mobile user agent parser with support for Laravel, based on...
Tokens:38,932
Snippets:311
Trust Score:9.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Usage Examples

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Facades-Agent.md

Usage examples showing how to call the Agent facade methods in a Laravel controller, conditional logic, and batch/CLI usage.

```APIDOC
## Agent::deviceType()

### Description
Returns the device type of the current user agent. Possible values: "desktop", "phone", "tablet", "robot", or "other".

### Method
Agent::deviceType()

### Parameters
None.

### Return Type
string - The device type.

### Example
```php
$deviceType = Agent::deviceType();
```
```

```APIDOC
## Agent::browser()

### Description
Returns the name of the browser detected from the user agent.

### Method
Agent::browser()

### Parameters
None.

### Return Type
string - The browser name, e.g., "Chrome".

### Example
```php
$browser = Agent::browser();
```
```

```APIDOC
## Agent::platform()

### Description
Returns the operating system platform detected from the user agent.

### Method
Agent::platform()

### Parameters
None.

### Return Type
string - The platform name, e.g., "OS X".

### Example
```php
$platform = Agent::platform();
```
```

```APIDOC
## Agent::languages()

### Description
Returns an array of accepted languages from the HTTP headers, ordered by preference.

### Method
Agent::languages()

### Parameters
None.

### Return Type
array - Ordered list of accepted languages.

### Example
```php
$languages = Agent::languages();
```
```

```APIDOC
## Agent::isMobile()

### Description
Checks if the current user agent is a mobile device (phone or tablet).

### Method
Agent::isMobile()

### Parameters
None.

### Return Type
bool - True if mobile, false otherwise.

### Example
```php
if (Agent::isMobile()) {
    // mobile layout
}
```
```

```APIDOC
## Agent::isRobot()

### Description
Checks if the current user agent is a robot or crawler.

### Method
Agent::isRobot()

### Parameters
None.

### Return Type
bool - True if robot, false otherwise.

### Example
```php
if (Agent::isRobot()) {
    // crawler handling
}
```
```

```APIDOC
## Agent::robot()

### Description
Returns the name of the detected robot, or false if not a robot.

### Method
Agent::robot()

### Parameters
None.

### Return Type
string|false - Robot name (e.g., "Googlebot") or false.

### Example
```php
$robot = Agent::robot();
```
```

```APIDOC
## Agent::version($browser)

### Description
Returns the version of the specified browser.

### Method
Agent::version($browser)

### Parameters
- **$browser** (string) - Required - The browser name to get the version for.

### Return Type
string - The browser version.

### Example
```php
$version = Agent::version('Opera'); // "12.14"
```
```

```APIDOC
## Agent::setUserAgent($userAgent)

### Description
Overrides the current user agent string for the facade instance.

### Method
Agent::setUserAgent($userAgent)

### Parameters
- **$userAgent** (string) - Required - The user agent string to set.

### Return Type
void

### Example
```php
Agent::setUserAgent('Opera/9.80 (Windows NT 6.0) Presto/2.12.388 Version/12.14');
```
```

```APIDOC
## Agent::setHttpHeaders($headers)

### Description
Overrides the HTTP headers used for detection.

### Method
Agent::setHttpHeaders($headers)

### Parameters
- **$headers** (array) - Required - Associative array of HTTP headers, e.g., ['HTTP_ACCEPT_LANGUAGE' => 'en-US,en;q=0.9'].

### Return Type
void

### Example
```php
Agent::setHttpHeaders(['HTTP_ACCEPT_LANGUAGE' => 'en-US,en;q=0.9']);
```
```

--------------------------------

### prepareVersionNo usage examples

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Example usage of prepareVersionNo showing normalization of underscores and truncation of version parts.

```php
var_dump($agent->prepareVersionNo('2_0')); // 2.0
var_dump($agent->prepareVersionNo('4.3.1')); // 4.31
```

--------------------------------

### Get Accept Languages

Source: https://github.com/jenssegers/agent/blob/master/README.md

Get the browser's accept languages. The example output shows an array of language codes.

```php
$languages = $agent->languages();
// ['nl-nl', 'nl', 'en-us', 'en']
```

--------------------------------

### Using getDesktopDevices() to get desktop devices

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Calls the static method and prints the result, which is ['Macintosh' => 'Macintosh'].

```php
var_dump(Agent::getDesktopDevices()); // ['Macintosh' => 'Macintosh']
```

--------------------------------

### Using getRules() with detection type switching

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Creates an Agent instance, gets mobile rules, then calls is('Macintosh') to switch to extended detection, and gets extended rules.

```php
$agent = new Agent();
$rules = $agent->getRules();      // mobile rules first
$agent->is('Macintosh');          // switches detection type to EXTENDED
$rules = $agent->getRules();      // extended rules now
```

--------------------------------

### Install jenssegers/agent via Composer

Source: https://github.com/jenssegers/agent/blob/master/README.md

Install the package via Composer.

```bash
composer require jenssegers/agent
```

--------------------------------

### Create Agent Instance

Source: https://github.com/jenssegers/agent/blob/master/README.md

Create an Agent instance to start using the library. In Laravel, you can use the Agent facade instead.

```php
use Jenssegers\Agent\Agent;

$agent = new Agent();
```

--------------------------------

### device() with current UA

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of using device() with the instance's current UA. The UA is for an iPhone and the output is 'iPhone'.

```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (iPhone; U; ru; CPU iPhone OS 4_2_1 like Mac OS X; ru) AppleWebKit/533.17.9 (KHTML, like Gecko) Version/5.0.2 Mobile/8C148a Safari/6533.18.5');
echo $agent->device(); // "iPhone"
```

--------------------------------

### Example rule-array entries

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/types.md

Abbreviated example of the rule-array shape, showing single regex values, version patterns with [VER], and an array of alternative patterns for BlackBerryOS.

```php
// Agent rules
'Windows'        => 'Windows',          // additionalOperatingSystems — regex "Windows"
'Edge'           => 'Edge|Edg',         // after merge with base mobile Edge rule
'IE'             => 'MSIE|IEMobile|MSIEMobile|Trident/[.0-9]+',
'OS X'           => 'OS X [VER]',       // additionalProperties — version pattern
'BlackBerryOS'   => ['BlackBerry[\w]+/[VER]', 'BlackBerry.*Version/[VER]', 'Version/[VER]'],
```

--------------------------------

### platform() with current UA

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of using platform() with the instance's current UA. The UA is for Mac OS X and the output is 'OS X'.

```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13+ (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2');
echo $agent->platform(); // "OS X"
```

--------------------------------

### isDesktop() with current UA

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of using isDesktop() with the instance's current UA. The UA is for a desktop Firefox browser and the output is true.

```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:24.0) Gecko/20100101 Firefox/24.0');
var_dump($agent->isDesktop()); // true
```

--------------------------------

### Instantiate Agent with custom user agent

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Example of instantiating the Agent class with a custom HTTP_USER_AGENT header. The constructor behaves identically on Agent and Mobile_Detect.

```php
use Jenssegers\Agent\Agent;

// On the Agent class the constructor behaves identically:
$agent = new Agent(['HTTP_USER_AGENT' => 'Mozilla/5.0 ...'], null);
```

--------------------------------

### browser() with current UA

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of using browser() with the instance's current UA. The UA contains Vivaldi and the output is 'Vivaldi'.

```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36 Vivaldi/1.2.490.43');
echo $agent->browser(); // "Vivaldi"
```

--------------------------------

### Get Browser and Platform Versions

Source: https://github.com/jenssegers/agent/blob/master/README.md

Get the browser or platform version using the version() method. Note: the version method is still in beta and may not return the correct result.

```php
$browser = $agent->browser();
$version = $agent->version($browser);

$platform = $agent->platform();
$version = $agent->version($platform);
```

--------------------------------

### Get Operating System Name

Source: https://github.com/jenssegers/agent/blob/master/README.md

Get the operating system name, such as Ubuntu, Windows, or OS X.

```php
$platform = $agent->platform();
```

--------------------------------

### mobileGrade usage example

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Example usage of mobileGrade, which returns a grade string like 'A' on a modern iPhone.

```php
$grade = $agent->mobileGrade(); // e.g. "A" on a modern iPhone
```

--------------------------------

### Basic Usage: Current Web Request

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Create an Agent instance for the current request using global server variables and echo the browser name. Output example includes 'Chrome'.

```php
use Jenssegers\Agent\Agent;

$agent = new Agent();                               // current web request
echo $agent->browser();                             // e.g. "Chrome"
```

--------------------------------

### Using magic is*() methods with extended rules

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of using the extended detection rules via magic is*() methods. It sets a desktop Safari user agent and verifies that isMacintosh() and isSafari() return true while isWindows() returns false.

```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13+ (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2');
var_dump($agent->isMacintosh()); // true — desktop device rule
var_dump($agent->isSafari());    // true
var_dump($agent->isWindows());   // false
```

--------------------------------

### setHttpHeaders() - Set HTTP headers for detection

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Sets the HTTP headers used for detection. Pass an array of PHP-flavored headers; keys starting with 'HTTP_' are kept. If null or empty, $_SERVER is used. The method also forwards to setCfHeaders(). The example shows setting a header and then retrieving the languages.

```php
public function setHttpHeaders($httpHeaders = null)
```

```php
$agent->setHttpHeaders(['HTTP_ACCEPT_LANGUAGE' => 'nl-NL,nl;q=0.8']);
$language = $agent->languages();
```

--------------------------------

### Use Agent facade to get device type

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/AgentServiceProvider.md

Shows usage through the facade, which resolves the 'agent' binding. The example calls Agent::deviceType() from anywhere in Laravel, such as a Blade view.

```php
use Jenssegers\Agent\Facades\Agent;

// Anywhere in Laravel, e.g. a Blade view:
$deviceType = Agent::deviceType();
```

--------------------------------

### platform() with explicit UA

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of passing an explicit UA to platform(). The UA is for Chrome OS and the output is 'ChromeOS'.

```php
echo $agent->platform('Mozilla/5.0 (X11; CrOS x86_64 6680.78.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.102 Safari/537.36'); // "ChromeOS"
```

--------------------------------

### Using getCrawlerDetect() to check crawler

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Creates an Agent instance, gets the crawler detect object, and checks if 'Googlebot/2.1' is a crawler.

```php
$agent = new Agent();
$cd = $agent->getCrawlerDetect(); // same object on every call
var_dump($cd->isCrawler('Googlebot/2.1')); // true
```

--------------------------------

### Echo script version

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Example of calling getScriptVersion() statically on Agent. Outputs the current script version, '2.8.39'.

```php
echo Agent::getScriptVersion(); // "2.8.39"
```

--------------------------------

### isDesktop() with CloudFront sentinel

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of the CloudFront special case for isDesktop(). When the UA is 'Amazon CloudFront' and the HTTP_CLOUDFRONT_IS_DESKTOP_VIEWER header is 'true', the method returns true.

```php
// CloudFront path: UA sentinel + viewer header
$agent = new Agent();
$agent->setCfHeaders(['HTTP_CLOUDFRONT_IS_DESKTOP_VIEWER' => 'true']);
$agent->setUserAgent('Amazon CloudFront');
var_dump($agent->isDesktop()); // true
```

--------------------------------

### getCfHeaders() - Get stored CloudFront headers

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Returns the stored CloudFront headers as an array, e.g., HTTP_CLOUDFRONT_IS_DESKTOP_VIEWER, HTTP_CLOUDFRONT_IS_MOBILE_VIEWER, HTTP_CLOUDFRONT_IS_TABLET_VIEWER.

```php
public function getCfHeaders()
```

--------------------------------

### Resolve Agent from container without facade

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/AgentServiceProvider.md

Shows how to resolve the Agent singleton from the container without using the facade. The instance is seeded from the current request's server variables, and the example returns browser, platform, and mobile detection results as JSON.

```php
// Laravel controller
public function index()
{
    $agent = app('agent');                      // Agent singleton, seeded from the current request
    // or: app(\Jenssegers\Agent\Agent::class);

    return response()->json([
        'browser'   => $agent->browser(),
        'platform'  => $agent->platform(),
        'is_mobile' => $agent->isMobile(),
    ]);
}
```

--------------------------------

### Set detection type to extended

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Example of setting the detection type to DETECTION_TYPE_EXTENDED. Affects which rule set getRules() returns.

```php
$agent->setDetectionType(Agent::DETECTION_TYPE_EXTENDED);
```

--------------------------------

### device() with explicit UA returning false

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of passing an explicit UA to device(). The UA does not match any device rule, so the output is false.

```php
var_dump($agent->device('Mozilla/5.0 (Windows NT 6.3; Trident/7.0; rv:11.0) like Gecko')); // false — no device rule matches
```

--------------------------------

### Agent::__call() throwing BadMethodCallException for non-is methods

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/errors.md

Shows the exact implementation of Agent::__call() that throws BadMethodCallException when a method name does not start with 'is'. The message format is 'No such method exists: <name>'. The base class Mobile_Detect::__call() throws with the identical message when substr($name, 0, 2) !== 'is'.

```php
public function __call($name, $arguments)
{
    // Make sure the name starts with 'is', otherwise
    if (strpos($name, 'is') !== 0) {
        throw new BadMethodCallException("No such method exists: $name");
    }
    ...
}
```

--------------------------------

### Catching BadMethodCallException from __call

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of catching the BadMethodCallException thrown when calling a magic method that does not start with 'is'. The exception message is 'No such method exists: invalidMethod'.

```php
try {
    $agent->invalidMethod();
} catch (\BadMethodCallException $e) {
    echo $e->getMessage(); // "No such method exists: invalidMethod"
}
```

--------------------------------

### Guarding dynamic Agent method calls to avoid BadMethodCallException

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/errors.md

Shows how to prevent the exception by guarding dynamic method calls. Only call the method if the name starts with 'is' and the method does not already exist; then __call() will perform a rule lookup and return a boolean instead of throwing.

```php
use Jenssegers\Agent\Agent;

$agent = new Agent();
// Guard before calling a dynamic method name:
$method = $userInput; // e.g. "isAndroidOS"
if (strpos($method, 'is') === 0 && method_exists($agent, $method) === false) {
    // safe: __call() will perform a rule lookup and return bool
    $result = $agent->{$method}();
}
```

--------------------------------

### Using getOperatingSystems() to check OS keys

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Calls the static method and checks for the presence of 'Ubuntu' and 'AndroidOS' keys.

```php
$oss = Agent::getOperatingSystems();
var_dump(isset($oss['Ubuntu']));    // true (additional)
var_dump(isset($oss['AndroidOS'])); // true (base list)
```

--------------------------------

### Get Robot Name

Source: https://github.com/jenssegers/agent/blob/master/README.md

Get the robot name.

```php
$robot = $agent->robot();
```

--------------------------------

### Get Browser Name

Source: https://github.com/jenssegers/agent/blob/master/README.md

Get the browser name, such as Chrome, IE, Safari, or Firefox.

```php
$browser = $agent->browser();
```

--------------------------------

### Get Device Name

Source: https://github.com/jenssegers/agent/blob/master/README.md

Get the device name if mobile, such as iPhone, Nexus, or AsusTablet.

```php
$device = $agent->device();
```

--------------------------------

### Handle false returns from browser() and version()

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/errors.md

Shows how to handle `false` returns from `browser()` and `version()` when no detection rule matches. Use this pattern to fall back to a generic value when the user agent is unknown or no version can be extracted.

```php
use Jenssegers\Agent\Agent;

$agent = new Agent();
$agent->setUserAgent('unknown-future-browser/9.9');

$browser = $agent->browser();
if ($browser === false) {
    // no known browser detected — fall back
    $browser = 'Generic';
}
$version = $agent->version($browser);
if ($version === false) {
    // no version extractable
}
```

--------------------------------

### CLI/Batch Usage with Explicit Headers and User-Agent

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Create an Agent instance with explicit headers and a User-Agent string, useful for CLI or batch processing without superglobals. Demonstrates calling platform() and version() methods.

```php
// CLI / batch: explicit headers + UA, no superglobal
$agent = new Agent(
    ['HTTP_ACCEPT_LANGUAGE' => 'nl-NL,nl;q=0.8'],
    'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:24.0) Gecko/20100101 Firefox/24.0'
);
echo $agent->platform();        // "Ubuntu"
echo $agent->version('Firefox'); // "24.0"
```

--------------------------------

### getDesktopDevices() signature

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Declares the static method getDesktopDevices() which returns the desktop devices map.

```php
public static function getDesktopDevices()
```

--------------------------------

### getUserAgent() - Get the stored User-Agent

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Returns the currently stored User-Agent string, or null if none is set.

```php
public function getUserAgent()
```

--------------------------------

### getOperatingSystems()

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Returns the array of operating system detection rules.

```APIDOC
## getOperatingSystems()

### Description
Returns the array of operating system detection rules.

### Method
`public static function getOperatingSystems()`

### Return
- **array** — `static::$operatingSystems` (AndroidOS, BlackBerryOS, PalmOS, SymbianOS, WindowsMobileOS, WindowsPhoneOS, iOS, iPadOS, SailfishOS, MeeGoOS, MaemoOS, JavaOS, webOS, badaOS, BREWOS) — overridden by `Agent`

### Throws
None
```

--------------------------------

### Comparing getPlatforms() and getOperatingSystems()

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Checks that getPlatforms() returns the same array as getOperatingSystems().

```php
var_dump(Agent::getPlatforms() === Agent::getOperatingSystems()); // true
```

--------------------------------

### Configure Agent via constructor or setters

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/configuration.md

Shows two equivalent ways to configure the Agent: passing $_SERVER and a user agent string to the constructor, or using setUserAgent() and setHttpHeaders() after instantiation. The constructor is inherited from Mobile_Detect and accepts an optional headers array and user agent string; when null, values are resolved from PHP's $_SERVER superglobal.

```php
use Jenssegers\Agent\Agent;

// Option style 1: constructor injection
$agent = new Agent($_SERVER, 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Version/9.0 Safari/601.1.56');

// Option style 2: setters (equivalent)
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Version/9.0 Safari/601.1.56');
$agent->setHttpHeaders(['HTTP_ACCEPT_LANGUAGE' => 'en-US,en;q=0.9']);
```

--------------------------------

### Using getProperties() to check property keys

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Calls the static method and checks for the presence of 'OS X' and 'Firefox' keys.

```php
$props = Agent::getProperties();
var_dump(isset($props['OS X']));    // true — additional
var_dump(isset($props['Firefox'])); // true — base
```

--------------------------------

### __construct

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Creates a new Mobile_Detect or Agent instance, optionally injecting headers and a user agent string.

```APIDOC
## __construct

### Description
Creates a new Mobile_Detect or Agent instance, optionally injecting headers and a user agent string.

### Method
Constructor

### Signature
```php
public function __construct(array $headers = null, $userAgent = null)
```

### Parameters
- **$headers** (array) - Optional - PHP `$_SERVER`-flavored headers. Empty/null → global `$_SERVER`. Only keys starting with `HTTP_` are kept.
- **$userAgent** (string) - Optional - Injected UA; null → resolved from `HTTP_USER_AGENT` (or alternate UA headers) inside the headers.

### Return Type
`Mobile_Detect` (new instance; `Agent` when called on `Agent`).

### Throws
None.

### Example
```php
use Jenssegers\Agent\Agent;

// On the Agent class the constructor behaves identically:
$agent = new Agent(['HTTP_USER_AGENT' => 'Mozilla/5.0 ...'], null);
```

### Source
`Mobile_Detect.php:888`.
```

--------------------------------

### getPlatforms() signature

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Declares the static method getPlatforms() which returns the same output as getOperatingSystems().

```php
public static function getPlatforms()
```

--------------------------------

### setHttpHeaders

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Resets stored headers; keeps only keys starting with `HTTP_` from the given array (or `$_SERVER` if null/empty). Also forwards to `setCfHeaders()`.

```APIDOC
## setHttpHeaders

### Description
Resets stored headers; keeps only keys starting with `HTTP_` from the given array (or `$_SERVER` if null/empty). Also forwards to `setCfHeaders()`.

### Method
`setHttpHeaders`

### Parameters
- `$httpHeaders` (array) - Optional - PHP-flavored headers. Empty/null → `$_SERVER`.

### Return Type
`void`

### Example
```php
$agent->setHttpHeaders(['HTTP_ACCEPT_LANGUAGE' => 'nl-NL,nl;q=0.8']);
$language = $agent->languages();
```
```

--------------------------------

### platform($userAgent = null)

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Detects the operating system platform from the user agent string. Returns the platform name or false if no match is found.

```APIDOC
## platform($userAgent = null)

### Description
Detects the operating system platform from the user agent string. Returns the platform name or false if no match is found.

### Method
platform

### Signature
public function platform($userAgent = null)

### Parameters
- `$userAgent` (string) - Optional - UA to match; null → instance's current UA.

### Return
string|bool - platform ('Windows', 'OS X', 'Ubuntu', 'AndroidOS', 'ChromeOS', …) or false.

### Throws
none

### Example
```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13+ (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2');
echo $agent->platform(); // "OS X"
```

```php
echo $agent->platform('Mozilla/5.0 (X11; CrOS x86_64 6680.78.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.102 Safari/537.36'); // "ChromeOS"
```

### Source
src/Agent.php:237.
```

--------------------------------

### getHttpHeaders() - Get stored HTTP headers

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Returns the currently stored HTTP_* headers as an array. Useful for inspecting what headers are being used for detection.

```php
public function getHttpHeaders()
```

--------------------------------

### version($propertyName, $type = self::VERSION_TYPE_STRING)

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Documentation for the version() method of the Agent class.

```APIDOC
## version($propertyName, $type = self::VERSION_TYPE_STRING)

### Description
Overrides `Mobile_Detect::version()` to consult `self::getProperties()` (base + additional patterns). The `[VER]` token in each pattern is replaced with the `self::VER` regex `([\w._\+]+)`; patterns are tried in order (array entries imploded with `|`).

### Method
`version`

### Signature
```php
public function version($propertyName, $type = self::VERSION_TYPE_STRING)
```

### Parameters
- `$propertyName` (string) - Required - Property key, e.g. the value returned by `browser()`/`platform()`; empty → `false`.
- `$type` (string) - Optional - Default: `self::VERSION_TYPE_STRING` - `VERSION_TYPE_STRING` (`'text'`) or `VERSION_TYPE_FLOAT` (`'float'`); any other value silently defaults to `VERSION_TYPE_STRING`.

### Return
`string|float|false` — the extracted version (`float` runs `prepareVersionNo()`, e.g. `'2_0'` → `2.0`, `'4.3.1'` → `4.31`); `false` for unknown/empty property or no pattern match.

### Throws
None.

### Example
```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:25.0) Gecko/20100101 Firefox/25.0');
$browser = $agent->browser();                              // "Firefox"
echo $agent->version($browser);                            // "25.0"
echo $agent->version($browser, Agent::VERSION_TYPE_FLOAT); // 25.0
```

### Failure Cases
```php
// failure cases
$agent->setUserAgent('FAKE');
var_dump($agent->version('Firefox')); // false
var_dump($agent->version(''));        // false — empty property name
```
```

--------------------------------

### Basic facade usage in Laravel controller

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Facades-Agent.md

Basic usage in a Laravel controller. Calls the facade statically to retrieve device type, browser, platform, and languages for the current request.

```php
use Jenssegers\Agent\Facades\Agent;

public function show()
{
    return view('home', [
        'deviceType' => Agent::deviceType(),   // "desktop" | "phone" | "tablet" | "robot" | "other"
        'browser'    => Agent::browser(),      // e.g. "Chrome"
        'platform'   => Agent::platform(),     // e.g. "OS X"
        'languages'  => Agent::languages(),    // ordered accept-languages
    ]);
}
```

--------------------------------

### Extract match results with getMatchesArray

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Example of using getMatchesArray() after a successful match() call. Extracts the captured name and version from the regex match.

```php
if ($agent->match('(Chrome)/([\d.]+)')) {
    list(, $name, $ver) = $agent->getMatchesArray();
}
```

--------------------------------

### Using getBrowsers() to check browser keys

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Calls the static method and checks for the presence of 'Edge' and 'Vivaldi' keys.

```php
$browsers = Agent::getBrowsers();
var_dump(isset($browsers['Edge']));    // true — "Edge|Edg" + base mobile Edge rule
var_dump(isset($browsers['Vivaldi'])); // true — additional only
```

--------------------------------

### Retrieve static device rule getters with Agent

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Shows how to call the static rule getters on the Agent class to retrieve the phone, tablet, and utility device rule arrays. These getters return plain associative rule maps and throw no exceptions.

```php
use Jenssegers\Agent\Agent;

$phones = Agent::getPhoneDevices();
$tablets = Agent::getTabletDevices();
$utilities = Agent::getUtilities();
```

--------------------------------

### setCfHeaders

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Stores CloudFront headers from the given array (or `$_SERVER` if null/empty). Keys whose lowercased form starts with `http_cloudfront_` are stored (uppercased).

```APIDOC
## setCfHeaders

### Description
Stores CloudFront headers from the given array (or `$_SERVER` if null/empty). Keys whose lowercased form starts with `http_cloudfront_` are stored (uppercased).

### Method
`setCfHeaders`

### Parameters
- `$cfHeaders` (array) - Optional - Headers array; empty/null → `$_SERVER`.

### Return Type
`bool` - `true` if at least one CloudFront header was stored.

### Example
```php
$agent->setCfHeaders(['HTTP_CLOUDFRONT_IS_MOBILE_VIEWER' => 'true']);
```
```

--------------------------------

### getDesktopDevices()

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Returns the constant map of desktop devices, which currently only includes 'Macintosh'. This is used for desktop detection.

```APIDOC
## getDesktopDevices()

### Description
Returns the constant map of desktop devices, which currently only includes 'Macintosh'. This is used for desktop detection.

### Method
GET

### Endpoint
`Agent::getDesktopDevices()`

### Parameters
None

### Request Example
```php
$devices = Agent::getDesktopDevices();
```

### Response
#### Success Response
- **array** - Desktop device map.

#### Response Example
```php
array(
  'Macintosh' => 'Macintosh',
)
```
```

--------------------------------

### getPlatforms()

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Returns the same merged operating system rules as getOperatingSystems(). This is a synonym method for convenience.

```APIDOC
## getPlatforms()

### Description
Returns the same merged operating system rules as getOperatingSystems(). This is a synonym method for convenience.

### Method
GET

### Endpoint
`Agent::getPlatforms()`

### Parameters
None

### Request Example
```php
$platforms = Agent::getPlatforms();
```

### Response
#### Success Response
- **array** - Merged operating system rules (same as getOperatingSystems()).

#### Response Example
```php
array(
  'Ubuntu' => 'Ubuntu',
  'AndroidOS' => 'Android',
  // ...
)
```
```

--------------------------------

### getUaHttpHeaders() - Get headers that may contain a User-Agent

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Returns the list of headers that may contain a User-Agent string, including HTTP_USER_AGENT, HTTP_X_OPERAMINI_PHONE_UA, HTTP_X_DEVICE_USER_AGENT, and others.

```php
public function getUaHttpHeaders()
```

--------------------------------

### getOperatingSystems()

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Returns the merged operating system detection rules, combining additional and base OS rules. This includes desktop and mobile operating systems.

```APIDOC
## getOperatingSystems()

### Description
Returns the merged operating system detection rules, combining additional and base OS rules. This includes desktop and mobile operating systems.

### Method
GET

### Endpoint
`Agent::getOperatingSystems()`

### Parameters
None

### Request Example
```php
$oss = Agent::getOperatingSystems();
```

### Response
#### Success Response
- **array** - Merged operating system rules.

#### Response Example
```php
array(
  'Ubuntu' => 'Ubuntu',
  'AndroidOS' => 'Android',
  // ...
)
```
```

--------------------------------

### getMobileHeaders() - Get headers that indicate mobile

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Returns the array of HTTP_* headers that alone can mark a request as mobile, such as HTTP_X_WAP_PROFILE, HTTP_X_OPERAMINI_PHONE_UA, and HTTP_UA_CPU with an ARM match.

```php
public function getMobileHeaders()
```

--------------------------------

### isTablet() with iPad UA

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Shows how to use isTablet() with an iPad user agent. The method matches only against the tablet device rules.

```php
$agent->setUserAgent('Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) ...');
var_dump($agent->isTablet()); // true
```

--------------------------------

### browser() with explicit UA and fallback

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Example of passing an explicit UA to browser(). Uses the null coalescing operator to fall back to 'unknown' when the browser is not found. The output is 'Firefox'.

```php
// Explicit UA + not-found handling
$agent = new Agent();
$browser = $agent->browser('Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:24.0) Gecko/20100101 Firefox/24.0');
echo $browser ?: 'unknown'; // "Firefox"
```

--------------------------------

### match() with Mac OS X UA

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Shows how to use match() with a Mac OS X UA. The first pattern matches, the second does not, but a successful match would populate getMatchesArray().

```php
$agent->setUserAgent('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) ...');
var_dump($agent->match('Mac OS X 10_6_8')); // true
var_dump($agent->match('(Chrome)/([\d.]+)')); // false — but a match would populate getMatchesArray()
```

--------------------------------

### Using getDetectionRulesExtended() to check rules

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Calls the static method and checks for the presence of 'Macintosh' and 'Chrome' keys, demonstrating that desktop devices and browsers are included.

```php
$rules = Agent::getDetectionRulesExtended();
var_dump(array_key_exists('Macintosh', $rules)); // true — desktop devices included
var_dump(array_key_exists('Chrome', $rules));    // true
```

--------------------------------

### public function __call($name, $arguments)

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Overrides Mobile_Detect::__call() to use the extended rule set for magic is*() method calls. Throws BadMethodCallException if the method name does not start with 'is'.

```APIDOC
## public function __call($name, $arguments)

### Description
Overrides `Mobile_Detect::__call()` so magic `is*()` names use the **extended** rule set (desktop devices/OS/browsers included).

### Method
`__call`

### Parameters
- `$name` (string) - Required - Called name; must start with `'is'`.
- `$arguments` (array) - Required - Passed through, unused.

### Behavior
- If `strpos($name, 'is') !== 0` → throw `BadMethodCallException("No such method exists: $name")`.
- Otherwise, set detection type to `DETECTION_TYPE_EXTENDED` and call `matchUAAgainstKey(substr($name, 2))`.

### Return
`bool` — matched or not.

### Throws
`BadMethodCallException` — method name doesn't start with `is`.

### Example
```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13+ (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2');
var_dump($agent->isMacintosh()); // true — desktop device rule
var_dump($agent->isSafari());    // true
var_dump($agent->isWindows());   // false
```

```php
try {
    $agent->invalidMethod();
} catch (\BadMethodCallException $e) {
    echo $e->getMessage(); // "No such method exists: invalidMethod"
}
```
```

--------------------------------

### is($key, $userAgent = null, $httpHeaders = null)

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Tests a rule key (e.g., 'Windows') against the user agent. Uses extended rules on Agent class.

```APIDOC
## is($key, $userAgent = null, $httpHeaders = null)

### Description
Tests a rule key (e.g., 'Windows') against the user agent. Uses extended rules on Agent class.

### Method
public function is($key, $userAgent = null, $httpHeaders = null)

### Parameters
- **$key** (string) - Required - Rule key to test, case-insensitive (e.g., 'Windows', 'Nexus').
- **$userAgent** (string) - Optional - Deprecated; UA to match.
- **$httpHeaders** (array) - Optional - Deprecated; headers to set.

### Return Type
bool

### Behavior
Sets DETECTION_TYPE_EXTENDED and delegates to protected matchUAAgainstKey(), which looks up the key in getRules() and caches the result. On Agent, getRules() returns the extended set, so desktop rules like 'Macintosh' work.

### Example
```php
$agent->setUserAgent('Mozilla/5.0 (Windows NT 6.3; Trident/7.0; rv:11.0) like Gecko');
var_dump($agent->is('Windows')); // true
var_dump($agent->is('Firefox')); // false
```
```

--------------------------------

### Agent::__call signature

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Signature of the __call magic method that overrides Mobile_Detect::__call() to use the extended rule set for is*() methods. It throws BadMethodCallException if the method name does not start with 'is'.

```php
public function __call($name, $arguments)
```

--------------------------------

### Agent::version() failure cases

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Demonstrates failure cases for version(). With a fake user agent, version('Firefox') returns false. An empty property name also returns false.

```php
// failure cases
$agent->setUserAgent('FAKE');
var_dump($agent->version('Firefox')); // false
var_dump($agent->version(''));        // false — empty property name
```

--------------------------------

### setCfHeaders() - Set CloudFront headers

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Sets CloudFront headers for detection. Accepts an array; if null or empty, $_SERVER is used. Keys whose lowercased form starts with 'http_cloudfront_' are stored uppercased. Returns true if at least one CloudFront header was stored.

```php
public function setCfHeaders($cfHeaders = null) {
```

```php
$agent->setCfHeaders(['HTTP_CLOUDFRONT_IS_MOBILE_VIEWER' => 'true']);
```

--------------------------------

### getOperatingSystems() signature

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Declares the static method getOperatingSystems() which returns merged operating system rules.

```php
public static function getOperatingSystems()
```

--------------------------------

### platform() method signature

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Signature of the platform() method. Accepts an optional user agent string; when null, the instance's current UA is used. Returns the platform name or false.

```php
public function platform($userAgent = null)
```

--------------------------------

### getHttpHeader() - Get a single HTTP header value

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Retrieves a single header value. The header name is normalized: if it contains no underscore, dashes become underscores and the name is uppercased; both the given name and 'HTTP_' prefixed version are looked up. Returns null if absent, no exception is thrown.

```php
public function getHttpHeader($header)
```

```php
$ua = $agent->getHttpHeader('User-Agent');
```

--------------------------------

### device($userAgent = null)

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Detects the device or vendor from the user agent string. Returns the device name or false if no match is found.

```APIDOC
## device($userAgent = null)

### Description
Detects the device or vendor from the user agent string. Returns the device name or false if no match is found.

### Method
device

### Signature
public function device($userAgent = null)

### Parameters
- `$userAgent` (string) - Optional - UA to match; null → instance's current UA.

### Return
string|bool - device/vendor ('Macintosh', 'iPhone', 'Nexus', 'AsusTablet', 'Bot', …) or false.

### Throws
none

### Example
```php
$agent = new Agent();
$agent->setUserAgent('Mozilla/5.0 (iPhone; U; ru; CPU iPhone OS 4_2_1 like Mac OS X; ru) AppleWebKit/533.17.9 (KHTML, like Gecko) Version/5.0.2 Mobile/8C148a Safari/6533.18.5');
echo $agent->device(); // "iPhone"
```

```php
var_dump($agent->device('Mozilla/5.0 (Windows NT 6.3; Trident/7.0; rv:11.0) like Gecko')); // false — no device rule matches
```

### Source
src/Agent.php:247.
```

--------------------------------

### prepareVersionNo method signature

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Signature of the prepareVersionNo method. It normalizes version strings and returns a float.

```php
public function prepareVersionNo($ver)
```

--------------------------------

### getUtilities()

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Returns the array of utility detection rules.

```APIDOC
## getUtilities()

### Description
Returns the array of utility detection rules.

### Method
`public static function getUtilities()`

### Return
- **array** — `static::$utilities` (Bot, MobileBot, DesktopMode, TV, WebKit, Console, Watch)

### Throws
None

### Example
```php
use Jenssegers\Agent\Agent;

$utilities = Agent::getUtilities();
```
```

--------------------------------

### is() with Windows UA

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Mobile_Detect.md

Demonstrates the is() method with a Windows UA. It returns true for the 'Windows' rule and false for 'Firefox'.

```php
$agent->setUserAgent('Mozilla/5.0 (Windows NT 6.3; Trident/7.0; rv:11.0) like Gecko');
var_dump($agent->is('Windows')); // true
var_dump($agent->is('Firefox')); // false
```

--------------------------------

### languages($acceptLanguage = null)

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/Agent.md

Documentation for the languages() method of the Agent class.

```APIDOC
## languages($acceptLanguage = null)

### Description
Parses each comma-separated piece, lowercases the tag, parses `q=` priority (default `1.0`), sorts by priority descending (`arsort`).

### Method
`languages`

### Signature
```php
public function languages($acceptLanguage = null)
```

### Parameters
- `$acceptLanguage` (string) - Optional - Default: `null` - Raw `Accept-Language` header value; null → `getHttpHeader('HTTP_ACCEPT_LANGUAGE')`.

### Return
`array` — ordered lowercase language codes; `[]` when no value.

### Throws
None.

### Example
```php
$agent = new Agent();
$agent->setHttpHeaders(['HTTP_ACCEPT_LANGUAGE' => 'nl-NL,nl;q=0.8,en-US;q=0.6,en;q=0.4']);
print_r($agent->languages()); // ['nl-nl', 'nl', 'en-us', 'en']
```

### Additional Examples
```php
print_r($agent->languages('en;q=0.4,en-US,nl;q=0.6')); // ['en-us', 'nl', 'en']
var_dump($agent->languages());                          // [] — header absent
```
```

--------------------------------

### Version return type constants VERSION_TYPE_STRING and VERSION_TYPE_FLOAT

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/types.md

Constants for the `$type` parameter of `version()`. `VERSION_TYPE_STRING` is the default and returns the raw captured version string; `VERSION_TYPE_FLOAT` additionally runs `prepareVersionNo()` on the capture. Any other value silently falls back to `VERSION_TYPE_STRING`.

```php
const VERSION_TYPE_STRING       = 'text';
const VERSION_TYPE_FLOAT        = 'float';
```

--------------------------------

### Register provider in config/app.php

Source: https://github.com/jenssegers/agent/blob/master/_autodocs/api-reference/AgentServiceProvider.md

Registers the provider in config/app.php under the 'providers' array.

```php
'providers' => [
    // ...
    Jenssegers\Agent\AgentServiceProvider::class,
],
```
Tokens:
Raw