TeraWurfl
[ class tree: TeraWurfl ] [ index: TeraWurfl ] [ all elements ]

Class: TeraWurflConfig

Source Location: /TeraWurflConfig.php

Class Overview


This static class provides the global configuration settings for Tera-WURFL.


Author(s):

Variables



Class Details

[line 21]
This static class provides the global configuration settings for Tera-WURFL.



Tags:



[ Top ]


Class Variables

static $CACHE_ENABLE =  true

[line 77]

Enable Caching System



Tags:

access:  public

Type:   Bool


[ Top ]

static $CAPABILITY_FILTER =  false

[line 145]

Allows you to store only the specified capabilities from the WURFL file. By default, every capability in the WURFL is stored in the

database and made available to your scripts. If you only want to know if the device is wireless or not, you can store only the is_wireless_device capability. To disable the filter, set it to false, to enable it, you must set it to an array. This array can contain the group names (if you want to include the entire group, i.e. "product_info") and/or capability names (if you want just a specific capability, i.e. "is_wireless_device").

Usage Example:

  1.     public static $CAPABILITY_FILTER array(
  2.         // Complete Capability Groups
  3.         "product_info",
  4.  
  5.         // Individual Capabilities
  6.         "max_image_width",
  7.         "max_image_height",
  8.         "chtml_make_phone_call_string",
  9.     );




Tags:

access:  public

Type:   Mixed


[ Top ]

static $DATADIR =  'data/'

[line 72]

Data Directory



Tags:

access:  public

Type:   String


[ Top ]

static $DB_CONNECTOR =  "MySQL5"

[line 52]

Database Connector (MySQL4, MySQL5, MSSQL2005, MongoDB)



Tags:

access:  public

Type:   String


[ Top ]

static $DB_HOST =  "localhost"

[line 30]

Database Hostname To specify the MySQL 5 TCP port or use a named pipe / socket, put it at the end of your hostname, seperated by a colon (ex: "localhost:3310" or "localhost:/var/run/mysqld/mysqld.sock").

For MS SQL Server, use the format HOSTNAME\Instance, like "MYHOSTNAME\SQLEXPRESS". For MongoDB, enter a hostname or a MongoDB Connection String, like "mongodb:///tmp/mongodb-27017.sock,localhost:27017"




Tags:

access:  public

Type:   String


[ Top ]

static $DB_PASS =  'wurfl'

[line 42]

Database Password

For MongoDB, this may be blank if authentication is not used




Tags:

access:  public

Type:   String


[ Top ]

static $DB_SCHEMA =  "tera_wurfl_demo"

[line 47]

Database Name / Schema Name



Tags:

access:  public

Type:   String


[ Top ]

static $DB_USER =  "terawurfluser"

[line 36]

Database User

For MongoDB, this may be blank if authentication is not used




Tags:

access:  public

Type:   String


[ Top ]

static $LOG_FILE =  'wurfl.log'

[line 98]

Filename of Log File (found in DATADIR; default: wurfl.log)



Tags:

access:  public

Type:   String


[ Top ]

static $LOG_LEVEL =  LOG_WARNING

[line 104]

Log Level as defined by PHP Constants LOG_ERR, LOG_WARNING and LOG_NOTICE.

Should be changed to LOG_WARNING or LOG_ERR for production sites




Tags:

access:  public

Type:   Int


[ Top ]

static $MEMORY_LIMIT =  "768M"

[line 115]

PHP Memory Limit. See OVERRIDE_MEMORY_LIMIT for more info



Tags:

access:  public

Type:   String


[ Top ]

static $OVERRIDE_MEMORY_LIMIT =  true

[line 110]

Enable to override PHP's memory limit if you are having problems loading the WURFL data like this:

Fatal error: Allowed memory size of 67108864 bytes exhausted (tried to allocate 24 bytes) in TeraWurflLoader.php on line 287




Tags:

access:  public

Type:   Bool


[ Top ]

static $PATCH_ENABLE =  true

[line 82]

Enable Patches (must reload WURFL after changing)



Tags:

access:  public

Type:   Bool


[ Top ]

static $PATCH_FILE =  'custom_web_patch.xml;web_browsers_patch.xml'

[line 88]

Filename of patch file. If you want to use more than one, seperate them with semicolons. They are loaded in order.

ex: $PATCH_FILE = 'web_browsers_patch.xml;custom_patch_ver2.3.xml';




Tags:

access:  public

Type:   String


[ Top ]

static $SIMPLE_DESKTOP_ENGINE_ENABLE =  true

[line 123]

Enable the SimpleDesktop Matching Engine. This feature bypasses the advanced detection methods that are normally used while detecting desktop web browsers; instead, most desktop browsers are detected using simple keywords and expressions. When enabled, this setting will increase performance dramatically (200% in our tests) but could result in some false positives. This will also reduce the size of the cache table dramatically because all the devices detected by the SimpleDesktop Engine will be cached in one cache entry.



Tags:

access:  public

Type:   Bool


[ Top ]

static $TABLE_PREFIX =  "TeraWurfl"

[line 57]

Prefix used for all database tables



Tags:

access:  public

Type:   String


[ Top ]

static $WURFL_CVS_URL =  "http://wurfl.cvs.sourceforge.net/%2Acheckout%2A/wurfl/xml/wurfl.xml"

[line 67]

URL of CVS WURFL File



Tags:

access:  public

Type:   String


[ Top ]

static $WURFL_DL_URL =  "http://downloads.sourceforge.net/project/wurfl/WURFL/latest/wurfl-latest.zip"

[line 62]

URL of WURFL File. If you have multiple installations of Tera-WURFL, you can set this to a location on your network.



Tags:

access:  public

Type:   String


[ Top ]

static $WURFL_FILE =  'wurfl.xml'

[line 93]

Filename of main WURFL file (found in DATADIR; default: wurfl.xml)



Tags:

access:  public

Type:   String


[ Top ]



Documentation generated on Sun, 19 Sep 2010 00:15:56 +0000 by phpDocumentor 1.4.3