Http/UserAgent/Spam.php

Show: PublicProtectedPrivateinherited
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_Spam

Package: Zend\Http\UserAgent
Spam 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

>VPropertyprotectedarray $_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  
>VPropertyprotectedarray $_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  
>VPropertyprotectedstring $_browser = ''
inherited
Browser signature
Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_browser
Default value''Details
Type
string
Inherited_from
\Zend_Http_UserAgent_AbstractDevice::$$_browser  
>VPropertyprotectedstring $_browserVersion = ''
inherited
Browser version
Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_browserVersion
Default value''Details
Type
string
Inherited_from
\Zend_Http_UserAgent_AbstractDevice::$$_browserVersion  
>VPropertyprotectedarray $_config
inherited
Configuration
Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_config
Details
Type
array
Inherited_from
\Zend_Http_UserAgent_AbstractDevice::$$_config  
>VPropertyprotectedarray $_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  
>VPropertyprotectedarray $_server
inherited
Server variable
Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_server
Details
Type
array
Inherited_from
\Zend_Http_UserAgent_AbstractDevice::$$_server  
>VPropertyprotectedarray $_uaSignatures = array('')
static
Default valuearray('')Details
Type
array
Todo
User Agent Signatures  
>VPropertyprotectedstring $_userAgent
inherited
User Agent chain
Inherited from: \Zend_Http_UserAgent_AbstractDevice::$$_userAgent
Details
Type
string
Inherited_from
\Zend_Http_UserAgent_AbstractDevice::$$_userAgent  

Methods

methodpublic__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
NameTypeDescription
$userAgentnull | string | array

If array, restores from serialized version

$serverarray
$configarray
methodprotected_defineFeatures() : string

Look for features

Returns
TypeDescription
string
methodprotected_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()
methodprotected_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
TypeDescription
array
methodprotected_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
NameTypeDescription
$userAgentstring
$signaturesarray
Returns
TypeDescription
bool
methodprotected_restoreFromArray(array $spec) : void
inherited

Restore object state from array

Inherited from: \Zend_Http_UserAgent_AbstractDevice::_restoreFromArray()
Parameters
NameTypeDescription
$specarray
methodpublicextractFromUserAgent(string $userAgent) : array
staticinherited

Extract and sets informations from the User Agent chain

Inherited from: \Zend_Http_UserAgent_AbstractDevice::extractFromUserAgent()
Parameters
NameTypeDescription
$userAgentstring

User Agent chain

Returns
TypeDescription
array
methodpublicgetAllFeatures() : array
inherited

Gets all the browser/device features

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getAllFeatures()
Returns
TypeDescription
array
methodpublicgetAllGroups() : array
inherited

Gets all the browser/device features' groups

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getAllGroups()
Returns
TypeDescription
array
methodpublicgetBrowser() : string
inherited

Get the browser type

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getBrowser()
Returns
TypeDescription
string
methodpublicgetBrowserVersion() : string
inherited

Get the browser version

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getBrowserVersion()
Returns
TypeDescription
string
methodpublicgetFeature(string $feature) : string | null
inherited

Gets the value of the current browser/device feature

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getFeature()
Parameters
NameTypeDescription
$featurestring

Feature to search

Returns
TypeDescription
string | null
methodpublicgetGroup(string $group) : array
inherited

Gets an array of features associated to a group

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getGroup()
Parameters
NameTypeDescription
$groupstring

Group param

Returns
TypeDescription
array
methodpublicgetImageFormatSupport() : array
inherited

Retrieve image format support

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getImageFormatSupport()
Returns
TypeDescription
array
methodpublicgetImages() : \the
inherited

Get image types

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getImages()
Returns
TypeDescription
\the$_images
methodpublicgetMaxImageHeight() : int
inherited

Get maximum image height supported by this device

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getMaxImageHeight()
Returns
TypeDescription
int
methodpublicgetMaxImageWidth() : int
inherited

