3.5.2.11. Preferences
File: classes/Preferences.php
The Preferences class provides support for preferences. Preferences are organized by
site, name, item, and index. Name is alphanumeric while item and index are numeric.
Preference names that start with "$" or "EWE" are reserved for EWE usage.
3.5.2.11.1. get_preference
Format: result = get_preference(int,site,module,name,item=0,index=0)
where "int" is 1 if this is an integer value, or 0 otherwise. "site" is the site,
"module" is the module, "name" is the the preference name, "item" is the item number,
and "index" is the index number.
Example: $result = $prefs->get_preference(0,$site,$module,$name,0,0);
This method returns the specified preference value.
3.5.2.11.2. get_preference_int
Format: result = get_preference_int(site,module,name,item=0,index=0)
where "int" is 1 if this is an integer value, or 0 otherwise. "site" is the site,
"module" is the module, "name" is the the preference name, "item" is the item number,
and "index" is the index number.
Example: $result = $prefs->get_preference_int($site,$module,$name,0,0);
This method returns the specified integer preference value.
3.5.2.11.3. get_preference_str
Format: result = get_preference_str(site,module,name,item=0,index=0)
where "site" is the site,
"module" is the module, "name" is the the preference name, "item" is the item number,
and "index" is the index number.
Example: $result = $prefs->get_preference_str($site,$module,$name,0,0);
This method returns the specified string preference value.
3.5.2.11.4. get_preference_set
Format: result = get_preference_set(int,site,module,name,item=0)
where "int" is 1 for an integer, or 0 for a string. "site" is the site,
"module" is the module, "name" is the the preference name, and "item" is the item number.
Example: $result = $prefs->get_preference_set(1,$site,$module,$name,0);
This method returns an array of all preferences matching the site, module, name, item, and ordered by index.
3.5.2.11.5. get_preference_set_int
Format: result = get_preference_set_int(site,module,name,item=0)
where "site" is the site,
"module" is the module, "name" is the the preference name, and "item" is the item number.
Example: $result = $prefs->get_preference_set_int($site,$module,$name,0);
This method returns an array of all integer preferences matching the site, module, name, item, and ordered by index.
3.5.2.11.6. get_preference_set_str
Format: result = get_preference_set_str(site,module,name,item=0)
where "site" is the site,
"module" is the module, "name" is the the preference name, and "item" is the item number.
Example: $result = $prefs->get_preference_set_str($site,$module,$name,0);
This method returns an array of all string preferences matching the site, module, name, item, and ordered by index.
3.5.2.11.7. set_preference
Format: result = set_preference(site,module,name,item,index=0,ivalue=0,svalue='')
where "site" is the site,
"module" is the module, "name" is the the preference name, "item" is the item number,
"index" is the index number, "ivalue" is an integer value, and "svalue" is a string value.
Example: $result = $prefs->set_preference($site,$module,$name,$item,0,$value,'');
This method sets a preference value. If it exists, it is changed. If it does not exist, it is created.