Gumbo_Setting

Gumbo_List
   |
   --Gumbo_Setting

Setting Class

Author(s): Michael Luster <mluster79@yahoo.com>
License:New BSD License
Copyright:Copyright (c) 2007, iBayou, Michael Luster
Link:http://sourceforge.net/projects/phpgumbo
Version:0.0.1

Implements interfaces:

Child classes:

Inherited Methods

Class Methods

public Gumbo_Setting __construct ( [array $args] ) [line 42]

Constructor

Parameter(s):

  • (array) $args :: key=>val pairs
Overridden in child classes as:
Gumbo_Load_Setting::__construct()
Constructor

Overrides
Gumbo_List::__construct()

[ Top ]
public void add ( mixed $data, [string $key] ) [line 61]

Adds a pair value to the setting

Parameter(s):

  • (mixed) $data
  • (string) $key :: (required)
  • postcondition:  remove all non-alphanumeric (excluding underscores) characters from $key
  • throws:  Gumbo_Exception
Overridden in child classes as:
Gumbo_Load_Setting::add()
Adds a key=>value pair to the setting

Implementation of:
Gumbo_Interface_List::add()
Overrides
Gumbo_List::add()

[ Top ]
public void removeValue ( mixed $data ) [line 80]

Removes a value from the List (not used)

Parameter(s):

  • (mixed) $data
Implementation of:
Gumbo_Interface_List::removeValue()
Overrides
Gumbo_List::removeValue()

[ Top ]
public void set ( string|array $data, [mixed $val] ) [line 93]

Sets the setting values

Parameter(s):

  • (string|array) $data :: (string represents a 'key') associative array of key=>val pairs
  • (mixed) $val
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Setting::set()

[ Top ]