Get maximum image width supported by this device

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getMaxImageWidth()
Returns
TypeDescription
int
methodpublicgetPhysicalScreenHeight() : int
inherited

Get physical screen height of this device

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getPhysicalScreenHeight()
Returns
TypeDescription
int
methodpublicgetPhysicalScreenWidth() : int
inherited

Get physical screen width of this device

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getPhysicalScreenWidth()
Returns
TypeDescription
int
methodpublicgetPreferredMarkup() : string
inherited

Get preferred markup type

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getPreferredMarkup()
Returns
TypeDescription
string
methodpublicgetType() : string

Gives the current browser type

Returns
TypeDescription
string
methodpublicgetUserAgent() : string
inherited

Get the user agent string

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getUserAgent()
Returns
TypeDescription
string
methodpublicgetXhtmlSupportLevel() : int
inherited

Get supported X/HTML version

Inherited from: \Zend_Http_UserAgent_AbstractDevice::getXhtmlSupportLevel()
Returns
TypeDescription
int
methodpublichasFeature(string $feature) : bool
inherited

Check a feature for the current browser/device.

Inherited from: \Zend_Http_UserAgent_AbstractDevice::hasFeature()
Parameters
NameTypeDescription
$featurestring

The feature to check.

Returns
TypeDescription
bool
methodpublichasFlashSupport() : bool
inherited

Does the device support Flash?

Inherited from: \Zend_Http_UserAgent_AbstractDevice::hasFlashSupport()
Returns
TypeDescription
bool
methodpublichasPdfSupport() : bool
inherited

Does the device support PDF?

Inherited from: \Zend_Http_UserAgent_AbstractDevice::hasPdfSupport()
Returns
TypeDescription
bool
methodpublichasPhoneNumber() : bool
inherited

Does the device have a phone number associated with it?

Inherited from: \Zend_Http_UserAgent_AbstractDevice::hasPhoneNumber()
Returns
TypeDescription
bool
methodpublichttpsSupport() : bool
inherited

Does the device support HTTPS?

Inherited from: \Zend_Http_UserAgent_AbstractDevice::httpsSupport()
Returns
TypeDescription
bool
methodpublicmatch(string $userAgent, array $server) : bool
static

Comparison of the UserAgent chain and User Agent signatures

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

Parameters
NameTypeDescription
$userAgentstring

User Agent chain

$serverarray

$_SERVER like param

Returns
TypeDescription
bool
methodpublicserialize() : string
inherited

Serialize object

Inherited from: \Zend_Http_UserAgent_AbstractDevice::serialize()
Returns
TypeDescription
string
methodpublicsetBrowser(string $browser) : void
Parameters
NameTypeDescription
$browserstring
methodpublicsetBrowserVersion(string $browserVersion) : void
Parameters
NameTypeDescription
$browserVersionstring
methodpublicsetFeature(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
NameTypeDescription
$featurestring

The feature to set.

$valuestring

(option) feature value.

$groupstring

(option) Group to associate with the feature

Returns
TypeDescription
\Zend_Http_UserAgent_AbstractDevice
methodpublicsetGroup(string $group, string $feature) : \Zend_Http_UserAgent_AbstractDevice
inherited

Affects a feature to a group

Inherited from: \Zend_Http_UserAgent_AbstractDevice::setGroup()
Parameters
NameTypeDescription
$groupstring

Group name

$featurestring

Feature name

Returns
TypeDescription
\Zend_Http_UserAgent_AbstractDevice
methodpublicsetImages(array $_images) : void
Parameters
NameTypeDescription
$_imagesarray
methodpublicsetUserAgent(string $userAgent) : void
Parameters
NameTypeDescription
$userAgentstring
methodpublicunserialize(string $serialized) : void
inherited

Unserialize

Inherited from: \Zend_Http_UserAgent_AbstractDevice::unserialize()
Parameters
NameTypeDescription
$serializedstring
Documentation was generated by phpDocumentor 2.0.0a12.