Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hisorange/browser-detect
Browser Detection for Laravel by hisorange!
https://github.com/hisorange/browser-detect
bot-detection crawler-detection laravel mobile-detection user-agent user-agent-parser
Last synced: 23 days ago
JSON representation
Browser Detection for Laravel by hisorange!
- Host: GitHub
- URL: https://github.com/hisorange/browser-detect
- Owner: hisorange
- License: mit
- Created: 2013-12-06T07:38:27.000Z (almost 11 years ago)
- Default Branch: stable
- Last Pushed: 2024-02-10T11:07:43.000Z (9 months ago)
- Last Synced: 2024-05-20T11:32:13.308Z (6 months ago)
- Topics: bot-detection, crawler-detection, laravel, mobile-detection, user-agent, user-agent-parser
- Language: PHP
- Homepage: https://browser-detect.com
- Size: 928 KB
- Stars: 1,050
- Watchers: 29
- Forks: 145
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Browser Detection v5.0 by _[hisorange](https://hisorange.me)_
[](https://packagist.org/packages/hisorange/browser-detect)
[](https://github.com/hisorange/browser-detect/actions/workflows/latest.yml)
[](https://coveralls.io/github/hisorange/browser-detect)
[](https://packagist.org/packages/hisorange/browser-detect)
[](https://packagist.org/packages/hisorange/browser-detect)
Easy to use package to identify the visitor's browser details and device type.
Magic is **not** involved the results are generated by multiple well tested and developed packages.
Supports **every Laravel** version between **4.0 » 10.x**;
Also tested on **every PHP** version between **5.6 » 8.2**.
### How to install
---
```sh
composer require hisorange/browser-detect
```
Yep, it's ready to be used by You! ^.^
### How to use
---
In Your code just call the **Browser** facade:
```php
use Browser;
// Determine the user's device type is simple as this:
$isMobile = Browser::isMobile();
Browser::isTablet();
Browser::isDesktop();
if (Browser::isMobile()) {
// Redirect to the mobile version of the site.
}
// Every wondered if it is a bot who loading Your page?
if (Browser::isBot()) {
echo 'No need to wonder anymore!';
}
// Check for common vendors.
if (Browser::isFirefox() || Browser::isOpera()) {
$response .= '';
}
// Sometimes You may want to serve different content based on the OS.
if (Browser::isAndroid()) {
$response .= 'Install our Android App!';
} elseif (Browser::isMac() && Browser::isMobile()) {
$response .= 'Install our iOS App!';
}
```
Even in Your blade templates:
```blade
@mobile
This is the MOBILE template!
@include('your-mobile-template')
@endmobile
@tablet
This is the TABLET template!
@endtablet
@desktop
This is the DESKTOP template!
@enddesktop
{-- Every result key is supported --}
@browser('isBot')
Bots are identified too :)
@endbrowser
```
Easy peasy, ain't it?
### Version support
---
The following matrix has been continuously tested by the great and awesome **GitHub Actions**!
| ----- | Browser Detect 1.x | Browser Detect 2.x | Browser Detect 3.x | Browser Detect 4.x | Browser Detect 5.x |
| :----------: | :----------------: | :----------------: | :----------------: | :----------------: | :----------------: |
| Laravel 4.x | ✓ | ✓ | - | - | - |
| Laravel 5.x | - | ✓ | ✓ | - | - |
| Laravel 6.x | - | - | - | ✓ | - |
| Laravel 7.x | - | - | - | ✓ | - |
| Laravel 8.x | - | - | - | 4.4+ | - |
| Laravel 9.x | - | - | - | 4.4+ | ✓ |
| Laravel 10.x | - | - | - | - | ✓ |
| Standalone | - | - | - | 4.2+ | ✓ |
Since 2013 the package runs tests on every possible PHP / Laravel version matrix.
### Standalone mode, without Laravel!
---
Based on community requests; Now You can use the library without Laravel.
Just simply use the Parser class as a static object.
```php
use hisorange\BrowserDetect\Parser as Browser;
if (Browser::isLinux()) {
// Works as well!
}
```
### Available API calls
---
Every call on the **Browser** facade is proxied to a result object, so the following information are available on Your result too, where You can use the \[array\] syntax to access them.
| Call | Response | Internal Type |
| :-------------------------------------- | :---------------------------------------------------------------------- | :-----------: |
| Browser::userAgent() | Current visitor's HTTP_USER_AGENT string. | _(string)_ |
| Browser::isMobile() | Is this a mobile device. | _(boolean)_ |
| Browser::isTablet() | Is this a tablet device. | _(boolean)_ |
| Browser::isDesktop() | Is this a desktop computer. | _(boolean)_ |
| Browser::isBot() | Is this a crawler / bot. | _(boolean)_ |
| Browser::deviceType() | Enumerated response for [Mobile, Tablet, Desktop, and Bot] | _(string)_ |
| **Browser related functions** | | |
| Browser::browserName() | Browser's human friendly name like Firefox 3.6, Chrome 42. | _(string)_ |
| Browser::browserFamily() | Browser's vendor like Chrome, Firefox, Opera. | _(string)_ |
| Browser::browserVersion() | Browser's human friendly version string. | _(string)_ |
| Browser::browserVersionMajor() | Browser's [semantic](https://semver.org/) major version. | _(integer)_ |
| Browser::browserVersionMinor() | Browser's [semantic](https://semver.org/) minor version. | _(integer)_ |
| Browser::browserVersionPatch() | Browser's [semantic](https://semver.org/) patch version. | _(integer)_ |
| Browser::browserEngine() | Browser's engine like: Blink, WebKit, Gecko. | _(string)_ |
| **Operating system related functions** | | |
| Browser::platformName() | Operating system's human friendly name like Windows XP, Mac 10. | _(string)_ |
| Browser::platformFamily() | Operating system's vendor like Linux, Windows, Mac. | _(string)_ |
| Browser::platformVersion() | Operating system's human friendly version like XP, Vista, 10. | _(integer)_ |
| Browser::platformVersionMajor() | Operating system's [semantic](https://semver.org/) major version. | _(integer)_ |
| Browser::platformVersionMinor() | Operating system's [semantic](https://semver.org/) minor version. | _(integer)_ |
| Browser::platformVersionPatch() | Operating system's [semantic](https://semver.org/) patch version. | _(integer)_ |
| **Operating system extended functions** | | |
| Browser::isWindows() | Is this a windows operating system. | _(boolean)_ |
| Browser::isLinux() | Is this a linux based operating system. | _(boolean)_ |
| Browser::isMac() | Is this an iOS or Mac based operating system. | _(boolean)_ |
| Browser::isAndroid() | Is this an Android operating system. | _(boolean)_ |
| **Device related functions** | | |
| Browser::deviceFamily() | Device's vendor like Samsung, Apple, Huawei. | _(string)_ |
| Browser::deviceModel() | Device's brand name like iPad, iPhone, Nexus. | _(string)_ |
| **Browser vendor related functions** | | |
| Browser::isChrome() | Is this a chrome browser. | _(boolean)_ |
| Browser::isFirefox() | Is this a firefox browser. | _(boolean)_ |
| Browser::isOpera() | Is this an opera browser. | _(boolean)_ |
| Browser::isSafari() | Is this a safari browser. | _(boolean)_ |
| Browser::isIE() | Checks if the browser is an some kind of Internet Explorer (or Trident) | _(boolean)_ |
| Browser::isIEVersion() | Compares to a given IE version | _(boolean)_ |
| Browser::isEdge() | Is this a microsoft edge browser. | _(boolean)_ |
| **Miscellaneous** | | |
| Browser::isInApp() | Check for browsers rendered inside applications like android webview. | _(boolean)_ |
### Configuration, personalization
---
If You are using Laravel then after installation run the following command:
```sh
# Will copy a config file to ~/app/config/browser-detect.php
php artisan vendor:publish
```
For standalone mode to apply Your custom configuration:
```php
use hisorange\BrowserDetect\Parser;
$browser = new Parser(null, null, [
'cache' => [
'interval' => 86400 // This will override the default configuration.
]
]);
$result = $browser->detect();
```
Since the package aims to be easy to use, there is not much to configure.
But You can customize the cache and security values.
### Advanced Usage Information
---
The code is designed to be an easy to use style,
so every call You make on the **Browser** facade will access the result object and get the data for You,
but You can parse agents other than the current user's.
```php
// When You call the detect function You will get a result object, from the current user's agent.
$result = Browser::detect();
// If You wanna get browser details from a user agent other than the current user call the parse function.
$result = Browser::parse('Opera/9.80 (Windows NT 6.0) Presto/2.12.388 Version/12.14');
```
Worthy notion! The parser only parsing each user agent string once and then caches it,
it uses an in-memory runtime cache for multiple calls in a single page load;
And it will use the application's cache to persist the result for a week or so,
this should provide You with a sufficient caching mechanism so the detection will
cost less than **0.02 millisecond**, this was tested with an 80,000 fake visit.
### Changelog
---
See the detailed changes in the [CHANGELOG](CHANGELOG.md) file.