Http/UserAgent/Bot.php

Show:

inherited

Classes
- \Zend_Http_UserAgent_Bot

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Http
Subpackage: UserAgent

\Zend_Http_UserAgent_Bot
jump to top

Package: Zend\Http\UserAgent

Bot browser type matcher

Parent(s): \Zend_Http_UserAgent_AbstractDevice
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_aFeatures = array()

inherited

Browser/Device features

Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_aFeatures

Default valuearray()Details

Type: array
Inherited_from: \Zend_Http_UserAgent_AbstractDevice::$$_aFeatures

array $_aGroup = array()

inherited

Browser/Device features groups

Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_aGroup

Default valuearray()Details

Type: array
Inherited_from: \Zend_Http_UserAgent_AbstractDevice::$$_aGroup

string $_browser = ''

inherited

Browser signature

Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_browser

Default value''Details

Type: string
Inherited_from: \Zend_Http_UserAgent_AbstractDevice::$$_browser

string $_browserVersion = ''

inherited

Browser version

Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_browserVersion

Default value''Details

Type: string
Inherited_from: \Zend_Http_UserAgent_AbstractDevice::$$_browserVersion

array $_config

inherited

Configuration

Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_config

Details

Type: array
Inherited_from: \Zend_Http_UserAgent_AbstractDevice::$$_config

array $_images = array('jpeg', 'gif', 'png', 'pjpeg', 'x-png', 'bmp')

inherited

Image types

Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_images

Default valuearray('jpeg', 'gif', 'png', 'pjpeg', 'x-png', 'bmp')Details

Type: array
Inherited_from: \Zend_Http_UserAgent_AbstractDevice::$$_images

array $_server

inherited

Server variable

Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_server

Details

Type: array
Inherited_from: \Zend_Http_UserAgent_AbstractDevice::$$_server

array $_uaSignatures = array('googlebot', 'msnbot', 'slurp', 'yahoo', 'alexa', 'appie', 'archiver', 'ask jeeves', 'baiduspider', 'bot', 'crawl', 'crawler', 'curl', 'eventbox', 'facebookexternal', 'fast', 'feedfetcher-google', 'firefly', 'froogle', 'gigabot', 'girafabot', 'google', 'htdig', 'infoseek', 'inktomi', 'java', 'larbin', 'looksmart', 'mechanize', 'mediapartners-google', 'monitor', 'nambu', 'nationaldirectory', 'novarra', 'pear', 'perl', 'python', 'rabaz', 'radian', 'rankivabot', 'scooter', 'sogou web spider', 'spade', 'sphere', 'spider', 'technoratisnoop', 'tecnoseek', 'teoma', 'toolbar', 'transcoder', 'twitt', 'url_spider_sql', 'webalta crawler', 'webbug', 'webfindbot', 'wordpress', 'www.galaxy.com', 'yahoo! searchmonkey', 'yahoo! slurp', 'yandex', 'zyborg')

static

User Agent Signatures

Default value

array('googlebot', 'msnbot', 'slurp', 'yahoo', 'alexa', 'appie', 'archiver', 'ask jeeves', 'baiduspider', 'bot', 'crawl', 'crawler', 'curl', 'eventbox', 'facebookexternal', 'fast', 'feedfetcher-google', 'firefly', 'froogle', 'gigabot', 'girafabot', 'google', 'htdig', 'infoseek', 'inktomi', 'java', 'larbin', 'looksmart', 'mechanize', 'mediapartners-google', 'monitor', 'nambu', 'nationaldirectory', 'novarra', 'pear', 'perl', 'python', 'rabaz', 'radian', 'rankivabot', 'scooter', 'sogou web spider', 'spade', 'sphere', 'spider', 'technoratisnoop', 'tecnoseek', 'teoma', 'toolbar', 'transcoder', 'twitt', 'url_spider_sql', 'webalta crawler', 'webbug', 'webfindbot', 'wordpress', 'www.galaxy.com', 'yahoo! searchmonkey', 'yahoo! slurp', 'yandex', 'zyborg')

