CORE POS - IS4C
The CORE POS front end
Static Public Member Functions | List of all members
CoreLocal Class Reference

Static Public Member Functions

static get ($key)
 
static set ($key, $val, $immutable=false)
 
static refresh ()
 
static migrateSettings ()
 
static convertIniPhpToJson ()
 
static readIniPhp ()
 
static readIniJson ()
 
static setHandler ($m)
 
static isImmutable ($key)
 
static iteratorKeys ()
 

Member Function Documentation

static CoreLocal::convertIniPhpToJson ( )
static

Read the settings from ini.php and return an equivalent JSON string

static CoreLocal::get (   $key)
static

Get value from session

Parameters
$key[string] variable name
static CoreLocal::isImmutable (   $key)
static

Check whether the given variable is immutable

Parameters
$key[string] variable name
Returns
[boolean]

Only here for unit test compatibility

static CoreLocal::iteratorKeys ( )
static

Get list of stored variable names

Returns
[array] of variable names

LocalStorage objects implement the Iterator interface. This method helps the WrappedStorage class that provides backward compatibillity between $CORE_LOCAL and CoreLocal meet the interface requirements.

static CoreLocal::migrateSettings ( )
static

Examine configuration file. Extract settings that do not belong in the configuration file, write them to opdata.parameters, then remove them from the configuration file

static CoreLocal::readIniJson ( )
static

Read settings from ini.json

Returns
[LocalStorage object] containing the settings
static CoreLocal::readIniPhp ( )
static

Read settings from ini.php

Returns
[LocalStorage object] containing the settings
static CoreLocal::refresh ( )
static

Re-read values from config file

static CoreLocal::set (   $key,
  $val,
  $immutable = false 
)
static

Set value in session

Parameters
$key[string] variable name
$val[mixed] variable value
$immutable[boolean, optional]
Returns
[mixed] variable value OR empty string if variable does not exist
static CoreLocal::setHandler (   $m)
static

Set the LocalStorage class used for storing session values

Parameters
$m[string] class name

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