ClassInterface FOFConfigDomainInterface

Description

The Interface of an FOFConfigDomain class. The methods are used to parse and privision sensible information to consumers. FOFConfigProvider acts as an adapter to the FOFConfigDomain classes.

  • since: 2.1

Located in /libraries/fof/config/domain/interface.php (line 19)


	
			
Method Summary
 mixed get (string &$configuration, string $var, mixed $default)
 void parseDomain (SimpleXMLElement $xml, array &$ret)
Methods
get (line 40)

Return a configuration variable

  • return: The variable's value
  • access: public
mixed get (string &$configuration, string $var, mixed $default)
  • string &$configuration: Configuration variables (hashed array)
  • string $var: The variable we want to fetch
  • mixed $default: Default value
parseDomain (line 29)

Parse the XML data, adding them to the $ret array

  • access: public
void parseDomain (SimpleXMLElement $xml, array &$ret)
  • SimpleXMLElement $xml: The XML data of the component's configuration area
  • array &$ret: The parsed data, in the form of a hash array

Documentation generated on Tue, 19 Nov 2013 15:05:49 +0100 by phpDocumentor 1.4.3