Details

Type: array

string $_userAgent

inherited

User Agent chain

Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_userAgent

Details

Type: string
Inherited_from: \Zend_Http_UserAgent_AbstractDevice::$$_userAgent

Methods

__construct(null | string | array $userAgent = null, array $server = array(), array $config = array()) : void

inherited

Constructor

Inherited from: \Zend_Http_UserAgent_AbstractDevice::__construct()

Allows injecting user agent, server array, and/or config array. If an array is provided for the first argument, the assumption should be that the device object is being seeded with cached values from serialization.

Parameters

Name	Type	Description
$userAgent	null \| string \| array	If array, restores from serialized version
$server	array
$config	array

_defineFeatures() : array | null

inherited

Look for features

Inherited from: \Zend_Http_UserAgent_AbstractDevice::_defineFeatures()

Returns

Type	Description
array \| null

_getDefaultFeatures() : void

inherited

Sets all the standard features extracted from the User Agent chain and $this->_server vars

Inherited from: \Zend_Http_UserAgent_AbstractDevice::_getDefaultFeatures()

_loadFeaturesAdapter() : array

inherited

Loads the Features Adapter if it's defined in the $config array Otherwise, nothing is done

Inherited from: \Zend_Http_UserAgent_AbstractDevice::_loadFeaturesAdapter()

Returns

Type	Description
array

_matchAgentAgainstSignatures(string $userAgent, array $signatures) : bool

staticinherited

Match a user agent string against a list of signatures

Inherited from: \Zend_Http_UserAgent_AbstractDevice::_matchAgentAgainstSignatures()

Parameters

Name	Type	Description
$userAgent	string
$signatures	array

Returns

Type	Description
bool

_restoreFromArray(array $spec) : void

inherited

Restore object state from array

Inherited from: \Zend_Http_UserAgent_AbstractDevice::_restoreFromArray()

Parameters

Name	Type	Description
$spec	array

extractFromUserAgent(string $userAgent) : array

staticinherited

Extract and sets informations from the User Agent chain

Inherited from: \Zend_Http_UserAgent_AbstractDevice::extractFromUserAgent()

Parameters

Name	Type	Description
$userAgent	string	User Agent chain

Returns

Type	Description
array

getAllFeatures() : array

inherited

Gets all the browser/device features

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getAllFeatures()

Returns

Type	Description
array

getAllGroups() : array

inherited

Gets all the browser/device features' groups

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getAllGroups()

Returns

Type	Description
array

getBrowser() : string

inherited

Get the browser type

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getBrowser()

Returns

Type	Description
string

getBrowserVersion() : string

inherited

Get the browser version

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getBrowserVersion()

Returns

Type	Description
string

getFeature(string $feature) : string | null

inherited

Gets the value of the current browser/device feature

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getFeature()

Parameters

Name	Type	Description
$feature	string	Feature to search

Returns

Type	Description
string \| null

getGroup(string $group) : array

inherited

Gets an array of features associated to a group

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getGroup()

Parameters

Name	Type	Description
$group	string	Group param

Returns

Type	Description
array

getImageFormatSupport() : array

inherited

Retrieve image format support

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getImageFormatSupport()

Returns

Type	Description
array

getImages() : \the

inherited

Get image types

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getImages()

Returns

Type	Description
\the	$_images

getMaxImageHeight() : int

inherited

Get maximum image height supported by this device

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getMaxImageHeight()

Returns

Type	Description
int

getMaxImageWidth() : int

inherited

Get maximum image width supported by this device

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getMaxImageWidth()

Returns

Type	Description
int

getPhysicalScreenHeight() : int

inherited

Get physical screen height of this device

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getPhysicalScreenHeight()

Returns

Type	Description
int

getPhysicalScreenWidth() : int

inherited

Get physical screen width of this device

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getPhysicalScreenWidth()

Returns

Type	Description
int

