KVarBase Class Reference

Base class for storing variables. More...

Inheritance diagram for KVarBase:

Public Member Functions
	__destruct ()
	getPropertyName ($name)
	Translates the name...
	addFieldMaps ($map)
	Adds field mappings in the form of field_name => proper_field_name.
	__set ($name, $value)
	__get ($name)
	__isset ($name)
	__unset ($name)
	set ($name, $value)
	append ($name, $value)
	setRef ($name, &$value)
	merge ($name, $value)
	reset ($name, $useDefault=true)
	Resets specified property.
	exists ($name)
	get ($name, $default=null)
&	getRef ($name)
	importArray ($data, $merge=false)
&	getProperties ($exclude=false)
	Returns all properties as hashmap.
	getDefault ($name)
	Returns default value for specified property.
	hasDefault ($name)
	clearProperties ($exclude=false)
	Clears all properties.
Protected Member Functions
	__construct ()
Protected Attributes
	$fieldMap = array()

---

Detailed Description

Base class for storing variables.

Shouldn't be used on it's own...

It allows for predeclared variables to coexist with dynamic ones, with unified get/set functions.

Field names are translated by getFieldName()

If you get/set undeclared variable directly, it'll be fed through get() / set() functions.

---

Constructor & Destructor Documentation

KVarBase::__construct

(

)

[protected]

Reimplemented in KWebSetting, KSetting, KVar, and KWebSession.

KVarBase::__destruct

(

)

Reimplemented in KWebSetting, KSetting, KVar, KWebSession, and KDBSettings.

---

Member Function Documentation

KVarBase::__get

(

$

name

)

KVarBase::__isset

(

$

name

)

KVarBase::__set	(	$	name,
		$	value
	)

KVarBase::__unset

(

$

name

)

KVarBase::addFieldMaps

(

$

map

)

Adds field mappings in the form of field_name => proper_field_name.

field_name and proper_field_name should only contain [a-zA-Z0-9_] characters!

Parameters:

unknown_type

$map

KVarBase::append	(	$	name,
		$	value
	)

Reimplemented in KDBSettings.

KVarBase::clearProperties

(

$

exclude = false

)

Clears all properties.

Parameters:

array

$exclude

List of property names to exclude

KVarBase::exists

(

$

name

)

KVarBase::get	(	$	name,
		$	default = null
	)

KVarBase::getDefault

(

$

name

)

Returns default value for specified property.

& KVarBase::getProperties

(

$

exclude = false

)

Returns all properties as hashmap.

Parameters:

array

$exclude

List of property names to exclude

KVarBase::getPropertyName

(

$

name

)

Translates the name...

Special characters like ' !#$%^&*()-+=[].,' are all changed to '_'

• If the variable is already declared on the object - the name is returned as is.
• If there is a fieldMap entry - it's returned
• If there is a fieldMap for lowercased name - it's returned
• Otherwise lower case name is returned

Reimplemented in KDBSettings_strings.

& KVarBase::getRef

(

$

name

)

KVarBase::hasDefault

(

$

name

)

KVarBase::importArray	(	$	data,
		$	merge = false
	)

Reimplemented in KWebSession, and KDBSettings.

KVarBase::merge	(	$	name,
		$	value
	)

KVarBase::reset	(	$	name,
		$	useDefault = true
	)

Resets specified property.

If useDefault is TRUE, class's default value will be used, otherwise, the value will be unset

Reimplemented in KWebSession, and KDBSettings.

KVarBase::set	(	$	name,
		$	value
	)

Reimplemented in KWebSession, and KDBSettings.

KVarBase::setRef	(	$	name,
		&$	value
	)

Reimplemented in KWebSession, and KDBSettings.

---

Field Documentation

KVarBase::$fieldMap = array() [protected]

---

The documentation for this class was generated from the following file:

• include/core/KVar.php