summaryrefslogtreecommitdiffstats
path: root/vendor/mobiledetect/mobiledetectlib/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--vendor/mobiledetect/mobiledetectlib/README.md321
1 files changed, 321 insertions, 0 deletions
diff --git a/vendor/mobiledetect/mobiledetectlib/README.md b/vendor/mobiledetect/mobiledetectlib/README.md
new file mode 100644
index 0000000..698c024
--- /dev/null
+++ b/vendor/mobiledetect/mobiledetectlib/README.md
@@ -0,0 +1,321 @@
+![Mobile Detect](http://demo.mobiledetect.net/logo-github.png)
+
+# MobileDetect, PHP mobile detection class
+
+![Workflow status](https://img.shields.io/github/actions/workflow/status/serbanghita/Mobile-Detect/3.74.x-test.yml?style=flat-square)
+![Latest tag](https://img.shields.io/github/v/tag/serbanghita/Mobile-Detect?filter=3.*&style=flat-square)
+![Monthly Downloads](https://img.shields.io/packagist/dm/mobiledetect/mobiledetectlib?style=flat-square&label=installs)
+![Total Downloads](https://img.shields.io/packagist/dt/mobiledetect/mobiledetectlib?style=flat-square&label=installs)
+![MIT License](https://img.shields.io/packagist/l/mobiledetect/mobiledetectlib?style=flat-square)
+
+Mobile Detect is a lightweight PHP class for detecting mobile devices (including tablets).
+It uses the User-Agent string combined with specific HTTP headers to detect the mobile environment.
+
+- MobileDetect class is a
+[server-side detection](http://www.w3.org/TR/mwabp/#bp-devcap-detection) PHP class that can help you with your RWD strategy,
+it is not a replacement for CSS3 media queries or other forms of client-side feature detection.
+- Can detect the difference between a mobile phone and a table by using regexes.
+- The accuracy and relevance of the detection is kept by running [tests](./tests) to check for detection conflicts.
+
+```php
+$detect = new \Detection\MobileDetect;
+$deviceType = ($detect->isMobile() ? ($detect->isTablet() ? 'tablet' : 'phone') : 'computer');
+```
+## Installing
+
+### Download and include manually
+
+You need PHP >= `7.4`.
+
+- [Download the latest release](../../tags)
+- Get the PHP class [MobileDetect.php](src/MobileDetect.php) and include it in your PHP source.
+
+### Composer
+
+- Install via [composer](https://packagist.org/packages/mobiledetect/mobiledetectlib).
+`composer require mobiledetect/mobiledetectlib:3.74`
+- Include the dependency in the `composer.json` file:
+ ```json
+ {
+ "require": {
+ "mobiledetect/mobiledetectlib": "^3.74"
+ }
+ }
+ ```
+
+## Contribute
+
+- Go to * [:iphone: Live demo](https://demo.mobiledetect.net)
+- Read [how to contribute](docs/CONTRIBUTING.md) guide.
+- Submit a pull request.
+
+*Donate*
+
+|Paypal|
+|------|
+|[Donate :+1:](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=mobiledetectlib%40gmail%2ecom&lc=US&item_name=Mobile%20Detect&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted)|
+
+
+I'm currently paying for hosting and spend a lot of my family time to maintain the project and planning the future releases.
+I would highly appreciate any money donations that will keep the research going.
+
+Special thanks to the community :+1: for donations, JetBrains team for the continuous support and [Dragos Gavrila](https://twitter.com/grafician) who contributed with the logo.
+
+## Modules, plugins, ports
+
+[Submit new module, plugin, port](../../issues/new?title=New%203rd%20party%20module&body=Name,%20Link%20and%20Description%20of%20the%20module.)
+
+**JavaScript**
+
+* mobile-detect.js - A [JavaScript port](https://github.com/hgoebl/mobile-detect.js) of Mobile-Detect class. Made by [Heinrich Goebl](https://github.com/hgoebl).
+
+**Varnish Cache**
+
+* [Varnish Mobile Detect](https://github.com/willemk/varnish-mobiletranslate) - Drop-in varnish solution to mobile user
+detection based on the Mobile-Detect library. Made by [willemk](https://github.com/willemk).
+* [mobiledetect2vcl](https://github.com/carlosabalde/mobiledetect2vcl) - Python script to transform the Mobile
+Detect JSON database into an UA-based mobile detection VCL subroutine easily integrable in any Varnish Cache
+configuration. Made by [Carlos Abalde](https://github.com/carlosabalde).
+
+**LUA**
+
+* [mobile-detect.lua](https://github.com/yourpalmark/mobile-detect.lua) is a port of Mobile-Detect to Lua for
+NGINX HTTP servers. Follows closely to mobile-detect.js. Supports all methods that server-side
+mobile-detect.js supports. Fully unit-tested and synced with Travis CI (Build Passing badge included).
+Made by [Mark Walters](https://github.com/yourpalmark).
+
+**PHP**
+
+**WordPress**
+
+* [Mobile Detect for WordPress](https://wordpress.org/plugins/tinywp-mobile-detect/) - WordPress has a built-in function
+(`wp_is_mobile()`) to detect mobile devices. There is (at least) one catch, though. It considers iPad (iPad pro,
+and any tablet) as a mobile. So, this 3rd party module changes the way `wp_is_mobile()` works with the help of
+Mobile Detect PHP library!
+Made by [Pothi Kalimuthu](https://github.com/pothi)
+
+* [WordPress Mobile Detect](https://wordpress.org/plugins/wp-mobile-detect/) - Gives you the ability to wrap that
+infographic in a `[notdevice][/notdevice]` shortcode so at the server level WordPress will
+decide to show that content only if the user is NOT on a phone or tablet.
+Made by [Jesse Friedman](https://profiles.wordpress.org/professor44/).
+
+* [mobble](https://wordpress.org/plugins/mobble/) - provides mobile related conditional functions for your site.
+e.g. `is_iphone()`, `is_mobile()` and `is_tablet()`. Made by Scott Evans.
+
+* [WordPress Responsage](https://github.com/iamspacehead/responsage) - A small WordPress theme plugin that allows
+you to make your images responsive. Made by [Adrian Ciaschetti](https://github.com/iamspacehead).
+
+* [WP247 Body Classes](https://wordpress.org/plugins/wp247-body-classes/) - Add unique classes to the `body` tag for
+easy styling based on various attributes (archive, user, post, mobile) and various WordPress "is" functions.
+Mobile attributes include type of device, Operating System, Browser, etc. Examples: .is-mobile, .is-not-mobile,
+.is-tablet, .is-ios, .is-not-ios, .is-androidos, .is-chromebrowser.
+Made by [wescleveland56](https://github.com/wescleveland56).
+
+* [Adaptive Content](https://wordpress.org/plugins/addfunc-adaptive-content/) for WordPress provides the most
+intuitive set of shortcodes for including/excluding content on mobile devices, tablets desktops and other
+more specific device parameters. This lightweight plugin lets content writers and theme authors choose when
+WordPress should or shouldn’t show any give content item using shortcodes and quicktags or theme elements using functions.
+Made by [AddFunc](https://profiles.wordpress.org/addfunc).
+
+* [AddFunc Mobile Detect](https://wordpress.org/plugins/addfunc-mobile-detect/) for WordPress redirects
+mobile traffic to your mobile website and, basically, gives you loads of control over your mobile redirects.
+Made by [AddFunc](https://profiles.wordpress.org/addfunc).
+
+**Drupal**
+
+* [Drupal Mobile Switch](https://www.drupal.org/project/mobile_switch) - The Mobile Switch Drupal module provides a
+automatic theme switch functionality for mobile devices, detected by Browscap or Mobile Detect.
+Made by [Siegfried Neumann](https://www.drupal.org/user/45267).
+
+* [Drupal Context Mobile Detect](https://www.drupal.org/project/context_mobile_detect) - This is a Drupal context module
+which integrates Context and PHP Mobile Detect library.
+Created by [Artem Shymko](https://www.drupal.org/user/432492).
+
+* [Drupal Mobile Detect](https://www.drupal.org/project/mobile_detect) - Lightweight mobile detect module for Drupal
+ created by [Matthew Donadio](https://www.drupal.org/user/325244).
+
+**Joomla**
+
+* [yagendoo Joomla! Mobile Detection Plugin](http://www.yagendoo.com/en/blog/free-mobile-detection-plugin-for-joomla.html) - Lightweight PHP plugin for Joomla!
+that detects a mobile browser using the Mobile Detect class.
+Made by yagendoo media.
+
+* [User Agent Detector plugin](https://github.com/renekreijveld/UserAgentDetector) - This system plugin detects the user
+agent of your website visitor and sets a session variable accordingly. Based on the user agent, the plugin detects if the
+site is running on a desktop pc, tablet or smartphone. It can also detect if the visitor is a spider bot (search engine).
+Session variable that is set: `ualayout`. Possible values: desktop, tablet, mobile, bot.
+Made by @ReneKreijveld.
+
+**Magento**
+
+* [Magento helper](http://www.magentocommerce.com/magento-connect/catalog/product/view/id/16835/) from Optimise Web enables
+the use of all functions provided by Mobile Detect. Made by [Kathir Vel](http://www.kathirvel.com).
+
+* [Magento 2 Mobile Detect Theme Change](https://github.com/EaDesgin/magento2-mobiledetect) is an extension for Magento 2
+that will change the theme or redirect to a different URL. Also containing a helper to check for the device type.
+
+**PrestaShop**
+
+* [PrestaShop](https://www.prestashop.com) is a free, secure and open source shopping cart platform. Mobile_Detect
+is included in the default package since 1.5.x.
+
+**Laravel**
+
+* [Agent](https://github.com/jenssegers/agent) is a user agent class for Laravel based on Mobile Detect with some
+additional functionality.
+Made by [Jens Segers](https://github.com/jenssegers).
+
+* [Laravel Mobile Detect](https://github.com/riverskies/laravel-mobile-detect) is a package that enables you to use device detection right in your Laravel Blade templates. (Utilises the well-known, constantly updated PHP mobile detection library.)
+Made by [Barnabas Kecskes](https://github.com/barnabaskecskes).
+
+* [BrowserDetect](https://github.com/hisorange/browser-detect) is a browser and mobile detection package, collects
+and wrap together the best user-agent identifiers for Laravel.
+Created by [Varga Zsolt](https://github.com/hisorange).
+
+**Zend Framework**
+
+* [ZF2 Mobile-Detect](https://github.com/neilime/zf2-mobile-detect.git) is a Zend Framework 2 module that provides
+Mobile-Detect features (Mobile_Detect class as a service, helper for views and plugin controllers).
+Made by [neilime](https://github.com/neilime).
+
+* [ZF2 MobileDetectModule](https://github.com/nikolaposa/MobileDetectModule) facilitates integration of a PHP MobileDetect
+class with some ZF2-based application. Has similar idea like the existing ZF2 Mobile-Detect module,
+but differs in initialization and provision routine of the actual Mobile_Detect class.
+Appropriate view helper and controller plugin also have different conceptions.
+Made by [Nikola Posa](https://github.com/nikolaposa).
+
+**Symfony**
+
+* [Symfony3 MobileDetectBundle](https://github.com/tattali/MobileDetectBundle) is a Symfony bundle to detect mobile devices, manage mobile view and redirect to the mobile and tablet version. Made by [Théo Attali](https://github.com/tattali).
+
+* [Symfony2 Mobile Detect Bundle](https://github.com/suncat2000/MobileDetectBundle) is a bundle for detecting mobile devices,
+manage mobile view and redirect to the mobile and tablet version.
+Made by [Nikolay Ivlev](https://github.com/suncat2000).
+
+* [Silex Mobile Detect Service Provider](https://github.com/jbinfo/MobileDetectServiceProvider) is a service provider to
+interact with Mobile detect class methods.
+Made by [Lhassan Baazzi](https://github.com/jbinfo).
+
+**Slim Framework**
+
+* [Slim_Mobile_Detect](https://github.com/zguillez/slim_mobile_detect) implements Mobile_Detect lib for different
+responses write on Slim Framework App.
+
+**ExpressionEngine**
+
+* [EE2 Detect Mobile](https://github.com/garethtdavies/detect-mobile) is a lightweight PHP plugin for EE2 that detects
+ a mobile browser using the Mobile Detect class. Made by [Gareth Davies](https://github.com/garethtdavies).
+
+**Yii Framework**
+
+* [Yii Extension](https://github.com/iamsalnikov/MobileDetect) - Mobile detect plugin for Yii framework.
+Made by [Alexey Salnikov](https://github.com/iamsalnikov).
+
+* [Yii Extension](https://github.com/candasm/yii1-mobile-detect-component) - Mobile detect component for Yii framework
+1.x version which supports composer package manager. Made by [Candas Minareci](https://github.com/candasm).
+
+* [Yii2 Device Detect](https://github.com/alexandernst/yii2-device-detect/) - Yii2 extension for Mobile-Detect library.
+Made by [Alexander Nestorov](https://github.com/alexandernst).
+
+**CakePHP**
+
+* [CakePHP MobileDetect](https://github.com/chronon/CakePHP-MobileDetectComponent-Plugin) is a plugin component for
+CakePHP 2.x. Made by [Gregory Gaskill](https://github.com/chronon).
+
+**FuelPHP**
+
+* [Special Agent](https://github.com/rob-bar/special_agent) is a FuelPHP package which uses php-mobile-detect to
+determine whether a device is mobile or not. It overrides the Fuelphp Agent class its methods.
+Made by [Robbie Bardjin](https://github.com/rob-bar).
+
+
+**TYPO3**
+
+* [px_mobiledetect](https://typo3.org/extensions/repository/view/px_mobiledetect) is an extension that helps to detect
+visitor's mobile device class (if that’s tablet or mobile device like smartphone). Made by Alexander Tretyak.
+
+**Other**
+
+* [PageCache](https://github.com/mmamedov/page-cache) is a lightweight PHP library for full page cache,
+with built-in Mobile-Detect support. Made by [Muhammed Mamedov](https://github.com/mmamedov).
+
+* [Statamic CMS Mobile Detect](https://github.com/haikulab/statamic-mobile-detect) is a plugin.
+Made by [Sergei Filippov](https://github.com/haikulab/statamic-mobile-detect) of Haiku Lab.
+
+* [Kohana Mobile Detect](https://github.com/madeinnordeste/kohana-mobile-detect) is an example of implementation of
+Mobile_Detect class with Kohana framework.
+Written by [Luiz Alberto S. Ribeiro](https://github.com/madeinnordeste).
+
+* [MemHT](https://www.memht.com) is a Free PHP CMS and Blog that permit the creation and the management online
+of websites with few and easy steps. Has the class included in the core.
+
+* [concrete5](https://www.concrete5.org) is a CMS that is free and open source. The library is included in the core.
+
+* [engine7](https://github.com/QOXCorp/exengine) is PHP Open Source Framework. The Mobile_Detect class is included in
+the engine.
+
+* [Zikula](http://zikula.org) is a free and open-source Content Management Framework, which allows you to run
+impressive websites and build powerful online applications. The core uses Mobile-Detect to switch to a special
+Mobile theme, using jQueryMobile.
+
+* [UserAgentInfo](https://github.com/quentin389/UserAgentInfo) is a PHP class for parsing user agent strings
+(HTTP_USER_AGENT). Includes mobile checks, bot checks, browser types/versions and more.
+Based on browscap, Mobile_Detect and ua-parser. Created for high traffic websites and fast batch processing.
+Made by [quentin389](https://github.com/quentin389).
+
+* [LJ Mobile Detect](https://github.com/lewisjenkins/craft-lj-mobiledetect) is a simple implementation of Mobile Detect
+for Craft CMS. Made by [Lewis Jenkins](https://github.com/lewisjenkins).
+
+* [Detect Craft](https://github.com/mmikkel/Detect-Craft) is a Craft CMS wrapper for the Mobile_Detect library. Made by [Mikkel Rummelhoff](https://github.com/mmikkel).
+
+* [Grav Plugin Mobile Detect](https://github.com/dimitrilongo/grav-plugin-mobile-detect/) is a simple implementation
+of Mobile Detect for Grav CMS. Made by [Dimitri Longo](https://github.com/dimitrilongo).
+
+* [Mobile_Detect module for UliCMS](https://github.com/derUli/ulicms-Mobile_Detect).
+Made by [derUli](https://github.com/derUli).
+
+**Perl**
+
+ * [MobileDetect.pm](https://www.buzzerstar.com/development/) is a Perl module for Mobile Detect.
+ Made by [Sebastian Enger](https://devop.tools/).
+
+**Python**
+
+* [pymobiledetect](https://pypi.python.org/pypi/pymobiledetect) - Mobile detect python package.
+Made by Bas van Oostveen.
+
+**Ruby**
+
+* [mobile_detect.rb](https://github.com/ktaragorn/mobile_detect) is a Ruby gem using the JSON data exposed by the
+php project and implementing a basic subset of the API (as much as can be done by the exposed data).
+Made by [Karthik T](https://github.com/ktaragorn).
+
+**Go**
+
+* [GoMobileDetect](https://github.com/Shaked/gomobiledetect) is a Go port of Mobile Detect class.
+Made by [https://github.com/Shaked](Shaked).
+
+
+**LUA**
+
+* [ua-lua](https://github.com/robinef/ua-lua) is a small lib written in LUA providing device type detection.
+ua-lua is detecting mobile or tablet devices based on user-agent inside nginx daemon.
+Made by [Frédéric Robinet](https://github.com/robinef).
+
+**.Net**
+
+* [mobile-detect](https://github.com/validide/mobile-detect) is a .Net partial port written in C#.
+Made by [Valentin Dide](https://github.com/validide).
+
+**ColdFusion**
+
+* [MobileDetect](https://github.com/GiancarloGomez/ColdFusion-MobileDetect) is a CFC port of the
+Mobile_Detect PHP Library. Made by [Giancarlo Gomez](https://github.com/GiancarloGomez).
+
+**Experiments** :bulb:
+
+* [Mobile Detect Fast](https://bitbucket.org/lanaguani/mobile-detect-fast/) (See: [#474](https://github.com/serbanghita/Mobile-Detect/issues/474)) is a class to increase the performance of Mobile Detect lib. Made by [LanaGuani](https://github.com/lanaguanifw).
+
+## About
+
+See [the history](./docs/HISTORY.md) of the project. \ No newline at end of file