zanysoft/laravel-crawler-detect

A Laravel package to detect web crawlers via the user agent

1.0 2020-09-18 21:31 UTC

This package is auto-updated.

Last update: 2024-12-16 10:19:21 UTC


README

Build Status Total Downloads Scrutinizer Code Quality StyleCI

Installation

Run composer require zanysoft/laravel-crawler-detect or add "zanysoft/laravel-crawler-detect": "^1.0" to your composer.json file.

Add the following to the providers array in your config/app.php file..

  ZanySoft\LaravelCrawlerDetect\LaravelCrawlerDetectServiceProvider::class,

...and the following to your aliases array...

  'Crawler'   => 'ZanySoft\LaravelCrawlerDetect\Facades\LaravelCrawler',

Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

Usage

// Check current 'visitors' user agent
if(Crawler::isCrawler()) {
  // true if crawler user agent detected
}


// Pass a user agent as a string
if(Crawler::isCrawler('Mozilla/5.0 (compatible; aiHitBot/2.9; +https://www.aihitdata.com/about)')) {
  // true if crawler user agent detected
}