getPreferredMarkup() : string

inherited

Get preferred markup type

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getPreferredMarkup()

Returns

Type	Description
string

getType() : string

Gives the current browser type

Returns

Type	Description
string

getUserAgent() : string

inherited

Get the user agent string

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getUserAgent()

Returns

Type	Description
string

getXhtmlSupportLevel() : int

inherited

Get supported X/HTML version

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getXhtmlSupportLevel()

Returns

Type	Description
int

hasFeature(string $feature) : bool

inherited

Check a feature for the current browser/device.

Inherited from: \Zend_Http_UserAgent_AbstractDevice::hasFeature()

Parameters

Name	Type	Description
$feature	string	The feature to check.

Returns

Type	Description
bool

hasFlashSupport() : bool

inherited

Does the device support Flash?

Inherited from: \Zend_Http_UserAgent_AbstractDevice::hasFlashSupport()

Returns

Type	Description
bool

hasPdfSupport() : bool

inherited

Does the device support PDF?

Inherited from: \Zend_Http_UserAgent_AbstractDevice::hasPdfSupport()

Returns

Type	Description
bool

hasPhoneNumber() : bool

inherited

Does the device have a phone number associated with it?

Inherited from: \Zend_Http_UserAgent_AbstractDevice::hasPhoneNumber()

Returns

Type	Description
bool

httpsSupport() : bool

inherited

Does the device support HTTPS?

Inherited from: \Zend_Http_UserAgent_AbstractDevice::httpsSupport()

Returns

Type	Description
bool

match(string $userAgent, array $server) : bool

static

Comparison of the UserAgent chain and browser signatures

Return either an array of browser signature strings, or a boolean.

Parameters

Name	Type	Description
$userAgent	string	User Agent chain
$server	array	$_SERVER like param

Returns

Type	Description
bool

serialize() : string

inherited

Serialize object

Inherited from: \Zend_Http_UserAgent_AbstractDevice::serialize()

Returns

Type	Description
string

setBrowser(string $browser) : void

inherited

Inherited from: \Zend_Http_UserAgent_AbstractDevice::setBrowser()

Parameters

Name	Type	Description
$browser	string

setBrowserVersion(string $browserVersion) : void

inherited

Inherited from: \Zend_Http_UserAgent_AbstractDevice::setBrowserVersion()

Parameters

Name	Type	Description
$browserVersion	string

setFeature(string $feature, string $value = false, string $group = '') : \Zend_Http_UserAgent_AbstractDevice

inherited

Set a feature for the current browser/device.

Inherited from: \Zend_Http_UserAgent_AbstractDevice::setFeature()

Parameters

Name	Type	Description
$feature	string	The feature to set.
$value	string	(option) feature value.
$group	string	(option) Group to associate with the feature

Returns

Type	Description
\Zend_Http_UserAgent_AbstractDevice

setGroup(string $group, string $feature) : \Zend_Http_UserAgent_AbstractDevice

inherited

Affects a feature to a group

Inherited from: \Zend_Http_UserAgent_AbstractDevice::setGroup()

Parameters

Name	Type	Description
$group	string	Group name
$feature	string	Feature name

Returns

Type	Description
\Zend_Http_UserAgent_AbstractDevice

setImages(array $_images) : void

inherited

Inherited from: \Zend_Http_UserAgent_AbstractDevice::setImages()

Parameters

Name	Type	Description
$_images	array

setUserAgent(string $userAgent) : void

inherited

Inherited from: \Zend_Http_UserAgent_AbstractDevice::setUserAgent()

Parameters

Name	Type	Description
$userAgent	string

unserialize(string $serialized) : void

inherited

Unserialize

Inherited from: \Zend_Http_UserAgent_AbstractDevice::unserialize()

Parameters

Name	Type	Description
$serialized	string

Http/UserAgent/Bot.php

\Zend_Http_UserAgent_Botjump to top

Properties

Methods

\Zend_Http_UserAgent_Bot
jump to top