Document more $cfg options
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Mahara |
Fix Released
|
Medium
|
Unassigned |
Bug Description
I think it would be a great idea if we went through the code, found as many of the config options as we can (by searching for $CFG and get_config()), and made sure they were properly documented in one of three ways:
1. If it's a setting that should be hard-coded and most users will want/need to set it, put it in config-dist.php
2. If it's a setting that should be hard-coded but is experimental, advanced, or less likely to be used, put it in lib/config-
3. Or give it a UI front-end setting on the Admin pages. But keep in mind possible security implications -- anything settable by the UI can be abused by XSS, so for instance filesystem paths should not be set in the UI because that makes a handy escalation from XSS to filesystem.
summary: |
- Document more $cfg options in config-dist.php + Document more $cfg options |
description: | updated |
description: | updated |
Changed in mahara: | |
milestone: | 1.8rc1 → 1.8.0 |
Changed in mahara: | |
status: | Triaged → In Progress |
milestone: | 1.8.0 → 1.9.0 |
summary: |
- Document more $cfg options + [Ongoing] Document more $cfg options |
Changed in mahara: | |
milestone: | 1.9.0 → 1.10.0 |
summary: |
- [Ongoing] Document more $cfg options + Document more $cfg options |
Changed in mahara: | |
milestone: | none → 15.04.0 |
Changed in mahara: | |
status: | Fix Committed → Fix Released |
milestone: | 15.04.0 → none |
Reviewed: https:/ /reviews. mahara. org/2251 gitorious. org/mahara/ mahara/ commit/ 46aba6b4dc2e2a2 576826be6cc5bab 28fed7a355
Committed: http://
Submitter: Son Nguyen (<email address hidden>)
Branch: master
commit 46aba6b4dc2e2a2 576826be6cc5bab 28fed7a355
Author: Aaron Wells <email address hidden>
Date: Thu May 30 11:03:16 2013 +1200
Removing $cfg->themeprefs because it has been replaced by $cfg->sitetheme prefs
Bug #1185297: The $cfg->themeprefs setting was removed in bug #793308
Change-Id: Ifcea19569d62ee b03cb26e098d74a b4d535f61e3
Signed-off-by: Aaron Wells <email address hidden>