]> git.mxchange.org Git - mailer.git/blobdiff - inc/libs/register_functions.php
Code style changed, ext-user continued:
[mailer.git] / inc / libs / register_functions.php
index 7dddc8fb29687fafbc6483cb886e8b0a736d40a2..0b8f952157f535e8a1e5fea182c7d0e0a05a1aab 100644 (file)
@@ -16,7 +16,7 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
+ * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
  * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -40,10 +40,10 @@ if (!defined('__SECURITY')) {
        die();
 } // END - if
 
-//
+// Checks whether all required registration fields are set
 function ifRequiredRegisterFieldsAreSet (&$array) {
        // By default all is fine
-       $ret = true;
+       $ret = TRUE;
        foreach ($array as $key => $value) {
                // Check all fields that must register
                $result = SQL_QUERY_ESC("SELECT `id` FROM `{?_MYSQL_PREFIX?}_must_register` WHERE `field_name`='%s' AND `field_required`='Y' LIMIT 1",
@@ -55,10 +55,10 @@ function ifRequiredRegisterFieldsAreSet (&$array) {
                        // if extensions is present check if country code was selected
                        //         01              2         21    12             3         32    234     5      54    4               43    34                      4    4      5      5432    2      3                      3210
                        $country = ((!isExtensionActive('country')) || ((isExtensionActive('country')) && (((empty($value)) && ($key == 'cntry')) || (($key == 'country_code') && (!empty($value)))) && (!empty($array['country_code']))));
-                       if ((empty($value)) && ($country === false)) {
+                       if ((empty($value)) && ($country === FALSE)) {
                                // Required field not set
                                $array[$key] = '!';
-                               $ret = false;
+                               $ret = FALSE;
                        } // END - if
                } // END - if
 
@@ -71,19 +71,31 @@ function ifRequiredRegisterFieldsAreSet (&$array) {
 }
 
 // Generates a 'category table' for the registration form
-function registerGenerateCategoryTable ($mode) {
+function registerGenerateCategoryTable ($mode, $configEntry = 'register_default') {
        // Init output
        $OUT = '';
 
-       // Guests are mostly not interested in how many members has
-       // choosen an individual category
+       /*
+        * Guests are mostly not interested in how many members has choosen an
+        * individual category.
+        */
        $whereStatement = "WHERE `visible`='Y' ";
 
        // Admins are allowed to see every category...
-       if (isAdmin()) $whereStatement = '';
+       if (isAdmin()) {
+               $whereStatement = '';
+       } // END - if
 
        // Look for categories
-       $result = SQL_QUERY('SELECT `id`,`cat`,`visible` FROM `{?_MYSQL_PREFIX?}_cats` ' . $whereStatement . ' ORDER BY `sort` ASC',
+       $result = SQL_QUERY('SELECT
+       `id`,
+       `cat`,
+       `visible`
+FROM
+       `{?_MYSQL_PREFIX?}_cats`
+' . $whereStatement . '
+ORDER BY
+       `sort` ASC',
                __FUNCTION__, __LINE__);
 
        if (!SQL_HASZERONUMS($result)) {
@@ -95,14 +107,14 @@ function registerGenerateCategoryTable ($mode) {
                        $content['default_no']  = '';
 
                        // Mark categories
-                       if ((postRequestElement('cat', $content['id']) == 'Y') || ((isRegisterDefaultEnabled()) && (!isPostRequestElementSet('cat', $content['id'])))) {
+                       if ((postRequestElement('cat', $content['id']) == 'Y') || ((getConfig($configEntry) == 'Y') && (!isPostRequestElementSet('cat', $content['id'])))) {
                                $content['default_yes'] = ' checked="checked"';
                        } else {
                                $content['default_no']  = ' checked="checked"';
                        }
 
                        // Load template and switch color
-                       $OUT .= loadTemplate('guest_cat_row', true, $content);
+                       $OUT .= loadTemplate('guest_cat_row', TRUE, $content);
                } // END - while
                $OUT .= '</table>';
 
@@ -110,7 +122,7 @@ function registerGenerateCategoryTable ($mode) {
                SQL_FREERESULT($result);
        } else {
                // No categories setted up so far...
-               $OUT .= displayMessage('{--NO_CATEGORIES_VISIBLE--}', true);
+               $OUT .= displayMessage('{--NO_CATEGORIES_VISIBLE--}', TRUE);
        }
 
        // Return generated HTML code
@@ -126,39 +138,43 @@ function registerOutputFailedMessage ($messageId, $extra='') {
        }
 }
 
-// Checks wether the registration data is complete
+// Checks whether the registration data is complete
 function isRegistrationDataComplete () {
        // Init elements
-       $GLOBALS['registration_ip_timeout']     = false;
-       $GLOBALS['registration_short_password'] = false;
+       $GLOBALS['registration_ip_timeout']     = FALSE;
+       $GLOBALS['registration_short_password'] = FALSE;
        $GLOBALS['registration_selected_cats']  = '0';
 
        // Default is okay
-       $isOkay = true;
+       $isOkay = TRUE;
 
        // First we only check the submitted data then we continue... :)
        //
-       // Did he agree to our Terms Of Usage?
+       // Did he agree to the terms of usage?
        if (postRequestElement('agree') != 'Y') {
                setPostRequestElement('agree', '!');
-               $isOkay = false;
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'agree=N - User did not agree with terms of usage.');
+               $isOkay = FALSE;
        } // END - if
 
        // Did he enter a valid email address? (we really don't care about
        // that, he has to click on a confirmation link :P )
-       if ((!isPostRequestElementSet('email')) || (!isEmailValid(postRequestElement('email')))) {
+       if ((!isAdmin()) && ((!isPostRequestElementSet('email')) || (!isEmailValid(postRequestElement('email'))))) {
                setPostRequestElement('email', '!');
-               $isOkay = false;
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'User did not enter proper email address.');
+               $isOkay = FALSE;
        } // END - if
 
        // And what about surname and family's name?
        if (!isPostRequestElementSet('surname')) {
                setPostRequestElement('surname', '!');
-               $isOkay = false;
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'User did not enter surname.');
+               $isOkay = FALSE;
        } // END - if
        if (!isPostRequestElementSet('family')) {
                setPostRequestElement('family', '!');
-               $isOkay = false;
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'User did not enter family name.');
+               $isOkay = FALSE;
        } // END - if
 
        // Get temporary array for modification
@@ -171,7 +187,7 @@ function isRegistrationDataComplete () {
        setPostRequestArray($postArray);
 
        // Are both passwords zero length?
-       if ((strlen(postRequestElement('pass1')) == 0) && (strlen(postRequestElement('pass2')) == 0) && ($isOkay === true)) {
+       if ((strlen(postRequestElement('pass1')) == 0) && (strlen(postRequestElement('pass2')) == 0) && ($isOkay === TRUE)) {
                // Is the extension 'register' newer or equal 0.5.5?
                if ((isExtensionInstalledAndNewer('register', '0.5.5')) && (isRegisterGeneratePasswordEmptyEnabled())) {
                        // Generate a random password
@@ -186,38 +202,48 @@ function isRegistrationDataComplete () {
                        setPostRequestElement('pass2', '!');
 
                        // ... which is both not okay
-                       $isOkay = false;
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Random password generation not possible, isExtensionInstalledAndNewer(register, 0.5.5)=' . intval(isExtensionInstalledAndNewer('register', '0.5.5')) . ',isRegisterGeneratePasswordEmptyEnabled()=' . intval(isRegisterGeneratePasswordEmptyEnabled()));
+                       $isOkay = FALSE;
                }
        } // END - if
 
        // Did he enter his password twice?
        if (((!isPostRequestElementSet('pass1')) || (!isPostRequestElementSet('pass2'))) || ((postRequestElement('pass1') != postRequestElement('pass2')) && (isPostRequestElementSet('pass1')) && (isPostRequestElementSet('pass2')))) {
                if ((postRequestElement('pass1') != postRequestElement('pass2')) && (isPostRequestElementSet('pass1')) && (isPostRequestElementSet('pass2'))) {
+                       // Both passwords did not match
                        setPostRequestElement('pass1', '!');
                        setPostRequestElement('pass2', '!');
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'User did not enter same passwords.');
                } else {
                        if (!isPostRequestElementSet('pass1')) {
+                               // Password 1 is empty
                                setPostRequestElement('pass1', '!');
+                               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'User did not enter pass1.');
                        } else {
+                               // Password 2 is empty
                                setPostRequestElement('pass1', '');
                        }
                        if (!isPostRequestElementSet('pass2')) {
+                               // Password 2 is empty
                                setPostRequestElement('pass2', '!');
+                               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'User did not enter pass2.');
                        } else {
+                               // Password 1 is empty
                                setPostRequestElement('pass2', '');
                        }
                }
-               $isOkay = false;
+               $isOkay = FALSE;
        } // END - if
 
        // Is the password long enouth?
-       if ((strlen(postRequestElement('pass1')) < getPassLen()) && ($isOkay === true)) {
-               $GLOBALS['registration_short_password'] = true;
-               $isOkay = false;
+       if ((strlen(postRequestElement('pass1')) < getPassLen()) && ($isOkay === TRUE)) {
+               $GLOBALS['registration_short_password'] = TRUE;
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'User did enter a short password.');
+               $isOkay = FALSE;
        } // END - if
 
        // Do this check only when no admin is logged in
-       if (is_array(postRequestElement('cat'))) {
+       if (ifPostContainsSelections('cat')) {
                // Only continue with array
                foreach (postRequestElement('cat') as $id => $answer) {
                        // Is this category choosen?
@@ -228,85 +254,59 @@ function isRegistrationDataComplete () {
        } // END - if
 
        // Enougth categories selected?
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isOkay='.intval($isOkay).',selected='.$GLOBALS['registration_selected_cats'].'/'.getLeastCats());
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isOkay=' . intval($isOkay) . ',selected=' . $GLOBALS['registration_selected_cats'] . '/' . getLeastCats());
        $isOkay = (($isOkay) && ($GLOBALS['registration_selected_cats'] >= getLeastCats()));
 
        if ((postRequestElement('email') != '!') && (isCheckDoubleEmailEnabled())) {
                // Does the email address already exists in our database?
                if ((isEmailTaken(postRequestElement('email'))) && (!isAdmin())) {
                        setPostRequestElement('email', '?');
-                       $isOkay = false;
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'User did enter a already used email address.');
+                       $isOkay = FALSE;
                } // END - if
        } // END - if
 
        // Check for IP timeout?
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isOkay='.intval($isOkay));
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isOkay=' . intval($isOkay));
        if ((!isAdmin()) && (getIpTimeout() > 0)) {
                // Check his IP number
-               $GLOBALS['registration_ip_timeout'] = (countSumTotalData(detectRemoteAddr()  , 'user_data', 'userid', 'REMOTE_ADDR', true, ' AND ((UNIX_TIMESTAMP() - `joined`) < {?ip_timeout?} OR (UNIX_TIMESTAMP() - `last_update`) < {?ip_timeout?})') == 1);
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isOkay='.intval($isOkay).',timeout='.intval($GLOBALS['registration_ip_timeout']));
+               $GLOBALS['registration_ip_timeout'] = (countSumTotalData(detectRemoteAddr()  , 'user_data', 'userid', 'REMOTE_ADDR', TRUE, ' AND ((UNIX_TIMESTAMP() - `joined`) < {?ip_timeout?} OR (UNIX_TIMESTAMP() - `last_update`) < {?ip_timeout?})') == 1);
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isOkay=' . intval($isOkay).',timeout='.intval($GLOBALS['registration_ip_timeout']));
                $isOkay = (($isOkay) && (!$GLOBALS['registration_ip_timeout']));
        } // END - if
 
        // Return result
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isOkay='.intval($isOkay));
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'isOkay=' . intval($isOkay) . ' - EXIT!');
        return $isOkay;
 }
 
 // Do the registration
-function doRegistration () {
-       // Generate hash which will be inserted into confirmation mail
-       $hash = generateHash(sha1(
-               // Get total confirmed, ...
-               getTotalConfirmedUser() . getEncryptSeparator() .
-               // ... unconfirmed ...
-               getTotalUnconfirmedUser() . getEncryptSeparator() .
-               // ... and locked users
-               getTotalLockedUser() . getEncryptSeparator() .
-               postRequestElement('month') . '-' .
-               postRequestElement('day') . '-' .
-               postRequestElement('year') . getEncryptSeparator() .
-               detectServerName() . getEncryptSeparator() .
-               detectRemoteAddr() . getEncryptSeparator() .
-               detectUserAgent() . '/' .
-               getSiteKey() . '/' .
-               getDateKey() . '/' .
-               getConfig('CACHE_BUSTER')
-       ));
-
-       // Old way with enterable two-char-code
-       $countryRow = '`country`';
-       $countryData = substr(postRequestElement('cntry'), 0, 2);
-
-       // Add design when extension ext-theme is v0.0.8 or greater
-       // @TODO Rewrite these all to a single filter
-       $GLOBALS['register_sql_columns'] = '';
-       $GLOBALS['register_sql_data']    = '';
-       if (isExtensionInstalledAndNewer('theme', '0.0.8')) {
-               // Okay, add design here
-               $GLOBALS['register_sql_columns'] .= ', `curr_theme`';
-               $GLOBALS['register_sql_data']    .= ", '{%%pipe,getCurrentTheme%%}'";
+function doUserRegistration () {
+       // Do not register an account on absent ext-user
+       if (!isExtensionInstalled('user')) {
+               // Please report this
+               reportBug(__FUNCTION__, __LINE__, 'Tried to register a user account without ext-user installed.');
        } // END - if
 
-       // Check if I shall disable sending mail to newly registered members out about active/begging rallye
-       //
-       // First comes first: begging rallye
-       if ((isExtensionInstalledAndNewer('beg', '0.2.7')) && (!isBegNewMemberNotifyEnabled())) {
-               $GLOBALS['register_sql_columns'] .= ', `beg_rallye_enable_notify`, `beg_rallye_disable_notify`';
-               $GLOBALS['register_sql_data']    .= ', UNIX_TIMESTAMP(), UNIX_TIMESTAMP()';
-       } // END - if
+       // Init filter data
+       $filterData = array(
+               // Initialization not done by default
+               'init_done' => FALSE
+       );
 
-       // Second: active rallye
-       if ((isExtensionActive('bonus')) && (!isBonusNewMemberNotifyEnabled())) {
-               $GLOBALS['register_sql_columns'] .= ', `bonus_rallye_enable_notify`, `bonus_rallye_disable_notify`';
-               $GLOBALS['register_sql_data']    .= ', UNIX_TIMESTAMP(), UNIX_TIMESTAMP()';
-       } // END - if
+       // Init extra SQL data
+       initExtraRegistrationSql();
+
+       // Run the pre-registration chain
+       $filterData = runFilterChain('pre_user_registration', $filterData);
 
-       // Write user data to table
-       if (isExtensionActive('country')) {
-               // Save with new selectable country code
-               $countryRow = '`country_code`';
-               $countryData = bigintval(postRequestElement('country_code'));
+       // Did the initialization work?
+       if ($filterData['init_done'] === FALSE) {
+               // Something bad happened!
+               displayMessage('{--PRE_USER_REGISTRATION_FAILED--}');
+
+               // Stop here
+               return FALSE;
        } // END - if
 
        // Create user's account...
@@ -334,7 +334,7 @@ function doRegistration () {
        `joined`,
        `last_update`,
        `ref_payout`
-       ".$GLOBALS['register_sql_columns']."
+       " . $GLOBALS['register_sql_columns'] . "
 ) VALUES (
        '%s',
        '%s',
@@ -351,20 +351,21 @@ function doRegistration () {
        %s,
        %s,
        %s,
-       'UNCONFIRMED',
+       '%s',
        '%s',
        '{%%pipe,detectRemoteAddr%%}',
        UNIX_TIMESTAMP(),
        UNIX_TIMESTAMP(),
        {?ref_payout?}
-       ".$GLOBALS['register_sql_data'].")",
+       " . $GLOBALS['register_sql_data'] . "
+)",
        array(
-               $countryRow,
+               $GLOBALS['register_country_row'],
                substr(postRequestElement('gender'), 0, 1),
                postRequestElement('surname'),
                postRequestElement('family'),
                postRequestElement('street_nr'),
-               $countryData,
+               $GLOBALS['register_country_data'],
                bigintval(postRequestElement('zip')),
                postRequestElement('city'),
                postRequestElement('email'),
@@ -375,19 +376,20 @@ function doRegistration () {
                bigintval(postRequestElement('max_mails')),
                bigintval(postRequestElement('max_mails')),
                convertZeroToNull(postRequestElement('refid')),
-               $hash
+               postRequestElement('status'),
+               $GLOBALS['register_confirm_hash']
        ), __FUNCTION__, __LINE__);
 
        // Get his userid
-       $userid = bigintval(SQL_INSERTID());
+       $filterData['register_insert_id'] = bigintval(SQL_INSERTID());
 
        // Did this work?
-       if ($userid == '0') {
+       if (!isValidUserId($filterData['register_insert_id'])) {
                // Something bad happened!
                displayMessage('{--USER_NOT_REGISTERED--}');
 
                // Stop here
-               return;
+               return FALSE;
        } // END - if
 
        // Shall we reset random refid? Only possible with latest ext-user
@@ -397,26 +399,43 @@ function doRegistration () {
        } // END - if
 
        // Update referral table
-       updateReferralCounter($userid);
+       updateReferralCounter($filterData['register_insert_id']);
 
        // Write his welcome-points
        initReferralSystem();
-       addPointsThroughReferralSystem('register_welcome', $userid, getPointsRegister());
+       addPointsThroughReferralSystem(
+               // Subject
+               'register_welcome',
+               // New user's id
+               $filterData['register_insert_id'],
+               // Points
+               getPointsRegister(),
+               // Referral id (or NULL if none set)
+               convertZeroToNull(postRequestElement('refid'))
+       );
 
        // Write catgories
-       if ((is_array(postRequestElement('cat'))) && (count(postRequestElement('cat')))) {
+       if (ifPostContainsSelections('cat')) {
+               // Write all entries
                foreach (postRequestElement('cat') as $categoryId => $joined) {
+                       // "Join" this group?
                        if ($joined == 'Y') {
                                // Insert category entry
-                               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_cats` (`userid`,`cat_id`) VALUES (%s, %s)",
+                               SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_user_cats` (`userid`, `cat_id`) VALUES (%s, %s)",
                                        array(
-                                               $userid,
+                                               $filterData['register_insert_id'],
                                                bigintval($categoryId)
                                        ), __FUNCTION__, __LINE__);
                        } // END - if
                } // END - foreach
        } // END - if
 
+       // Registration phase is done here, so for tester accounts we end here
+       if (((getExtensionVersion('user') >= '0.5.0')) && (isTesterUserName(postRequestElement('surname'))) && (ifTesterAccountsAllowed())) {
+               // All fine here
+               return TRUE;
+       } // END - if
+
        // ... rewrite a zero referral id to the main title
        if (!isValidUserId(postRequestElement('refid'))) {
                setPostRequestElement('refid', getMainTitle());
@@ -427,8 +446,8 @@ function doRegistration () {
                // Prepare data array for the email template
                // Start with the gender...
                $content = array(
-                       'hash'     => $hash,
-                       'userid'   => $userid,
+                       'hash'     => $GLOBALS['register_confirm_hash'],
+                       'userid'   => $filterData['register_insert_id'],
                        'gender'   => SQL_ESCAPE(postRequestElement('gender')),
                        'surname'  => SQL_ESCAPE(postRequestElement('surname')),
                        'family'   => SQL_ESCAPE(postRequestElement('family')),
@@ -436,15 +455,15 @@ function doRegistration () {
                        'street'   => SQL_ESCAPE(postRequestElement('street_nr')),
                        'city'     => SQL_ESCAPE(postRequestElement('city')),
                        'zip'      => bigintval(postRequestElement('zip')),
-                       'country'  => $countryData,
+                       'country'  => $GLOBALS['register_country_data'],
                        'refid'    => SQL_ESCAPE(postRequestElement('refid')),
                        'password' => SQL_ESCAPE(postRequestElement('pass1')),
                );
        } else {
                // No ZIP code entered
                $content = array(
-                       'hash'     => $hash,
-                       'userid'   => $userid,
+                       'hash'     => $GLOBALS['register_confirm_hash'],
+                       'userid'   => $filterData['register_insert_id'],
                        'gender'   => SQL_ESCAPE(postRequestElement('gender')),
                        'surname'  => SQL_ESCAPE(postRequestElement('surname')),
                        'family'   => SQL_ESCAPE(postRequestElement('family')),
@@ -452,7 +471,7 @@ function doRegistration () {
                        'street'   => SQL_ESCAPE(postRequestElement('street_nr')),
                        'city'     => SQL_ESCAPE(postRequestElement('city')),
                        'zip'      => '',
-                       'country'  => $countryData,
+                       'country'  => $GLOBALS['register_country_data'],
                        'refid'    => SQL_ESCAPE(postRequestElement('refid')),
                        'password' => SQL_ESCAPE(postRequestElement('pass1')),
                );
@@ -470,13 +489,34 @@ function doRegistration () {
        } // END - switch
 
        // Display information to the user that he got mail and send it away
-       $messageGuest = loadEmailTemplate('guest_register_done', $content, $userid, false);
+       $messageGuest = loadEmailTemplate('guest_register_done', $content, $filterData['register_insert_id'], FALSE);
 
        // Send mail to user (confirmation link!)
-       sendEmail($userid, '{--GUEST_CONFIRM_LINK_SUBJECT--}', $messageGuest);
+       sendEmail($filterData['register_insert_id'], '{--GUEST_CONFIRM_LINK_SUBJECT--}', $messageGuest);
 
        // Send mail to admin
-       sendAdminNotification('{--ADMIN_NEW_ACCOUNT_SUBJECT--}', 'admin_register_done', $content, $userid);
+       sendAdminNotification('{--ADMIN_NEW_ACCOUNT_SUBJECT--}', 'admin_register_done', $content, $filterData['register_insert_id']);
+
+       // All fine
+       return TRUE;
+}
+
+// Initialize extra registration SQL
+function initExtraRegistrationSql () {
+       $GLOBALS['register_sql_columns'] = '';
+       $GLOBALS['register_sql_data']    = '';
+}
+
+// Add extra column for registration SQL
+function addExtraRegistrationColumns ($column) {
+       // Add column
+       $GLOBALS['register_sql_columns'] .= $column;
+}
+
+// Add extra data for registration SQL
+function addExtraRegistrationData ($data) {
+       // Add column
+       $GLOBALS['register_sql_data'] .= $data;
 }
 
 //-----------------------------------------------------------------------------
@@ -495,7 +535,7 @@ function getDisplayRefid () {
        return $GLOBALS[__FUNCTION__];
 }
 
-// Checks wether 'display_refid' is "YES"
+// Checks whether 'display_refid' is "YES"
 function isDisplayRefidEnabled () {
        // Is the cache entry set?
        if (!isset($GLOBALS[__FUNCTION__])) {
@@ -531,7 +571,7 @@ function getRegisterDefault () {
        return $GLOBALS[__FUNCTION__];
 }
 
-// Checks wether 'register_default' is "YES"
+// Checks whether 'register_default' is "YES"
 function isRegisterDefaultEnabled () {
        // Is the cache entry set?
        if (!isset($GLOBALS[__FUNCTION__])) {
@@ -555,7 +595,7 @@ function getRegisterGeneratePasswordEmpty () {
        return $GLOBALS[__FUNCTION__];
 }
 
-// Checks wether 'register_generate_password_empty' is "YES"
+// Checks whether 'register_generate_password_empty' is "YES"
 function isRegisterGeneratePasswordEmptyEnabled () {
        // Is the cache entry set?
        if (!isset($GLOBALS[__FUNCTION__])) {
@@ -567,5 +607,15 @@ function isRegisterGeneratePasswordEmptyEnabled () {
        return $GLOBALS[__FUNCTION__];
 }
 
+// ----------------------------------------------------------------------------
+//                            Template helper functions
+// ----------------------------------------------------------------------------
+
+// Template helper for generating a category selection table for admin area with given configuration entry
+function doTemplateAdminRegisterCategoryTable ($templateName, $clear = FALSE, $configEntry) {
+       // Call the inner function
+       return registerGenerateCategoryTable('admin', $configEntry);
+}
+
 // [EOF]
 ?>