File Sources/Help.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171:

<?php

/**
 * This file has the important job of taking care of help messages and the help center.
 *
 * Simple Machines Forum (SMF)
 *
 * @package SMF
 * @author Simple Machines https://www.simplemachines.org
 * @copyright 2020 Simple Machines and individual contributors
 * @license https://www.simplemachines.org/about/smf/license.php BSD
 *
 * @version 2.1 RC2
 */

if (!defined('SMF'))
    die('No direct access...');

/**
 * Redirect to the user help ;).
 * It loads information needed for the help section.
 * It is accessed by ?action=help.
 *
 * @uses Help template and Manual language file.
 */
function ShowHelp()
{
    loadTemplate('Help');
    loadLanguage('Manual');

    $subActions = array(
        'index' => 'HelpIndex',
        'rules' => 'HelpRules',
    );

    // CRUD $subActions as needed.
    call_integration_hook('integrate_manage_help', array(&$subActions));

    $sa = isset($_GET['sa'], $subActions[$_GET['sa']]) ? $_GET['sa'] : 'index';
    call_helper($subActions[$sa]);
}

/**
 * The main page for the Help section
 */
function HelpIndex()
{
    global $scripturl, $context, $txt;

    // We need to know where our wiki is.
    $context['wiki_url'] = 'https://wiki.simplemachines.org/smf';
    $context['wiki_prefix'] = 'SMF2.1:';

    $context['canonical_url'] = $scripturl . '?action=help';

    // Sections were are going to link...
    $context['manual_sections'] = array(
        'registering' => 'Registering',
        'logging_in' => 'Logging_In',
        'profile' => 'Profile',
        'search' => 'Search',
        'posting' => 'Posting',
        'bbc' => 'Bulletin_board_code',
        'personal_messages' => 'Personal_messages',
        'memberlist' => 'Memberlist',
        'calendar' => 'Calendar',
        'features' => 'Features',
    );

    // Build the link tree.
    $context['linktree'][] = array(
        'url' => $scripturl . '?action=help',
        'name' => $txt['help'],
    );

    // Lastly, some minor template stuff.
    $context['page_title'] = $txt['manual_smf_user_help'];
    $context['sub_template'] = 'manual';
}

/**
 * Displays forum rules
 */
function HelpRules()
{
    global $context, $txt, $boarddir, $user_info, $scripturl;

    // Build the link tree.
    $context['linktree'][] = array(
        'url' => $scripturl . '?action=help',
        'name' => $txt['help'],
    );
    $context['linktree'][] = array(
        'url' => $scripturl . '?action=help;sa=rules',
        'name' => $txt['terms_and_rules'],
    );

    // Have we got a localized one?
    if (file_exists($boarddir . '/agreement.' . $user_info['language'] . '.txt'))
        $context['agreement'] = parse_bbc(file_get_contents($boarddir . '/agreement.' . $user_info['language'] . '.txt'), true, 'agreement_' . $user_info['language']);
    elseif (file_exists($boarddir . '/agreement.txt'))
        $context['agreement'] = parse_bbc(file_get_contents($boarddir . '/agreement.txt'), true, 'agreement');
    else
        $context['agreement'] = '';

    // Nothing to show, so let's get out of here
    if (empty($context['agreement']))
    {
        // No file found or a blank file! Just leave...
        redirectexit();
    }

    $context['canonical_url'] = $scripturl . '?action=help;sa=rules';

    $context['page_title'] = $txt['terms_and_rules'];
    $context['sub_template'] = 'terms';
}

/**
 * Show some of the more detailed help to give the admin an idea...
 * It shows a popup for administrative or user help.
 * It uses the help parameter to decide what string to display and where to get
 * the string from. ($helptxt or $txt?)
 * It is accessed via ?action=helpadmin;help=?.
 *
 * @uses ManagePermissions language file, if the help starts with permissionhelp.
 * @uses Help template, popup sub template, no layers.
 */
function ShowAdminHelp()
{
    global $txt, $helptxt, $context, $scripturl;

    if (!isset($_GET['help']) || !is_string($_GET['help']))
        fatal_lang_error('no_access', false);

    if (!isset($helptxt))
        $helptxt = array();

    // Load the admin help language file and template.
    loadLanguage('Help');

    // Permission specific help?
    if (isset($_GET['help']) && substr($_GET['help'], 0, 14) == 'permissionhelp')
        loadLanguage('ManagePermissions');

    loadTemplate('Help');

    // Allow mods to load their own language file here
    call_integration_hook('integrate_helpadmin');

    // Set the page title to something relevant.
    $context['page_title'] = $context['forum_name'] . ' - ' . $txt['help'];

    // Don't show any template layers, just the popup sub template.
    $context['template_layers'] = array();
    $context['sub_template'] = 'popup';

    // What help string should be used?
    if (isset($helptxt[$_GET['help']]))
        $context['help_text'] = $helptxt[$_GET['help']];
    elseif (isset($txt[$_GET['help']]))
        $context['help_text'] = $txt[$_GET['help']];
    else
        $context['help_text'] = $_GET['help'];

    // Does this text contain a link that we should fill in?
    if (preg_match('~%([0-9]+\$)?s\?~', $context['help_text'], $match))
        $context['help_text'] = sprintf($context['help_text'], $scripturl, $context['session_id'], $context['session_var']);
}

?>

Namespaces

Classes

Interfaces

Exceptions

Functions