Stud.IP  trunk Revision
ExternConfig Class Reference
Inheritance diagram for ExternConfig:
Inheritance graph
Collaboration diagram for ExternConfig:
Collaboration graph

Public Member Functions

 __construct ($range_id, $module_name, $config_id='')
 
 getName ()
 
 getConfigName ()
 
 getType ()
 
 getTypeName ()
 
getConfiguration ()
 
 setConfiguration ($config)
 
 setDefaultConfiguration ($config)
 
 getParameterNames ()
 
 getAllParameterNames ()
 
 getValue ($element_name, $attribute)
 
 setValue ($element_name, $attribute, $value)
 
 getAttributes ($element_name, $tag, $second_set=false)
 
 getTag ($element_name, $tag, $second_set=false)
 
 restore ($module, $element_name='', $values='')
 
 store ()
 
 parse ()
 
 makeId ()
 
 getId ()
 
 createConfigName ($range_id)
 
 setGlobalConfig ($global_config, $registered_elements)
 
 insertConfiguration ()
 
 deleteConfiguration ()
 
 copy ($range_id)
 

Static Public Member Functions

static GetInstance ($range_id, $module_name, $config_id='')
 
static GetAllConfigurations ($range_id, $type=null)
 
static GetConfigurationMetaData ($range_id, $config_id)
 
static ExistConfiguration ($range_id, $config_id)
 
static SetStandardConfiguration ($range_id, $config_id)
 
static DeleteAllConfigurations ($range_id)
 
static GetInfo ($range_id, $config_id)
 
static GetGlobalConfiguration ($range_id)
 
static ChangeName ($range_id, $module_type, $config_id, $old_name, $new_name)
 
static GetConfigurationByName ($range_id, $module_type, $name)
 
static GetStandardConfiguration ($range_id, $type)
 
static GetInstitutesWithConfigurations ($check_view=null)
 

Data Fields

 $id = null
 
 $config = []
 
 $global_id = null
 
 $module_type
 
 $module_name
 
 $config_name
 
 $range_id
 

Protected Member Functions

 updateConfiguration ()
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $range_id,
  $module_name,
  $config_id = '' 
)
Here is the call graph for this function:

Member Function Documentation

◆ ChangeName()

static ChangeName (   $range_id,
  $module_type,
  $config_id,
  $old_name,
  $new_name 
)
static
Here is the call graph for this function:

◆ copy()

copy (   $range_id)
Here is the call graph for this function:

◆ createConfigName()

createConfigName (   $range_id)
Here is the caller graph for this function:

◆ DeleteAllConfigurations()

static DeleteAllConfigurations (   $range_id)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ deleteConfiguration()

deleteConfiguration ( )
Here is the call graph for this function:

◆ ExistConfiguration()

static ExistConfiguration (   $range_id,
  $config_id 
)
static
Here is the call graph for this function:

◆ GetAllConfigurations()

static GetAllConfigurations (   $range_id,
  $type = null 
)
static

Returns an array of meta data for all configurations of an institute

Parameters
string$range_id
string$typeoptional parameter to check the right type of the range_id (the right type of "Einrichtung" sem or fak)
Returns
array ("name" the name of the configuration, "id" the config_id, "is_default" TRUE if it is the default configuration)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAllParameterNames()

getAllParameterNames ( )

◆ getAttributes()

getAttributes (   $element_name,
  $tag,
  $second_set = false 
)
Here is the caller graph for this function:

◆ getConfigName()

getConfigName ( )

◆ getConfiguration()

& getConfiguration ( )
Here is the caller graph for this function:

◆ GetConfigurationByName()

static GetConfigurationByName (   $range_id,
  $module_type,
  $name 
)
static
Here is the call graph for this function:

◆ GetConfigurationMetaData()

static GetConfigurationMetaData (   $range_id,
  $config_id 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetGlobalConfiguration()

static GetGlobalConfiguration (   $range_id)
static
Here is the call graph for this function:

◆ getId()

getId ( )

◆ GetInfo()

static GetInfo (   $range_id,
  $config_id 
)
static
Here is the call graph for this function:

◆ GetInstance()

static GetInstance (   $range_id,
  $module_name,
  $config_id = '' 
)
static
Here is the caller graph for this function:

◆ GetInstitutesWithConfigurations()

static GetInstitutesWithConfigurations (   $check_view = null)
static
Here is the call graph for this function:

◆ getName()

getName ( )

◆ getParameterNames()

getParameterNames ( )

◆ GetStandardConfiguration()

static GetStandardConfiguration (   $range_id,
  $type 
)
static
Here is the call graph for this function:

◆ getTag()

getTag (   $element_name,
  $tag,
  $second_set = false 
)

Returns a complete HTML-tag with attributes

Here is the call graph for this function:

◆ getType()

getType ( )

◆ getTypeName()

getTypeName ( )

◆ getValue()

getValue (   $element_name,
  $attribute 
)

◆ insertConfiguration()

insertConfiguration ( )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ makeId()

makeId ( )
Here is the caller graph for this function:

◆ parse()

parse ( )
Here is the caller graph for this function:

◆ restore()

restore (   $module,
  $element_name = '',
  $values = '' 
)

Restores a configuration with all registered elements and their attributes. The restored configuration contains only the attributes of the current registered elements.

public

Parameters
object$moduleThe module whose configuration will be restored
string$element_nameThe name of the element
string[]$values These values overwrites the values in current configuration
Here is the call graph for this function:

◆ setConfiguration()

setConfiguration (   $config)

◆ setDefaultConfiguration()

setDefaultConfiguration (   $config)
Here is the call graph for this function:

◆ setGlobalConfig()

setGlobalConfig (   $global_config,
  $registered_elements 
)

◆ SetStandardConfiguration()

static SetStandardConfiguration (   $range_id,
  $config_id 
)
static
Here is the call graph for this function:

◆ setValue()

setValue (   $element_name,
  $attribute,
  $value 
)
Here is the caller graph for this function:

◆ store()

store ( )
Here is the caller graph for this function:

◆ updateConfiguration()

updateConfiguration ( )
protected
Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

◆ $config

$config = []

◆ $config_name

$config_name

◆ $global_id

$global_id = null

◆ $id

$id = null

◆ $module_name

$module_name

◆ $module_type

$module_type

◆ $range_id

$range_id

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