Constants

Luna’s code makes use of constants in order to define certain set values that are used throughout the code (pre-defined constants) as well as for several configuration settings (user-defined constants).

Pre-defined constants

Pre-defined constants allow Luna to associate a value with a descriptive string in order to facilitate the common use of the value / simplify the process of changing that value throughout the code. A reference of such constants is provided below. The constants are grouped by the version of the software they exist in. They are given along with their value and a description of what they are/how to use them.

FORUM_UNVERIFIED

The group ID given to users when email verification of registrations is enabled.

FORUM_ADMIN

The group ID given to administrators.

FORUM_MOD

The group ID given to moderators. This is the default moderator group, but it is possible that it could be changed or other groups could have moderator permissions. Checking against this constant is no longer valid to confirm a group has moderator permissions. It has been left for backwards compatibility with modifications designed for Luna v1.2.

FORUM_GUEST

The group ID given to the Guest user.

FORUM_MemBER

The group ID given to users in the default member group.

FORUM_VERSION

The current version of Luna.

FORUM_DB_REVISION

The current database structure revision number (since not every new version changes the database).

User-defined constants

Luna’s code uses several constants that, when defined, modify its behavior. Most of these constants do not ever need to be used by the average user. However, some are useful for debugging and others are important for advanced users. A reference is provided below for those users who may want/need to use these constants. The constants are given along a description of what they do/how to use them.

All constants (with the exception of per-page constants, i.e. FORUM_ROOT) should be defined at the bottom of the configuration file (config.php).

FORUM_ROOT

FORUM_ROOT is the relative path from the current folder to the folder where the Luna code resides. You should never need to define this constant yourself unless you are writing pages that use Luna / integrating Luna with another piece of software.

define('FORUM_ROOT', './');  require FORUM_ROOT.'include/common.php';

FORUM_DEBUG

Defining FORUM_DEBUG enables debug mode, which makes Luna display more detailed/sensitive error messages. Script generation time and number of queries executed will also be shown in the footer. Debug mode should not be enabled on a production site, since it can potentially give a malicious user sensitive information about a server. However, enabling debug mode is an integral step to reporting/diagnosing forum errors. Without the information it provides, it can be nearly impossible for the developers to figure out the underlying cause of an issue.

define('FORUM_DEBUG', 1);

FORUM_SHOW_QUERIES

Defining FORUM_SHOW_QUERIES makes all the queries executed during a pageview display in the footer. This feature is only useful for developing and should never be used in a production environment because of the potential for disclosure of sensitive information.

define('FORUM_SHOW_QUERIES', 1);

FORUM_TURN_OFF_MAINT

define('FORUM_TURN_OFF_MAINT', 1);

define('FORUM_DISABLE_BUFFERING', 1);

define('FORUM_CACHE_DIR', '/tmp/fluxbb_cache/');

define('FORUM_NO_SET_NAMES', 1);

define('FORUM_BEHIND_REVERSE_PROXY', 1);

define('FORUM_MAX_COOKIE_SIZE', 4048); // default, decrease as you see fit

define('FORUM_DISABLE_STRIPSLASHES', 1);