Class: GlobalConfig

Source Location: /class_globalconfig.php

Class Overview [line 13]


Global configuration methods.

Author(s):

  • Elpidio Latorilla

Version:

  • beta 1.0.08

Copyright:

  • 2002,2003 Elpidio Latorilla

Variables

Methods


Child classes:

TimeOut
Class for session time out routines Extends the class "GlobalConfig".

Inherited Variables

Inherited Methods



Class Details

Global configuration methods.

Note this class should be instantiated only after a "$db" adodb connector object has been established by an adodb instance

Tags:

[ Top ]


Class Variables

$condition =

[line 39]

Status variable

Type: string

Overrides:

[ Top ]

$config =

[line 34]

Configuration

Type: string

Overrides:

[ Top ]

$ok =

[line 44]

Buffer flag

Type: boolean

Overrides:

[ Top ]

$result =

[line 24]

SQL query result

Tags:

  • var - record object

Type: object adodb

Overrides:

[ Top ]

$row =

[line 29]

Current number or rows

Type: omt

Overrides:

[ Top ]

$tb = 'care_config_global'

[line 18]

Table name for encounter (admission) data

Type: string

Overrides:

[ Top ]


Class Methods

GlobalConfig

GlobalConfig GlobalConfig( array &$handler)

[line 49]

Constructor

Parameters:

  • array &$handler - Configuration handler. By reference.

[ Top ]

getConfig

mixed getConfig( [string $type = ''])

[line 62]

Gets (a) global configuration value(s) of (a) configuration item(s).

The item to be fetched is passed as parameter. This could contain the % wild card where in such case all values of the configuration items that fit the type will be fetched and stored in the array. The array must be passed by reference to the class's constructor.

Tags:

  • return - string or boolean
  • access - public

Parameters:

  • string $type - Configuration item to be fetched.

[ Top ]

getConfigValue

string getConfigValue( [string $type = ''])

[line 143]

Gets a global config value of a config item supplied as parameter.

The configuration item CANNOT contain a wildcard. This method returns the value of only one single configuration item.

Parameters:

  • string $type - Configuration item to be fetched.

[ Top ]

saveConfigArray

boolean saveConfigArray( array &$data_array, [string $filter = ''], [boolean $numeric = FALSE], [int $def_value = ''], [boolean $addslash = FALSE])

[line 119]

Saves configuration values stored in an associative array.

The array's index key is the configuration item while its value is the configuration value.

If param $numeric is true, value will be checked if numeric or not (no = default value stored, yes= value stored) If param $numeric is false, value will be considered as is.

Parameters:

  • array &$data_array - Configuration values
  • string $filter - Filter string used for indentifying the array's index intended for storing
  • boolean $numeric - Flag if value is numeric or not
  • int $def_value - Default value used if param $numeric is TRUE and value is not numeric
  • boolean $addslash - Flag to add slashes. If TRUE, slashes will be added to the value

[ Top ]

saveConfigItem

boolean saveConfigItem( [string $type = ''], [mixed $value = ''])

[line 90]

Saves a global configuration value to its configuration item.

Tags:

  • access - public

Parameters:

  • string $type - Configuration item
  • mixed $value - Configuration value

[ Top ]


Documentation generated on Sun, 16 Nov 2003 01:02:46 +0100 by phpDocumentor 1.2.3