Settings Class Reference

If this file is called directly, abort. More...

Inheritance diagram for Settings:

Public Member Functions
	__construct ( $settings=array())
	Create with new. More...
	all ()
	Returns all the objects in this collection as an an array. More...
	get ( $key, $default=null)
	Set an setting. More...
	set ( $key, $value)
	Set a setting. More...
	update ( $settings)
	Mass update values from the allowed ones. More...

Private Attributes
	$settings = array()

Detailed Description

If this file is called directly, abort.

A generic Settings base class.

Definition at line 12 of file class-gv-settings.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$settings = array()

)

Create with new.

Since

2.0

Parameters

array

$settings

Initial settings. Default: none.

Returns

Definition at line 27 of file class-gv-settings.php.

References $settings.

Member Function Documentation

all()

all

(

)

Returns all the objects in this collection as an an array.

Since

2.0

Returns

array The objects in this collection.

Definition at line 84 of file class-gv-settings.php.

References $settings.

get()

get	(		$key,
			$default = null
	)

Set an setting.

Parameters

mixed	$key	The key in this setting to retrieve.
mixed	$default	A default in case the key is not set.

Since

2.0

Returns

mixed|null

Definition at line 73 of file class-gv-settings.php.

set()

set	(		$key,
			$value
	)

Set a setting.

Parameters

mixed	$key	The key the value should be added under.
mixed	$value	The value to be added to the key.

Since

2.0

Returns

void

Definition at line 59 of file class-gv-settings.php.

References $value.

update()

update

(

$settings

)

Mass update values from the allowed ones.

Since

2.0

Parameters

array

$settings

An array of settings to update.

Returns

self chain.

Definition at line 42 of file class-gv-settings.php.

References $settings, and $value.

Field Documentation

$settings

$settings = array()

private

Definition at line 16 of file class-gv-settings.php.

---

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

• class-gv-settings.php