Class: WURFL_Configuration_Config

Source Location: /Configuration/Config.php

Class Overview

Abstract base class for WURFL Configuration

Author(s):

Variables

Constants

Methods

Child classes:

WURFL_Configuration_InMemoryConfig: In-memory WURFL Configuration

WURFL_Configuration_ArrayConfig: Array-style WURFL configuration. To use this method you must create a php file that contains an array called $configuration with all of the required settings. NOTE: every path that you specify in the configuration must be absolute or relative to the folder that it is in.

WURFL_Configuration_XmlConfig: XML Configuration

Class Details

[line 33]
Abstract base class for WURFL Configuration

Tags:

abstract:

[ Top ]

Class Variables

$allowReload = false

[line 62]

Tags:

var:	true if a WURFL reload is allowed
access:	protected

Type:

bool

[ Top ]

$cache = array()

[line 78]

Tags:

access:

protected

Type:

array

[ Top ]

$configFilePath =

[line 54]

Tags:

var:	Path to the configuration file
access:	protected

Type:

string

[ Top ]

$configurationFileDir =

[line 58]

Tags:

var:	Directory that the configuration file is in
access:	protected

Type:

string

[ Top ]

$logDir =

[line 82]

Tags:

access:

protected

Type:

string

[ Top ]

$matchMode = self::MATCH_MODE_ACCURACY

[line 87]

Mode of operation (performance or accuracy)

Tags:

access:

protected

Type:

string

[ Top ]

$persistence = array()

[line 74]

Tags:

access:

protected

Type:

array

[ Top ]

$wurflFile =

[line 66]

Tags:

var:	wurfl file (normally wurfl.xml)
access:	protected

Type:

string

[ Top ]

$wurflPatches =

[line 70]

Tags:

var:	Array of WURFL patches
access:	protected

Type:

array

[ Top ]

Class Methods

static method validMatchMode [line 125]

static void validMatchMode(

$mode)

Tags:

access:

public

Parameters:

$mode

[ Top ]

constructor __construct [line 93]

WURFL_Configuration_Config __construct(
string
$configFilePath)

Creates a new WURFL Configuration object from $configFilePath

Parameters:

string

$configFilePath

Complete filename of configuration file

[ Top ]

method fileExist [line 150]

bool fileExist(
string
$confLocation)

Tags:

return:	file exists
access:	protected

Parameters:

string

$confLocation

[ Top ]

method getConfigFilePath [line 135]

string getConfigFilePath(
)

Tags:

return:	Config file including full path and filename
access:	protected

[ Top ]

method getConfigurationFileDir [line 142]

string getConfigurationFileDir(
)

Tags:

return:	Config file directory
access:	protected

[ Top ]

method getFullPath [line 162]

string getFullPath(
string
$fileName)

Return the full path

Tags:

return:	File name including full path
throws:	WURFL_WURFLException The configuration file does not exist
access:	protected

Parameters:

string

$fileName

[ Top ]

method initialize [line 105]

void initialize(
)

Initialize the Configuration object

Tags:

abstract:
access:	protected

Overridden in child classes as:

WURFL_Configuration_InMemoryConfig::initialize()

WURFL_Configuration_ArrayConfig::initialize(): Initialize class - gets called from the parent constructor

WURFL_Configuration_XmlConfig::initialize(): Initialize XML Configuration

[ Top ]

method isHighPerformance [line 121]

boolean isHighPerformance(
)

True if the engine is in High Performance mode

Tags:

access:

public

[ Top ]

method __get [line 113]

mixed __get(
string
$name)

Magic Method

Tags:

access:

public

Parameters:

string

$name

[ Top ]

Class Constants

ALLOW_RELOAD = "allow-reload"

[line 44]

[ Top ]

CACHE = "cache"

[line 39]

[ Top ]

DIR = "dir"

[line 45]

[ Top ]

EXPIRATION = "expiration"

[line 46]

[ Top ]

LOG_DIR = "logDir"

[line 43]

[ Top ]

MAIN_FILE = "main-file"

[line 36]

[ Top ]

MATCH_MODE = "match-mode"

[line 47]

[ Top ]

MATCH_MODE_ACCURACY = "accuracy"

[line 49]

[ Top ]

MATCH_MODE_PERFORMANCE = "performance"

[line 48]

[ Top ]

PARAMS = "params"

[line 42]

[ Top ]

PATCH = "patch"

[line 38]

[ Top ]

PATCHES = "patches"

[line 37]

[ Top ]

PERSISTENCE = "persistence"

[line 40]

[ Top ]

PROVIDER = "provider"

[line 41]

[ Top ]

WURFL = "wurfl"

[line 35]

[ Top ]

Documentation generated on Fri, 30 Mar 2012 17:16:58 -0400 by phpDocumentor 1.4.4