Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
RangeConfig Class Reference
Inheritance diagram for RangeConfig:
Config CourseConfig InstituteConfig UserConfig

Public Member Functions

 __construct ($range_id=null, $data=null)
 
 getRangeId ()
 
 getValue ($field)
 
 unsetValue ($field)
 
 store ($field, $value)
 
 create ($field, $data=[])
 
 delete ($field)
 
- Public Member Functions inherited from Config
 __construct ($data=null)
 
 getFields ($range=null, $section=null, $name=null)
 
 getMetadata ($field)
 
 getValue ($field)
 
 setValue ($field, $value)
 
 getIterator ()
 
 __get ($field)
 
 __set ($field, $value)
 
 __isset ($field)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 count ()
 
 store ($field, $data)
 
 create ($field, $data=[])
 
 delete ($field)
 
 convertFromDatabase ($type, $value, $field)
 
 convertForDatabase ($type, $value, $field)
 

Static Public Member Functions

static get ()
 
static set ()
 
- Static Public Member Functions inherited from Config
static get ()
 
static getInstance ()
 
static set ()
 

Data Fields

const RANGE_TYPE = 'range'
 

Protected Member Functions

 fetchData ($data=null)
 
 getI18NIdentifier ($field)
 
- Protected Member Functions inherited from Config
 fetchData ($data=null)
 
 getI18NIdentifier ($field)
 

Static Protected Attributes

static $instances = []
 

Additional Inherited Members

- Protected Attributes inherited from Config
 $data = []
 
 $metadata = []
 

Constructor & Destructor Documentation

__construct (   $range_id = null,
  $data = null 
)
final

passing null as first param is for compatibility and should be considered deprecated. passing data array as second param only for testing

Parameters
string$range_id
array$data

Member Function Documentation

create (   $field,
  $data = [] 
)

{}

delete (   $field)

{}

fetchData (   $data = null)
protected

{}

static get ( )
static

returns cached instance for given range_id creates new objects if needed

Parameters
string$range_id
Returns
RangeConfig
getI18NIdentifier (   $field)
protected

{}

getRangeId ( )

returns the range id

Returns
string
getValue (   $field)
See Also
lib/classes/Config::getValue()
static set ( )
static

set cached instance for given range_id use for testing or to unset cached instance by passing null as second param

Parameters
string$range_id
RangeConfig$my_instance
store (   $field,
  $value 
)
See Also
lib/classes/Config::store()
unsetValue (   $field)
Parameters
string$field
Returns
bool

Field Documentation

$instances = []
staticprotected
const RANGE_TYPE = 'range'

range type


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