Alpha Framework alpha--util
[ class tree: alpha--util ] [ index: alpha--util ] [ all elements ]

Class: AlphaConfig

Source Location: /util/AlphaConfig.inc

Class AlphaConfig

Class Overview

A singleton config class

Located in /util/AlphaConfig.inc [line 48]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: AlphaAgentUtils.inc 1200 2010-12-21 15:45:44Z johnc $
Copyright:  

Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.

 Redistribution and use in source and binary forms, with or
 without modification, are permitted provided that the
 following conditions are met:

 * Redistributions of source code must retain the above
   copyright notice, this list of conditions and the
   following disclaimer.
 * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the
   following disclaimer in the documentation and/or other
   materials provided with the distribution.
 * Neither the name of the Alpha Framework nor the names
   of its contributors may be used to endorse or promote
   products derived from this software without specific
   prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Since:  1.0
License:  The BSD License

Methods

[ Top ]
Method Summary
static AlphaConfig   getInstance()   Get the config object instance
string   get()   Get config value
void   set()   Set config value

[ Top ]
Methods
static method getInstance  [line 78]

  static AlphaConfig getInstance( )

Get the config object instance


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
get  [line 107]

  string get( $key $key  )

Get config value

Parameters:
$key   $key:  string

API Tags:
Access:  public

Information Tags:
Throws:  IllegalArguementException
Since:  1.0

[ Top ]
set  [line 121]

  void set( $key $key, $val $val  )

Set config value

Parameters:
$key   $key:  string
$val   $val:  string

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Thu, 17 Mar 2011 16:43:07 +0000 by phpDocumentor 1.4.3