PHP Luminova: Incoming Request User Agents Management

The UserAgent class is a utility class designed to parse and extract information from User-Agent strings. The User-Agent information are sent by web browsers and other clients to identify themselves to servers. This class makes it easy to work with User-Agent strings, allowing developers to extract useful information such as the browser name, version, operating system, and device type.

Examples

Use global function helper.

<?php 
echo  browser(null, 'instance');

Get the browser name.

<?php 
browser(null, 'instance')->getBrowser();

Get the browser user-agent from request object.

<?php 
request()->getUserAgent();
// OR
request()->agent;

Initialize user agent class.

<?php 
$ua = new UserAgent();
echo $ua->getBrowser();

Accessing protected properties.

<?php 
echo $ua->useragent;
echo $ua->browser;
echo $ua->version;
echo $ua->platform;
echo $ua->platformversion;

Class Definition

• Class namespace: \Luminova\Http\UserAgent
• This class implements: \Luminova\Interface\LazyInterface, \Stringable

Methods

constructor

Constructor

public __construct(?string $useragent = null): mixed

Sets the User Agent and runs the compilation routine.

Parameters:

getBrowser

Getter method for retrieving the browser information.

public getBrowser(): string

getUserAgent

Getter method for retrieving the user agent string.

public getUserAgent(): string

getPlatform

Getter method for retrieving the platform/operating system information.

public getPlatform(): string

getVersion

Getter method for retrieving the browser version.

public getVersion(): string

getRobot

Getter method for retrieving the robot name.

public getRobot(): string

getMobile

Getter method for retrieving the mobile device name.

public getMobile(): string

getReferrer

Getter method for retrieving the referrer hostname.

public getReferrer(): string

getPlatformVersion

Getter method for retrieving the platform/operating system version.

public getPlatformVersion(): string

toString

Get the Agent String.

public toString(): string

Return Value:

string - The Agent String.

parse

Parse the user agent string and extract browser information.This method parses the user agent string and extracts information such as browser name, version,operating system, and platform.

public static parse(string|null $userAgent = null, bool $return_array = false): array|object|false

Parameters:

Return Value:

array|object|false - Returns an array or object containing the parsed browser information.

replace

Parse and replace user agent class properties with new user agent information.

public replace(string $userAgent): void

Parameters:

isReferral

Check if the referral hostname is from another site.

public isReferral(): bool

Return Value:

bool - Return true if the referral hostname is from another site.

isRobot

Check if the user agent string is from a known robot.

public isRobot(string|null $keyword = null): bool

Parameters:

Return Value:

bool - Return true if the user agent is from known robot, false otherwise.

isMobile

Check if the user agent string represents a mobile device.

public isMobile(string|null $keyword = null): bool

Parameters:

Return Value:

bool - Return true if the user agent represents a mobile device, false otherwise.

isBrowser

Check if the user agent string belongs to a browser.

public isBrowser(string|null $name = null): bool

Parameters:

Return Value:

bool - Return true if the user agent belongs to a specific browser, or if the given name matches the browser name or user-agent, false otherwise.

isTrusted

Check if the user agent string is trusted based on allowed browsers.

public isTrusted(): bool

Return Value:

bool - Return true if the user agent matches any of the browser name / patterns in allowed browsers, false otherwise.

is

Check if keyword or patterns matched with the user agent string, browser, mobile or robot name.

public is(string $name, string|null $lookup = null): bool

Parameters:

Return Value:

bool - Return true if matched otherwise false.

Examples

Checking for a keyword in user agent string.

<?php 
if(request()->getUserAgent()->is('Mozilla')){
    echo "YES";
}

Using pattern to match only Runtime.

<?php 
if(request()->getUserAgent()->is('!(Postman)Runtime')){
    echo "YES";
}

reset

Reset user agent class properties.

protected reset(): void