PHP Class Jaybizzle\CrawlerDetect\CrawlerDetect

Show file Open project: jaybizzle/crawler-detect Class Usage Examples

Protected Properties

Property Type Description
$crawlers Jaybizzle\CrawlerDetect\Fixtures\Crawlers Crawlers object.
$exclusions Jaybizzle\CrawlerDetect\Fixtures\Exclusions Exclusions object.
$httpHeaders array Headers that contain a user agent.
$matches array Store regex matches.
$uaHttpHeaders Jaybizzle\CrawlerDetect\Fixtures\Headers Headers object.
$userAgent null The user agent.

Public Methods

Method Description
__construct ( array $headers = null, $userAgent = null ) Class constructor.
getExclusions ( ) : string Build the replacement regex.
getMatches ( ) : string | null Return the matches.
getRegex ( ) : string Build the user agent regex.
getUaHttpHeaders ( ) : array Return user agent headers.
isCrawler ( string $userAgent = null ) : boolean Check user agent string against the regex.
setHttpHeaders ( array $httpHeaders = null ) Set HTTP headers.
setUserAgent ( string $userAgent = null ) Set the user agent.

Method Details

__construct() public method

Class constructor.
public __construct ( array $headers = null, $userAgent = null )
$headers array

getExclusions() public method

Build the replacement regex.
public getExclusions ( ) : string
return string

getMatches() public method

Return the matches.
public getMatches ( ) : string | null
return string | null

getRegex() public method

Build the user agent regex.
public getRegex ( ) : string
return string

getUaHttpHeaders() public method

Return user agent headers.
public getUaHttpHeaders ( ) : array
return array

isCrawler() public method

Check user agent string against the regex.
public isCrawler ( string $userAgent = null ) : boolean
$userAgent string
return boolean

setHttpHeaders() public method

Set HTTP headers.
public setHttpHeaders ( array $httpHeaders = null )
$httpHeaders array

setUserAgent() public method

Set the user agent.
public setUserAgent ( string $userAgent = null )
$userAgent string

Property Details

$crawlers protected property

Crawlers object.
protected Crawlers,Jaybizzle\CrawlerDetect\Fixtures $crawlers
return Jaybizzle\CrawlerDetect\Fixtures\Crawlers

$exclusions protected property

Exclusions object.
protected Exclusions,Jaybizzle\CrawlerDetect\Fixtures $exclusions
return Jaybizzle\CrawlerDetect\Fixtures\Exclusions

$httpHeaders protected property

Headers that contain a user agent.
protected array $httpHeaders
return array

$matches protected property

Store regex matches.
protected array $matches
return array

$uaHttpHeaders protected property

Headers object.
protected Headers,Jaybizzle\CrawlerDetect\Fixtures $uaHttpHeaders
return Jaybizzle\CrawlerDetect\Fixtures\Headers

$userAgent protected property

The user agent.
protected null $userAgent
return null