Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JayBizzle/Crawler-Detect
π· CrawlerDetect is a PHP class for detecting bots/crawlers/spiders via the user agent
https://github.com/JayBizzle/Crawler-Detect
bots crawler detect hacktoberfest php spider user-agent
Last synced: 5 days ago
JSON representation
π· CrawlerDetect is a PHP class for detecting bots/crawlers/spiders via the user agent
- Host: GitHub
- URL: https://github.com/JayBizzle/Crawler-Detect
- Owner: JayBizzle
- License: mit
- Created: 2015-03-23T20:05:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-20T21:42:39.000Z (19 days ago)
- Last Synced: 2024-10-29T14:05:06.406Z (10 days ago)
- Topics: bots, crawler, detect, hacktoberfest, php, spider, user-agent
- Language: PHP
- Homepage: https://crawlerdetect.io
- Size: 8.76 MB
- Stars: 1,991
- Watchers: 53
- Forks: 259
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- web-stuff - Crawler Detect - Detect if the requestor is a crawler (based on user-agents) (PHP)
- php-awesome - CrawlerDetect - η½ι‘΅η¬θ«ζ£ζ₯ (η±»εΊ / η½ι‘΅ζε/代η)
- awesome-php - CrawlerDetect - A PHP class for detecting bots/crawlers/spiders via the user agent. (Table of Contents / Scraping)
README
## About CrawlerDetect
CrawlerDetect is a PHP class for detecting bots/crawlers/spiders via the `user agent` and `http_from` header. Currently able to detect 1,000's of bots/spiders/crawlers.
### Installation
```
composer require jaybizzle/crawler-detect
```
### Usage
```PHP
use Jaybizzle\CrawlerDetect\CrawlerDetect;
$CrawlerDetect = new CrawlerDetect;
// Check the user agent of the current 'visitor'
if($CrawlerDetect->isCrawler()) {
// true if crawler user agent detected
}
// Pass a user agent as a string
if($CrawlerDetect->isCrawler('Mozilla/5.0 (compatible; Sosospider/2.0; +http://help.soso.com/webspider.htm)')) {
// true if crawler user agent detected
}
// Output the name of the bot that matched (if any)
echo $CrawlerDetect->getMatches();
```
### Contributing
If you find a bot/spider/crawler user agent that CrawlerDetect fails to detect, please submit a pull request with the regex pattern added to the `$data` array in `Fixtures/Crawlers.php` and add the failing user agent to `tests/crawlers.txt`.
Failing that, just create an issue with the user agent you have found, and we'll take it from there :)
### Laravel Package
If you would like to use this with Laravel, please see [Laravel-Crawler-Detect](https://github.com/JayBizzle/Laravel-Crawler-Detect)
### Symfony Bundle
To use this library with Symfony 2/3/4, check out the [CrawlerDetectBundle](https://github.com/nicolasmure/CrawlerDetectBundle).
### YII2 Extension
To use this library with the YII2 framework, check out [yii2-crawler-detect](https://github.com/AlikDex/yii2-crawler-detect).
### ES6 Library
To use this library with NodeJS or any ES6 application based, check out [es6-crawler-detect](https://github.com/JefferyHus/es6-crawler-detect).
### Python Library
To use this library in a Python project, check out [crawlerdetect](https://github.com/moskrc/CrawlerDetect).
### JVM Library (written in Java)
To use this library in a JVM project (including Java, Scala, Kotlin, etc.), check out [CrawlerDetect](https://github.com/nekosoftllc/crawler-detect).
### .NET Library
To use this library in a .net standard (including .net core) based project, check out [NetCrawlerDetect](https://github.com/gplumb/NetCrawlerDetect).
### Ruby Gem
To use this library with Ruby on Rails or any Ruby-based application, check out [crawler_detect](https://github.com/loadkpi/crawler_detect) gem.
### Go Module
To use this library with Go, check out the [crawlerdetect](https://github.com/x-way/crawlerdetect) module.
_Parts of this class are based on the brilliant [MobileDetect](https://github.com/serbanghita/Mobile-Detect)_
[](https://github.com/JayBizzle/Crawler-Detect)
