Class NarutoOptions

Description

This class stores a options array in an object. This is used to pass this sata between methods.

Located in /classes/narutoOptions.php (line 16)


	
			
Method Summary
NarutoOptions NarutoOptions ([array $options = null])
void clearOptions ()
mixed getOption (string $option, [mixed $default_val = null])
array getOptions ()
boolean setOption (string $option, mixed $value)
boolean setOptions (array $options)
Methods
Constructor NarutoOptions (line 24)

Constructor

  • access: public
NarutoOptions NarutoOptions ([array $options = null])
  • array $options: map of initial options.
clearOptions (line 101)

Removes all options.

  • access: public
void clearOptions ()
getOption (line 39)

Returns the value of a option. The value will be a string or numeric.

  • return: the value found or the value of $default_val if not found.
  • access: public
mixed getOption (string $option, [mixed $default_val = null])
  • string $option: The proprty being set.
  • mixed $default_val: The value to use is the option is not found.
getOptions (line 77)

Returns all of the options.

  • return: the option map
  • access: public
array getOptions ()
setOption (line 54)

Adds or updates a option. The value has to be a string or numeric.

  • return: true if option was set
  • access: public
boolean setOption (string $option, mixed $value)
  • string $option: The proprty being set.
  • mixed $value: The value to set the peoperty to. Value "null" will remove option.
setOptions (line 89)

Sets all of the options at once removing all existing options.

  • return: true if every option was set, false if at least one option was not.
  • access: public
boolean setOptions (array $options)
  • array $options: the option map to use.

Documentation generated on Sun, 26 Oct 2008 16:41:15 -0400 by phpDocumentor 1.4.2