phpDocumentor Developer
[ class tree: Developer ] [ index: Developer ] [ all elements ]

Class: Options

Source Location: /core/Options.php

Class Options

Class Overview

The Options class contains convenience functions around option handling. It is implemented as a singleton to prevent excessive DB requests; its content never changes during a script run.

Located in /core/Options.php [line 30]



		
				Author(s):
		
		
		
Information Tags:

Methods

[ Top ]
Method Summary
static Options   instance()   Returns the handle to the (only) instance of this class.
array   availableOptions()   This function lists all known options. If called with the optional parameter $class_name, only options of that class are returned, otherwise the full set of all known attributes.
array   optionType()   This function returns the properties of a given attribute name. This currently means it returns its type and its flag field ("ML").
void   __clone()   Prevent cloning - this is a singleton.

[ Top ]
Methods
static method instance  [line 58]

  static Options instance( )

Returns the handle to the (only) instance of this class.


API Tags:
Access:  public


[ Top ]
availableOptions  [line 100]

  array availableOptions( [string $class_name = 0]  )

This function lists all known options. If called with the optional parameter $class_name, only options of that class are returned, otherwise the full set of all known attributes.

Parameters:
string   $class_name:  optionally specifies the class of options to be listed (class is the part of the option name before the : sign)

API Tags:
Return:  of options
Access:  public


[ Top ]
optionType  [line 125]

  array optionType( string $optionname  )

This function returns the properties of a given attribute name. This currently means it returns its type and its flag field ("ML").

Parameters:
string   $optionname:  Name of the option whose properties are to be retrieved.

API Tags:
Return:  properties of the attribute
Access:  public


[ Top ]
__clone  [line 70]

  void __clone( )

Prevent cloning - this is a singleton.


API Tags:
Access:  public


[ Top ]

Documentation generated on Tue, 06 Oct 2015 06:11:17 +0000 by phpDocumentor 1.4.4