Http/UserAgent/AbstractDevice.php

Show:

inherited

Classes
- \Zend_Http_UserAgent_AbstractDevice

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 [email protected] 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_AbstractDevice
jump to top

Package: Zend\Http\UserAgent

Abstract Class to define a browser device.

Implements: \Zend_Http_UserAgent_Device
Children: \Zend_Http_UserAgent_Bot; \Zend_Http_UserAgent_Probe; \Zend_Http_UserAgent_Text; \Zend_Http_UserAgent_Feed; \Zend_Http_UserAgent_Desktop; \Zend_Http_UserAgent_Spam; \Zend_Http_UserAgent_Mobile
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_aFeatures = array()

Browser/Device features

Default valuearray()Details

Type: array

array $_aGroup = array()

Browser/Device features groups

Default valuearray()Details

Type: array

string $_browser = ''

Browser signature

Default value''Details

Type: string

string $_browserVersion = ''

Browser version

Default value''Details

Type: string

array $_config =

Configuration

Details

Type: array

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

Image types

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

Type: array

array $_server =

Server variable

Details

Type: array

string $_userAgent =

User Agent chain

Details

Type: string

Methods

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

Constructor

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

Look for features

Returns

Type	Description
array \| null

_getDefaultFeatures() : void

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

_loadFeaturesAdapter() : array

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

Returns

Type	Description
array

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

static

Match a user agent string against a list of signatures

Parameters

Name	Type	Description
$userAgent	string
$signatures	array

Returns

Type	Description
bool

_restoreFromArray(array $spec) : void

Restore object state from array

Parameters

Name	Type	Description
$spec	array

extractFromUserAgent(string $userAgent) : array

static

Extract and sets informations from the User Agent chain

Parameters

Name	Type	Description
$userAgent	string	User Agent chain

Returns

Type	Description
array

getAllFeatures() : array

Gets all the browser/device features

Returns

Type	Description
array

getAllGroups() : array

Gets all the browser/device features' groups

Returns

Type	Description
array

getBrowser() : string

Get the browser type

Returns

Type	Description
string

getBrowserVersion() : string

Get the browser version

Returns

Type	Description
string

getFeature(string $feature) : string | null

Gets the value of the current browser/device feature

Parameters

Name	Type	Description
$feature	string	Feature to search

Returns

Type	Description
string \| null

getGroup(string $group) : array

Gets an array of features associated to a group

Parameters

Name	Type	Description
$group	string	Group param

Returns

Type	Description
array

getImageFormatSupport() : array

Retrieve image format support

Returns

Type	Description
array

getImages() : \the

Get image types

Returns

Type	Description
\the	$_images

getMaxImageHeight() : int

Get maximum image height supported by this device

Returns

Type	Description
int

getMaxImageWidth() : int

Get maximum image width supported by this device

Returns

Type	Description
int

getPhysicalScreenHeight() : int

Get physical screen height of this device

Returns

Type	Description
int

getPhysicalScreenWidth() : int

Get physical screen width of this device

Returns

Type	Description
int

getPreferredMarkup() : string

Get preferred markup type

Returns

Type	Description
string

getType() : string

abstract

Gets the browser type identifier

Returns

Type	Description
string

getUserAgent() : string

Get the user agent string

Returns

Type	Description
string

getXhtmlSupportLevel() : int

Get supported X/HTML version

Returns

Type	Description
int

hasFeature(string $feature) : bool

Check a feature for the current browser/device.

Parameters

Name	Type	Description
$feature	string	The feature to check.

Returns

Type	Description
bool

hasFlashSupport() : bool

Does the device support Flash?

Returns

Type	Description
bool

hasPdfSupport() : bool

Does the device support PDF?

Returns

Type	Description
bool

hasPhoneNumber() : bool

Does the device have a phone number associated with it?

Returns

Type	Description
bool

httpsSupport() : bool

Does the device support HTTPS?

Returns

Type	Description
bool

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

staticinherited

Attempt to match the user agent

Inherited from: \Zend_Http_UserAgent_Device::match()

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

Parameters

Name	Type	Description
$userAgent	string
$server	array

Returns

Type	Description
bool \| array

serialize() : string

Serialize object

Returns

Type	Description
string

setBrowser(string $browser) : void

Parameters

Name	Type	Description
$browser	string

setBrowserVersion(string $browserVersion) : void

Parameters

Name	Type	Description
$browserVersion	string

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

Set a feature for the current browser/device.

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

Affects a feature to a group

Parameters

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

Returns

Type	Description
\Zend_Http_UserAgent_AbstractDevice

setImages(array $_images) : void

Parameters

Name	Type	Description
$_images	array

setUserAgent(string $userAgent) : void

Parameters

Name	Type	Description
$userAgent	string

unserialize(string $serialized) : void

Unserialize

Parameters

Name	Type	Description
$serialized	string

Http/UserAgent/AbstractDevice.php

\Zend_Http_UserAgent_AbstractDevicejump to top

Properties

Methods

\Zend_Http_UserAgent_AbstractDevice
jump to top