function headers
This document shows the function headers for both the Perl and the PHP function libraries, in "Javadoc" style.
perl version
lib_dbConnect
sub lib_dbConnect
Connects to the database, optionally with keepConnection.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
handle to database
lib_dbDisconnect
sub lib_dbDisconnect
Disconnects from the database.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
lib_getBaseUserAgent
sub lib_getBaseUserAgent
Searches for the longest version of the UA string which has a matching DB value.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$userAgent original user agent string
return
$userAgent (possibly) reduced string
lib_getID
sub lib_getID
Returns the unique device ID for a given user agent string.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$userAgent string user agent for the device
return
id string
lib_getCapability
sub lib_getCapability
Returns the capability for a given capability name.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$id unique id of the device
$name string name of the capability
$fallback boolean for considering fallback
@fallbackChain where known, provide this to avoid unnecessary repetitive lookups
return
capability string
lib_getCapabilities
sub lib_getCapabilities
Returns all the capabilities of the specified device, working from the fallback base to the specified device.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$id string unique identifier of device
@fallbackChain array of fallbacks
return
array of values
lib_getUserAgents
sub lib_getUserAgents
Returns all *real* user devices in the database
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
array of values
lib_getVersion
sub lib_getVersion
Returns our version
author
Modulus Pty. Ltd. - prh
version
2006 1.0
return
version
lib_createTables
sub lib_createTables
Creates the tables for subsequent population.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
lib_rebuildTables
sub lib_rebuildTables
Populates the device and capability tables.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
1
_ellipsis
sub _ellipsis
Returns a string (possibly) shortened to the required length with an ellipsis in the middle.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
string, possibly shortened
php version
lib_dbConnect
function lib_dbConnect()
Connects to the database, returning a handle.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
a handle to the database or FALSE
lib_getFallbackChain
function lib_getFallbackChain($id)
Returns an array of fallback steps for the device down to root.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$id string ID of the device
return
an array of values, possibly empty
lib_getBaseUserAgent
function lib_getBaseUserAgent($userAgent)
Searches for the longest version of the UA string which has a matching DB value
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$userAgent string original user agent
return
a (possibly) reduced string
lib_getID
function lib_getID($userAgent)
Fetches the unique device ID for a given user agent string
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$userAgent string user agent for the device
return
string id
lib_getCapability
function lib_getCapability($id, $name, $fallback, $fallbackChain)
Returns the capability for a given capability name.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$id unique string id of the device
$name string name of the capability
$fallback boolean for considering fallback
@fallbackChain array of strings, where known, provide this to avoid unnecessary repetitive lookups
return
string capability
lib_getCapabilities
function lib_getCapabilities($id, $fallbackChain)
Returns all the capabilities of the specified device, working from the fallback base to the specified device
author
Modulus Pty. Ltd. - prh
version
2008 1.0
param
$id string uniquely representing the device
@fallbackChain array of string of the fallback devices
return
array of values
lib_getUserAgents
function lib_getUserAgents()
Returns all *real* user devices in the database.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
array of values
lib_getVersion
function lib_getVersion()
Returns our version.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
string representing the version
lib_createTables
function lib_createTables()
Creates the tables for subsequent population.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
lib_rebuildTables
function lib_rebuildTables()
Populates the device and capability tables.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
1
lib_ellipsis
function lib_ellipsis($str, $len)
Returns a string (possibly) shortened to the required length with an ellipsis in the middle.
author
Modulus Pty. Ltd. - prh
version
2008 1.0
return
string, possibly shortened
|
