Move MobileDetect library to vendor
- Bumped the version to 2.8.25 (from 2.8.11)
This commit is contained in:
parent
799e60aa62
commit
806368f151
1
boot.php
1
boot.php
|
@ -29,7 +29,6 @@ require_once('include/datetime.php');
|
|||
require_once('include/pgettext.php');
|
||||
require_once('include/nav.php');
|
||||
require_once('include/cache.php');
|
||||
require_once('library/Mobile_Detect/Mobile_Detect.php');
|
||||
require_once('include/features.php');
|
||||
require_once('include/identity.php');
|
||||
require_once('update.php');
|
||||
|
|
|
@ -13,7 +13,8 @@
|
|||
"issues": "https://github.com/friendica/friendica/issues"
|
||||
},
|
||||
"require": {
|
||||
"ezyang/htmlpurifier": "~4.7.0"
|
||||
"ezyang/htmlpurifier": "~4.7.0",
|
||||
"mobiledetect/mobiledetectlib": "2.8.*"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
|
|
|
@ -0,0 +1,114 @@
|
|||
{
|
||||
"_readme": [
|
||||
"This file locks the dependencies of your project to a known state",
|
||||
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
|
||||
"This file is @generated automatically"
|
||||
],
|
||||
"content-hash": "49b00f1ed3192e5173bd5577a3b91ba2",
|
||||
"packages": [
|
||||
{
|
||||
"name": "ezyang/htmlpurifier",
|
||||
"version": "v4.7.0",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/ezyang/htmlpurifier.git",
|
||||
"reference": "ae1828d955112356f7677c465f94f7deb7d27a40"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/ezyang/htmlpurifier/zipball/ae1828d955112356f7677c465f94f7deb7d27a40",
|
||||
"reference": "ae1828d955112356f7677c465f94f7deb7d27a40",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.2"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
"HTMLPurifier": "library/"
|
||||
},
|
||||
"files": [
|
||||
"library/HTMLPurifier.composer.php"
|
||||
]
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"LGPL"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Edward Z. Yang",
|
||||
"email": "admin@htmlpurifier.org",
|
||||
"homepage": "http://ezyang.com"
|
||||
}
|
||||
],
|
||||
"description": "Standards compliant HTML filter written in PHP",
|
||||
"homepage": "http://htmlpurifier.org/",
|
||||
"keywords": [
|
||||
"html"
|
||||
],
|
||||
"time": "2015-08-05T01:03:42+00:00"
|
||||
},
|
||||
{
|
||||
"name": "mobiledetect/mobiledetectlib",
|
||||
"version": "2.8.25",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/serbanghita/Mobile-Detect.git",
|
||||
"reference": "f0896b5c7274d1450023b0b376240be902c3251c"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/serbanghita/Mobile-Detect/zipball/f0896b5c7274d1450023b0b376240be902c3251c",
|
||||
"reference": "f0896b5c7274d1450023b0b376240be902c3251c",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.0.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "*"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"classmap": [
|
||||
"Mobile_Detect.php"
|
||||
],
|
||||
"psr-0": {
|
||||
"Detection": "namespaced/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Serban Ghita",
|
||||
"email": "serbanghita@gmail.com",
|
||||
"homepage": "http://mobiledetect.net",
|
||||
"role": "Developer"
|
||||
}
|
||||
],
|
||||
"description": "Mobile_Detect is a lightweight PHP class for detecting mobile devices. It uses the User-Agent string combined with specific HTTP headers to detect the mobile environment.",
|
||||
"homepage": "https://github.com/serbanghita/Mobile-Detect",
|
||||
"keywords": [
|
||||
"detect mobile devices",
|
||||
"mobile",
|
||||
"mobile detect",
|
||||
"mobile detector",
|
||||
"php mobile detect"
|
||||
],
|
||||
"time": "2017-03-29T13:59:30+00:00"
|
||||
}
|
||||
],
|
||||
"packages-dev": [],
|
||||
"aliases": [],
|
||||
"minimum-stability": "stable",
|
||||
"stability-flags": [],
|
||||
"prefer-stable": false,
|
||||
"prefer-lowest": false,
|
||||
"platform": [],
|
||||
"platform-dev": []
|
||||
}
|
|
@ -1,11 +0,0 @@
|
|||
vendor/
|
||||
nbproject/
|
||||
/*.buildpath
|
||||
/*.project
|
||||
/.settings
|
||||
/error.log
|
||||
/export/nicejson
|
||||
.idea/
|
||||
*.iml
|
||||
/coverage
|
||||
/phpunit.phar
|
|
@ -1,3 +0,0 @@
|
|||
[submodule "export/nicejson"]
|
||||
path = export/nicejson
|
||||
url = https://github.com/GerHobbelt/nicejson-php.git
|
|
@ -1,24 +0,0 @@
|
|||
<?php
|
||||
|
||||
use Symfony\CS\FixerInterface;
|
||||
|
||||
$finder = Symfony\CS\Finder\DefaultFinder::create()
|
||||
->notName('LICENSE')
|
||||
->notName('README.md')
|
||||
->notName('.php_cs')
|
||||
->notName('composer.*')
|
||||
->notName('phpunit.xml*')
|
||||
->notName('*.phar')
|
||||
->exclude('vendor')
|
||||
->exclude('examples')
|
||||
->exclude('Symfony/CS/Tests/Fixer')
|
||||
->notName('ElseifFixer.php')
|
||||
->exclude('data')
|
||||
->in(__DIR__)
|
||||
;
|
||||
|
||||
return Symfony\CS\Config\Config::create()
|
||||
->finder($finder)
|
||||
;
|
||||
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
language: php
|
||||
php:
|
||||
- "5.2"
|
||||
- "5.3"
|
||||
- "5.4"
|
||||
- "5.5"
|
||||
- "5.6"
|
||||
|
||||
branches:
|
||||
only:
|
||||
- devel
|
||||
|
||||
script:
|
||||
- phpunit -v -c tests/phpunit.xml
|
||||
|
||||
notifications:
|
||||
email: false
|
File diff suppressed because one or more lines are too long
|
@ -1,219 +0,0 @@
|
|||
[![Build Status](https://travis-ci.org/serbanghita/Mobile-Detect.svg?branch=devel)](https://travis-ci.org/serbanghita/Mobile-Detect) [![Latest Stable Version](https://poser.pugx.org/mobiledetect/mobiledetectlib/v/stable.svg)](https://packagist.org/packages/mobiledetect/mobiledetectlib) [![Total Downloads](https://poser.pugx.org/mobiledetect/mobiledetectlib/downloads.svg)](https://packagist.org/packages/mobiledetect/mobiledetectlib) [![Daily Downloads](https://poser.pugx.org/mobiledetect/mobiledetectlib/d/daily.png)](https://packagist.org/packages/mobiledetect/mobiledetectlib) [![License](https://poser.pugx.org/mobiledetect/mobiledetectlib/license.svg)](https://packagist.org/packages/mobiledetect/mobiledetectlib)
|
||||
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/serbanghita/Mobile-Detect?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||||
|
||||
![Mobile Detect](http://demo.mobiledetect.net/logo-github.png)
|
||||
|
||||
> Motto: "Every business should have a mobile detection script to detect mobile readers."
|
||||
|
||||
<i>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.</i>
|
||||
|
||||
> We're commited to make Mobile_Detect the best open-source mobile detection resource and this is why before each release we're running [unit tests](./tests), we also research and update the detection rules on <b>daily</b> and <b>weekly</b> basis.
|
||||
|
||||
Your website's _content strategy_ is important! You need a complete toolkit to deliver an experience that is _optimized_, _fast_ and _relevant_ to your users. Mobile_Detect class is a [server-side detection](http://www.w3.org/TR/mwabp/#bp-devcap-detection) tool 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.
|
||||
|
||||
##### This month updates
|
||||
|
||||
First of all a **BIG THANK YOU** to our growing community for your continuous support and for all the feedback received! I'm still working my way with the current issues and all the emails.
|
||||
|
||||
Nick is almost done with all the code for the upcoming `3.0.0` so that I only have to integrate the new parsing engine. We will release minor `2.8.xx` versions until a feature freeze where we will switch to the new branch. You will all be announced before this and hopefully we can make the transition smooth for everyone.
|
||||
|
||||
<a href="http://trycatch.us/"><img align="left" src="http://assets.mobiledetect.net/img/try_catch_logo_80px.jpg" hspace="20"></a> Last but not least, special thanks for supporting us to our friends from [TryCatch.us](http://trycatch.us/) who _are set to carefully curate the most talented developers in Europe_!
|
||||
|
||||
Thank you all and we're excited for the new release!
|
||||
|
||||
##### Download and demo
|
||||
|
||||
|Download|Docs|Examples|
|
||||
|-------------|-------------|-------------|
|
||||
|[Go to releases](../../tags)|[Become a contributor](../../wiki/Become-a-contributor)|[Code examples](../../wiki/Code-examples)
|
||||
|[Mobile_Detect.php](./Mobile_Detect.php)|[History](../../wiki/History)|[:iphone: Live demo!](http://is.gd/mobiletest)
|
||||
|[Composer package](https://packagist.org/packages/mobiledetect/mobiledetectlib)|
|
||||
|
||||
##### Help
|
||||
|
||||
|Pledgie|Paypal|
|
||||
|-------|------|
|
||||
|[Donate :+1:](http://pledgie.com/campaigns/21856)|[Donate :beer:](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=mobiledetectlib%40gmail%2ecom&lc=US&item_name=Mobile%20Detect¤cy_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, [BrowserStack](http://browserstack.com) - for providing access to their great platform, [Zend](http://zend.com) - for donating licenses, [Dragos Gavrila](https://twitter.com/grafician) who contributed with the logo.
|
||||
|
||||
##### 3rd party modules / [Submit new](../../issues/new?title=New%203rd%20party%20module&body=Name, Link and Description of the module.)
|
||||
|
||||
:point_right: Keep `Mobile_Detect.php` class in a separate `module` and do NOT include it in your script core because of the high frequency of updates.
|
||||
:point_right: When including the class into you `web application` or `module` always use `include_once '../path/to/Mobile_Detect.php` to prevent conflicts.
|
||||
|
||||
<table>
|
||||
|
||||
<tr>
|
||||
<td>Varnish Cache</td>
|
||||
<td>
|
||||
<p><a href="https://github.com/willemk/varnish-mobiletranslate">Varnish Mobile Detect</a> - Drop-in varnish solution to mobile user detection based on the Mobile-Detect library. Made by <a href="https://github.com/willemk">willemk</a></p>
|
||||
<p><a href="https://github.com/carlosabalde/mobiledetect2vcl">mobiledetect2vcl</a> - 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 <a href="https://github.com/carlosabalde">Carlos Abalde</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>WordPress</td>
|
||||
<td>
|
||||
<p><a href="http://wordpress.org/extend/plugins/wp-mobile-detect/">WordPress Mobile Detect</a> - Gives you the ability to wrap that infographic in a `[notdevice][/notdevice]` shortcode so at the server level <code>WordPress</code> will decide to show that content only if the user is NOT on a phone or tablet. Made by <a href="http://profiles.wordpress.org/professor44/">Jesse Friedman</a>.</p>
|
||||
|
||||
<p><a href="http://wordpress.org/plugins/mobble/">mobble</a> - provides mobile related conditional functions for your site. e.g. is_iphone(), is_mobile() and is_tablet(). Made by Scott Evans.</p>
|
||||
|
||||
<p><a href="https://github.com/iamspacehead/responsage">WordPress Responsage</a> - A small <code>WordPress</code> theme plugin that allows you to make your images responsive. Made by <a href="https://github.com/iamspacehead">Adrian Ciaschetti</a>.</p>
|
||||
|
||||
<p><a href="http://wordpress.org/plugins/social-popup/">Social PopUP</a> - This plugin will display a popup or splash screen when a new user visit your site showing a Google+, Twitter and Facebook follow links. It uses Mobile_Detect to detect mobile devices.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Drupal</td>
|
||||
<td>
|
||||
<p><a href="http://drupal.org/project/mobile_switch">Drupal Mobile Switch</a> - The Mobile Switch <code>Drupal</code> module provides a automatic theme switch functionality for mobile devices,
|
||||
detected by Browscap or Mobile Detect. Made by <a href="http://drupal.org/user/45267">Siegfried Neumann</a>.</p>
|
||||
|
||||
<p><a href="http://drupal.org/project/context_mobile_detect">Drupal Context Mobile Detect</a> - This is a <code>Drupal context</code> module which integrates Context and PHP Mobile Detect library.
|
||||
Created by <a href="http://drupal.org/user/432492">Artem Shymko</a>.</p>
|
||||
|
||||
<p><a href="http://drupal.org/project/mobile_detect">Drupal Mobile Detect</a> - Lightweight mobile detect module for <code>Drupal</code> created by <a href="http://drupal.org/user/325244">Matthew Donadio</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Joomla</td>
|
||||
<td><p><a href="http://www.yagendoo.com/en/blog/free-mobile-detection-plugin-for-joomla.html">yagendoo Joomla! Mobile Detection Plugin</a> - Lightweight PHP plugin for Joomla! that detects a mobile browser using the Mobile Detect class. Made by <a href="http://www.yagendoo.com/">yagendoo media</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Magento</td>
|
||||
<td><p><a href="http://www.magentocommerce.com/magento-connect/catalog/product/view/id/16835/">Magento</a> - This <code>Magento helper</code> from Optimise Web enables the use of all functions provided by MobileDetect.net.
|
||||
Made by <a href="http://www.kathirvel.com">Kathir Vel</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>PrestaShop</td>
|
||||
<td><p><a href="http://www.prestashop.com/">PrestaShop</a> is a free, secure and open source shopping cart platform. Mobile_Detect is included in the default package since 1.5.x.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Zend Framework</td>
|
||||
<td>
|
||||
<p><a href="https://github.com/neilime/zf2-mobile-detect.git">ZF2 Mobile-Detect</a> - Zend Framework 2 module that provides Mobile-Detect features (Mobile_Detect class as a service, helper for views and plugin controllers). Made by <a href="https://github.com/neilime">neilime</a></p>
|
||||
|
||||
<p><a href="https://github.com/nikolaposa/MobileDetectModule">ZF2 MobileDetectModule</a> - 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 <a href="https://github.com/nikolaposa">Nikola Posa</a></p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Symfony</td>
|
||||
<td><p><a href="https://github.com/suncat2000/MobileDetectBundle">Symfony2 Mobile Detect Bundle</a> - The bundle for detecting mobile devices, manage mobile view and redirect to the mobile and tablet version.
|
||||
Made by <a href="https://github.com/suncat2000">Nikolay Ivlev</a>.</p>
|
||||
<p><a href="https://github.com/jbinfo/MobileDetectServiceProvider">Silex Mobile Detect Service Provider</a> - <code>Silex</code> service provider to interact with Mobile detect class methods. Made by <a href="https://github.com/jbinfo">Lhassan Baazzi</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Laravel</td>
|
||||
<td>
|
||||
<p><a href="https://github.com/jenssegers/Laravel-Agent">Laravel-Agent</a> a user agent class for Laravel, based on Mobile Detect with some additional functionality. Made by <a href="https://github.com/jenssegers">Jens Segers</a>.</p>
|
||||
<p><a href="https://github.com/hisorange/browser-detect">BrowserDetect</a> is a browser & mobile detection package, collects and wrap together the best user-agent identifiers for Laravel. Created by <a href="https://github.com/hisorange">Varga Zsolt</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>ExpressionEngine</td>
|
||||
<td><p><a href="https://github.com/garethtdavies/detect-mobile">EE2 Detect Mobile</a> - Lightweight PHP plugin for <code>EE2</code> that detects a mobile browser using the Mobile Detect class. Made by <a href="https://github.com/garethtdavies">Gareth Davies</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Yii Framework</td>
|
||||
<td><p><a href="https://github.com/iamsalnikov/MobileDetect">Yii Extension</a> - Mobile detect plugin for Yii framework. Made by <a href="https://github.com/iamsalnikov">Alexey Salnikov</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>CakePHP</td>
|
||||
<td><p><a href="https://github.com/chronon/CakePHP-MobileDetectComponent-Plugin">CakePHP MobileDetect</a> - <code>plugin</code> component for <code>CakePHP</code> 2.x. Made by <a href="https://github.com/chronon">Gregory Gaskill</a></p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>FuelPHP</td>
|
||||
<td><a href="https://github.com/rob-bar/special_agent">Special Agent</a> 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 <a href="https://github.com/rob-bar">Robbie Bardjin</a>.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Typo3</td>
|
||||
<td><a href="http://docs.typo3.org/typo3cms/extensions/px_mobiledetect/1.0.2/">px_mobiledetect</a> 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.</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Statamic</td>
|
||||
<td><p><a href="https://github.com/sergeifilippov/statamic-mobile-detect">Statamic CMS Mobile Detect</a> - <code>plugin</code>. Made by <a href="https://github.com/haikulab/statamic-mobile-detect">Sergei Filippov of Haiku Lab</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Kohana</td>
|
||||
<td><p><a href="https://github.com/madeinnordeste/kohana-mobile-detect">Kohana Mobile Detect</a> - an example of implementation of <code>Mobile_Detect</code> class with Kohana framework. Written by <a href="https://github.com/madeinnordeste">Luiz Alberto S. Ribeiro</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>mobile-detect.js</td>
|
||||
<td><p>A <a href="https://github.com/hgoebl/mobile-detect.js">JavaScript port</a> of Mobile-Detect class. Made by <a href="https://github.com/hgoebl">Heinrich Goebl</a></p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Perl</td>
|
||||
<td><p><a href="http://www.buzzerstar.com/development/">MobileDetect.pm</a> - <code>Perl module</code> for Mobile Detect. Made by <a href="http://www.buzzerstar.com/">Sebastian Enger</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>python</td>
|
||||
<td><p><a href="http://pypi.python.org/pypi/pymobiledetect">pymobiledetect</a> - Mobile detect <code>python package</code>. Made by Bas van Oostveen.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Ruby</td>
|
||||
<td><p><a href="https://github.com/ktaragorn/mobile_detect">mobile_detect.rb</a> - A <code>Ruby gem</code> 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 <a href="https://github.com/ktaragorn">Karthik T</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>GoMobileDetect</td>
|
||||
<td><p><a href="https://github.com/Shaked/gomobiledetect">GoMobileDetect</a> - Go port of Mobile Detect class. Made by <a href="https://github.com/Shaked">Shaked</a>.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>MemHT</td>
|
||||
<td><p><a href="http://www.memht.com/">MemHT</a> 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.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>concrete5</td>
|
||||
<td><p><a href="https://www.concrete5.org/">concrete5</a> is a CMS that is free and open source. The library is included in the core.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>engine7</td>
|
||||
<td><p><a href="https://github.com/gchiappe/exengine7">ExEngine 7</a> PHP Open Source Framework. The Mobile_Detect class is included in the engine.</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Zikula</td>
|
||||
<td><p><a href="http://zikula.org/">Zikula</a> 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</p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>UserAgentInfo</td>
|
||||
<td><p><a href="https://github.com/quentin389/UserAgentInfo">UserAgentInfo</a> 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 <a href="https://github.com/quentin389">quentin389</a></p></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>Craft CMS</td>
|
||||
<td><p><a href="https://github.com/lewisjenkins/craft-lj-mobiledetect">LJ Mobile Detect</a> is a simple implementation of Mobile Detect for Craft CMS. Made by <a href="https://github.com/lewisjenkins">Lewis Jenkins</a></p></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
|
@ -1,6 +1,6 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) <2011-2014> <Serban Ghita> <serbanghita@gmail.com>
|
||||
Copyright (c) <2011-2015> Serban Ghita, Nick Ilyin and contributors.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
@ -0,0 +1,283 @@
|
|||
![Mobile Detect](http://demo.mobiledetect.net/logo-github.png)
|
||||
|
||||
> Motto: "Every business should have a mobile detection script to detect mobile readers."
|
||||
|
||||
[![Build Status](https://travis-ci.org/serbanghita/Mobile-Detect.svg?branch=devel)](https://travis-ci.org/serbanghita/Mobile-Detect)
|
||||
[![Latest Stable Version](https://poser.pugx.org/mobiledetect/mobiledetectlib/v/stable.svg)](https://packagist.org/packages/mobiledetect/mobiledetectlib)
|
||||
[![Total Downloads](https://poser.pugx.org/mobiledetect/mobiledetectlib/downloads.svg)](https://packagist.org/packages/mobiledetect/mobiledetectlib)
|
||||
[![Daily Downloads](https://poser.pugx.org/mobiledetect/mobiledetectlib/d/daily.png)](https://packagist.org/packages/mobiledetect/mobiledetectlib)
|
||||
[![License](https://poser.pugx.org/mobiledetect/mobiledetectlib/license.svg)](https://packagist.org/packages/mobiledetect/mobiledetectlib)
|
||||
|
||||
*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.*
|
||||
|
||||
We're committed to make Mobile_Detect the best open-source mobile detection resource and this is why before
|
||||
each release we're running [unit tests](./tests), we also research and update the detection rules on **daily**
|
||||
and **weekly** basis.
|
||||
|
||||
Your website's _content strategy_ is important! You need a complete toolkit to deliver an experience that is _optimized_, _fast_ and _relevant_ to your users. Mobile_Detect class is a [server-side detection](http://www.w3.org/TR/mwabp/#bp-devcap-detection) tool 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.
|
||||
|
||||
##### Announcements
|
||||
|
||||
For `2.x` branch we are no longer taking optimizations pull requests, but only new regexes and User-Agents for our tests.
|
||||
On `2.x` releases we are focusing on **new tablets only**. All the pull requests about TVs, bots or optimizations will be closed and analyzed after `3.0.0-beta` is released.
|
||||
|
||||
Still working on `3.0.0` branch to provide you with device detection!
|
||||
We're really excited on this one!
|
||||
We would like to speed this up, but life and family gets in the way ;)
|
||||
|
||||
Special thanks to **JetBrains** for providing licenses for **PHPStorm**. In case you never heard or tried PHPStorm, you're
|
||||
clearly missing out! [Check PHPStorm](https://www.jetbrains.com/phpstorm/) out!
|
||||
|
||||
##### Download and demo
|
||||
|
||||
|Download|Docs|Examples|
|
||||
|-------------|-------------|-------------|
|
||||
|[Go to releases](../../tags)|[Become a contributor](../../wiki/Become-a-contributor)|[Code examples](../../wiki/Code-examples)
|
||||
|[Mobile_Detect.php](./Mobile_Detect.php)|[History](../../wiki/History)|[:iphone: Live demo!](http://is.gd/mobiletest)
|
||||
|[Composer package](https://packagist.org/packages/mobiledetect/mobiledetectlib)|
|
||||
|
||||
#### Continuous updates
|
||||
|
||||
You can use [composer](https://getcomposer.org/doc/00-intro.md) in your release and update process to make sure you have the latest Mobile_Detect version.
|
||||
|
||||
```
|
||||
composer require mobiledetect/mobiledetectlib
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"require": {
|
||||
"mobiledetect/mobiledetectlib": "^2.8"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
##### Help
|
||||
|
||||
|Pledgie|Paypal|
|
||||
|-------|------|
|
||||
|[Donate :+1:](https://pledgie.com/campaigns/21856)|[Donate :beer:](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=mobiledetectlib%40gmail%2ecom&lc=US&item_name=Mobile%20Detect¤cy_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, [BrowserStack](https://www.browserstack.com/) - for providing access to their great platform, [Zend](http://www.zend.com/) - for donating licenses, [Dragos Gavrila](https://twitter.com/grafician) who contributed with the logo.
|
||||
|
||||
##### 3rd party modules / [Submit new](../../issues/new?title=New%203rd%20party%20module&body=Name, Link and Description of the module.)
|
||||
|
||||
:point_right: Keep `Mobile_Detect.php` class in a separate `module` and do NOT include it in your script core because of the high frequency of updates.
|
||||
:point_right: When including the class into you `web application` or `module` always use `include_once '../path/to/Mobile_Detect.php` to prevent conflicts.
|
||||
|
||||
**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**
|
||||
|
||||
* [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).
|
||||
|
||||
**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).
|
||||
|
||||
* [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**
|
||||
|
||||
* [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).
|
||||
|
||||
* [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).
|
||||
|
||||
|
||||
**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).
|
|
@ -17,9 +17,7 @@
|
|||
"php": ">=5.0.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "*",
|
||||
"johnkary/phpunit-speedtrap": "~1.0@dev",
|
||||
"codeclimate/php-test-reporter": "dev-master"
|
||||
"phpunit/phpunit": "*"
|
||||
},
|
||||
"autoload": {
|
||||
"classmap": ["Mobile_Detect.php"],
|
|
@ -0,0 +1,67 @@
|
|||
<?php
|
||||
/**
|
||||
* Mobile Detect Library
|
||||
* - export -
|
||||
* =====================
|
||||
*
|
||||
* Use the resulting JSON export file in other languages
|
||||
* other than PHP. Always check for 'version' key because
|
||||
* new major versions can modify the structure of the JSON file.
|
||||
*
|
||||
* The result of running this script is the export.json file.
|
||||
*
|
||||
* @license Code and contributions have 'MIT License'
|
||||
* More details: https://github.com/serbanghita/Mobile-Detect/blob/master/LICENSE.txt
|
||||
*
|
||||
*/
|
||||
|
||||
// Included nicejson function to beautify the result JSON file.
|
||||
// This library is not mandatory.
|
||||
if( file_exists(dirname(__FILE__).'/nicejson/nicejson.php') ) {
|
||||
include_once dirname(__FILE__).'/nicejson/nicejson.php';
|
||||
}
|
||||
|
||||
// Include Mobile Detect.
|
||||
require_once dirname(__FILE__).'/../Mobile_Detect.php';
|
||||
$detect = new Mobile_Detect;
|
||||
|
||||
$json = array(
|
||||
// The current version of Mobile Detect class that
|
||||
// is being exported.
|
||||
'version' => $detect->getScriptVersion(),
|
||||
|
||||
// All headers that trigger 'isMobile' to be 'true',
|
||||
// before reaching the User-Agent match detection.
|
||||
'headerMatch' => $detect->getMobileHeaders(),
|
||||
|
||||
// All possible User-Agent headers.
|
||||
'uaHttpHeaders' => $detect->getUaHttpHeaders(),
|
||||
|
||||
// All the regexes that trigger 'isMobile' or 'isTablet'
|
||||
// to be true.
|
||||
'uaMatch' => array(
|
||||
// If match is found, triggers 'isMobile' to be true.
|
||||
'phones' => $detect->getPhoneDevices(),
|
||||
// Triggers 'isTablet' to be true.
|
||||
'tablets' => $detect->getTabletDevices(),
|
||||
// If match is found, triggers 'isMobile' to be true.
|
||||
'browsers' => $detect->getBrowsers(),
|
||||
// If match is found, triggers 'isMobile' to be true.
|
||||
'os' => $detect->getOperatingSystems(),
|
||||
// Various utilities. To be further discussed.
|
||||
'utilities' => $detect->getUtilities()
|
||||
)
|
||||
);
|
||||
|
||||
$fileName = dirname(__FILE__).'/../Mobile_Detect.json';
|
||||
// Write the JSON file to disk.11
|
||||
// You can import this file in your app.
|
||||
if (file_put_contents(
|
||||
$fileName,
|
||||
function_exists('json_format') ? json_format($json) : json_encode($json)
|
||||
)) {
|
||||
echo 'Done. Check '.realpath($fileName).' file.';
|
||||
}
|
||||
else {
|
||||
echo 'Failed to write '.realpath($fileName).' to disk.';
|
||||
}
|
|
@ -4,7 +4,7 @@
|
|||
* the Symfony Universal ClassLoader by Fabien Potencier. Since PSR-0 handles an underscore in
|
||||
* classnames (on the filesystem) as a slash, "Mobile_Detect.php" autoloaders will try to convert
|
||||
* the classname and path to "Mobile\Detect.php". This script will ensure autoloading with:
|
||||
* - Namespace: Detection
|
||||
* - Namespace: Detection
|
||||
* - Classname: MobileDetect
|
||||
* - Namespased: \Detection\MobileDetect
|
||||
* - Autoload path: ./namespaced
|
|
@ -0,0 +1,187 @@
|
|||
<?xml version="1.0"?>
|
||||
<ruleset name="PSR2">
|
||||
<description>The PSR-2 coding standard.</description>
|
||||
<arg name="tab-width" value="4"/>
|
||||
|
||||
<!-- 2. General -->
|
||||
|
||||
<!-- 2.1 Basic Coding Standard -->
|
||||
|
||||
<!-- Include the whole PSR-1 standard -->
|
||||
<rule ref="PSR1"/>
|
||||
|
||||
<!-- 2.2 Files -->
|
||||
|
||||
<!-- All PHP files MUST use the Unix LF (linefeed) line ending. -->
|
||||
<rule ref="Generic.Files.LineEndings">
|
||||
<properties>
|
||||
<property name="eolChar" value="\n"/>
|
||||
</properties>
|
||||
</rule>
|
||||
|
||||
<!-- All PHP files MUST end with a single blank line. -->
|
||||
<!-- checked in Files/EndFileNewlineSniff -->
|
||||
|
||||
<!-- The closing ?> tag MUST be omitted from files containing only PHP. -->
|
||||
<!-- checked in Files/ClosingTagSniff -->
|
||||
|
||||
<!-- 2.3 Lines -->
|
||||
|
||||
<!-- The soft limit on line length MUST be 120 characters; automated style checkers MUST warn but MUST NOT error at the soft limit. -->
|
||||
<rule ref="Generic.Files.LineLength">
|
||||
<properties>
|
||||
<property name="lineLimit" value="0"/>
|
||||
<property name="absoluteLineLimit" value="0"/>
|
||||
</properties>
|
||||
</rule>
|
||||
|
||||
<!-- There MUST NOT be trailing whitespace at the end of non-blank lines. -->
|
||||
<rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
|
||||
<properties>
|
||||
<property name="ignoreBlankLines" value="true"/>
|
||||
</properties>
|
||||
</rule>
|
||||
<rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.StartFile">
|
||||
<severity>0</severity>
|
||||
</rule>
|
||||
<rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EndFile">
|
||||
<severity>0</severity>
|
||||
</rule>
|
||||
<rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines">
|
||||
<severity>0</severity>
|
||||
</rule>
|
||||
|
||||
<!-- There MUST NOT be more than one statement per line. -->
|
||||
<rule ref="Generic.Formatting.DisallowMultipleStatements"/>
|
||||
|
||||
<!-- 2.4 Indenting -->
|
||||
|
||||
<!-- Code MUST use an indent of 4 spaces, and MUST NOT use tabs for indenting. -->
|
||||
<rule ref="Generic.WhiteSpace.ScopeIndent">
|
||||
<properties>
|
||||
<property name="ignoreIndentationTokens" type="array" value="T_COMMENT,T_DOC_COMMENT_OPEN_TAG"/>
|
||||
</properties>
|
||||
</rule>
|
||||
<rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
|
||||
|
||||
<!-- 2.5 Keywords and True/False/Null -->
|
||||
|
||||
<!-- PHP keywords MUST be in lower case. -->
|
||||
<rule ref="Generic.PHP.LowerCaseKeyword"/>
|
||||
|
||||
<!-- The PHP constants true, false, and null MUST be in lower case. -->
|
||||
<rule ref="Generic.PHP.LowerCaseConstant"/>
|
||||
|
||||
<!-- 3. Namespace and Use Declarations -->
|
||||
|
||||
<!-- When present, there MUST be one blank line after the namespace declaration. -->
|
||||
<!-- checked in Namespaces/NamespaceDeclarationSniff -->
|
||||
|
||||
<!-- When present, all use declarations MUST go after the namespace declaration.
|
||||
There MUST be one use keyword per declaration.
|
||||
There MUST be one blank line after the use block. -->
|
||||
<!-- checked in Namespaces/UseDeclarationSniff -->
|
||||
|
||||
<!-- 4. Classes, Properties, and Methods -->
|
||||
|
||||
<!-- 4.1. Extends and Implements -->
|
||||
|
||||
<!-- The extends and implements keywords MUST be declared on the same line as the class name.
|
||||
The opening brace for the class go MUST go on its own line; the closing brace for the class MUST go on the next line after the body.
|
||||
Lists of implements MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one interface per line. -->
|
||||
<!-- checked in Classes/ClassDeclarationSniff -->
|
||||
|
||||
<!-- 4.2. Properties -->
|
||||
|
||||
<!-- Visibility MUST be declared on all properties.
|
||||
The var keyword MUST NOT be used to declare a property.
|
||||
There MUST NOT be more than one property declared per statement.
|
||||
Property names SHOULD NOT be prefixed with a single underscore to indicate protected or private visibility. -->
|
||||
<!-- checked in Classes/PropertyDeclarationSniff -->
|
||||
|
||||
<!-- 4.3 Methods -->
|
||||
|
||||
<!-- Visibility MUST be declared on all methods. -->
|
||||
<rule ref="Squiz.Scope.MethodScope"/>
|
||||
<rule ref="Squiz.WhiteSpace.ScopeKeywordSpacing"/>
|
||||
|
||||
<!-- Method names SHOULD NOT be prefixed with a single underscore to indicate protected or private visibility. -->
|
||||
<!-- checked in Methods/MethodDeclarationSniff -->
|
||||
|
||||
<!-- Method names MUST NOT be declared with a space after the method name. The opening brace MUST go on its own line, and the closing brace MUST go on the next line following the body. There MUST NOT be a space after the opening parenthesis, and there MUST NOT be a space before the closing parenthesis. -->
|
||||
<rule ref="Squiz.Functions.FunctionDeclaration"/>
|
||||
<rule ref="Squiz.Functions.LowercaseFunctionKeywords"/>
|
||||
|
||||
<!-- 4.4 Method Arguments -->
|
||||
|
||||
<!-- In the argument list, there MUST NOT be a space before each comma, and there MUST be one space after each comma. -->
|
||||
<rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
|
||||
<properties>
|
||||
<property name="equalsSpacing" value="1"/>
|
||||
</properties>
|
||||
</rule>
|
||||
<rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpacingAfterHint">
|
||||
<severity>0</severity>
|
||||
</rule>
|
||||
|
||||
<!-- Method arguments with default values MUST go at the end of the argument list. -->
|
||||
<rule ref="PEAR.Functions.ValidDefaultValue"/>
|
||||
|
||||
<!-- Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line. When the argument list is split across multiple lines, the closing parenthesis and opening brace MUST be placed together on their own line with one space between them. -->
|
||||
<rule ref="Squiz.Functions.MultiLineFunctionDeclaration"/>
|
||||
|
||||
<!-- 4.5 abstract, final, and static -->
|
||||
|
||||
<!-- When present, the abstract and final declarations MUST precede the visibility declaration.
|
||||
When present, the static declaration MUST come after the visibility declaration. -->
|
||||
<!-- checked in Methods/MethodDeclarationSniff -->
|
||||
|
||||
<!-- 4.6 Method and Function Calls -->
|
||||
|
||||
<!-- When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis, there MUST NOT be a space after the opening parenthesis, and there MUST NOT be a space before the closing parenthesis. In the argument list, there MUST NOT be a space before each comma, and there MUST be one space after each comma.
|
||||
Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line. -->
|
||||
<rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
|
||||
<rule ref="PSR2.Methods.FunctionCallSignature.SpaceAfterCloseBracket">
|
||||
<severity>0</severity>
|
||||
</rule>
|
||||
|
||||
<!-- 5. Control Structures -->
|
||||
|
||||
<!-- The general style rules for control structures are as follows:
|
||||
There MUST be one space after the control structure keyword
|
||||
There MUST NOT be a space after the opening parenthesis
|
||||
There MUST NOT be a space before the closing parenthesis
|
||||
There MUST be one space between the closing parenthesis and the opening brace
|
||||
The structure body MUST be indented once
|
||||
The closing brace MUST be on the next line after the body -->
|
||||
<rule ref="Squiz.ControlStructures.ControlSignature"/>
|
||||
<rule ref="Squiz.WhiteSpace.ScopeClosingBrace"/>
|
||||
<rule ref="Squiz.ControlStructures.ForEachLoopDeclaration"/>
|
||||
<rule ref="Squiz.ControlStructures.ForLoopDeclaration"/>
|
||||
<rule ref="Squiz.ControlStructures.LowercaseDeclaration"/>
|
||||
<!-- checked in ControlStructures/ControlStructureSpacingSniff -->
|
||||
|
||||
<!-- The body of each structure MUST be enclosed by braces. This standardizes how the structures look, and reduces the likelihood of introducing errors as new lines get added to the body. -->
|
||||
<rule ref="Generic.ControlStructures.InlineControlStructure"/>
|
||||
|
||||
<!-- 5.1. if, elseif, else -->
|
||||
|
||||
<!-- The keyword elseif SHOULD be used instead of else if so that all control keywords look like single words. -->
|
||||
<!-- checked in ControlStructures/ElseIfDeclarationSniff -->
|
||||
|
||||
<!-- 5.2. switch, case -->
|
||||
|
||||
<!-- The case statement MUST be indented once from switch, and the break keyword (or other terminating keyword) MUST be indented at the same level as the case body. There MUST be a comment such as // no break when fall-through is intentional in a non-empty case body. -->
|
||||
<!-- checked in ControlStructures/SwitchDeclarationSniff -->
|
||||
|
||||
<!-- 6. Closures -->
|
||||
|
||||
<!-- Closures MUST be declared with a space after the function keyword, and a space before and after the use keyword.
|
||||
The opening brace MUST go on the same line, and the closing brace MUST go on the next line following the body.
|
||||
There MUST NOT be a space after the opening parenthesis of the argument list or variable list, and there MUST NOT be a space before the closing parenthesis of the argument list or variable list.
|
||||
In the argument list and variable list, there MUST NOT be a space before each comma, and there MUST be one space after each comma.
|
||||
Closure arguments with default values MUST go at the end of the argument list.
|
||||
Argument lists and variable lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument or variable per line.
|
||||
When the ending list (whether or arguments or variables) is split across multiple lines, the closing parenthesis and opening brace MUST be placed together on their own line with one space between them. -->
|
||||
<!-- checked in Squiz.Functions.MultiLineFunctionDeclaration -->
|
||||
</ruleset>
|
Loading…
Reference in New Issue
Block a user