BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
BlueSpice\ConfigDefinition Class Reference
Inheritance diagram for BlueSpice\ConfigDefinition:
Collaboration diagram for BlueSpice\ConfigDefinition:

Public Member Functions

 __construct ($context, $config, $name)
 
 getValue ()
 
 getConfig ()
 
 getName ()
 
 getVariableName ()
 
 getPaths ()
 
 isRLConfigVar ()
 
- Public Member Functions inherited from BlueSpice\ISetting
 getHtmlFormField ()
 
 getLabelMessageKey ()
 

Static Public Member Functions

static getInstance ($context, $config, $name)
 

Protected Member Functions

 makeFormFieldParams ()
 
 makeID ()
 

Protected Attributes

 $context = null
 
 $config = null
 
 $name = ''
 

Additional Inherited Members

- Public Attributes inherited from BlueSpice\ISetting
const MAIN_PATH_TYPE = 'type'
 
const MAIN_PATH_EXTENSION = 'extension'
 
const MAIN_PATH_PACKAGE = 'package'
 
const TYPE_SYSTEM = 'system'
 
const TYPE_INTERFACE = 'interface'
 
const TYPE_EDIT = 'edit'
 
const TYPE_SEARCH = 'search'
 

Constructor & Destructor Documentation

BlueSpice\ConfigDefinition::__construct (   $context,
  $config,
  $name 
)
Parameters
\Context$context
\Config$config
string$name

Member Function Documentation

BlueSpice\ConfigDefinition::getConfig ( )
Returns
static BlueSpice\ConfigDefinition::getInstance (   $context,
  $config,
  $name 
)
static
Parameters
\Context$context
\Config$config
string$name
Returns
ConfigDefinition
BlueSpice\ConfigDefinition::getName ( )
Returns
string
BlueSpice\ConfigDefinition::getPaths ( )
Returns
array An array of paths that define where to provide an input field within the settings UI. E.g. [ 'type/interface', 'extension/<extensionX>', 'package/<packageX>' ] ATTENTION: Path elements need a message key to be available following the pattern 'bs-setting-path-<elementName>'. E. g. 'bs-setting-path-<extensionX>'

Implements BlueSpice\ISetting.

BlueSpice\ConfigDefinition::getValue ( )
Returns
mixed
BlueSpice\ConfigDefinition::getVariableName ( )
Returns
string

Implements BlueSpice\ISetting.

BlueSpice\ConfigDefinition::isRLConfigVar ( )

Returns if the config is a ResourceLoader variable

Returns
boolean

The documentation for this class was generated from the following file: