problem/settings.php.example at main · BGSU-LITS/problem · GitHub

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
<?php

declare(strict_types=1);

use Lits\Config\FrameworkConfig;
use Lits\Config\LibAnswersConfig;
use Lits\Config\SessionConfig;
use Lits\Config\TemplateConfig;
use Lits\Framework;

return function (Framework $framework): void {
    $settings = $framework->settings();

    assert($settings['framework'] instanceof FrameworkConfig);

    // Whether to enable debug information.
    // $settings['framework']->debug = false;

    // Path to log file to be generated by the application.
    // $settings['framework']->log = '';

    assert($settings['session'] instanceof SessionConfig);

    // Base64 encoded key with at least 32-bits of entropy. Required.
    // $settings['session']->key = '';

    // Seconds before a session will expire.
    // $settings['session']->expires = 3600;

    assert($settings['template'] instanceof TemplateConfig);

    // Path to cache directory, which must be writable.
    $settings['template']->cache = __DIR__ . DIRECTORY_SEPARATOR . 'cache';

    // Paths to search for template files.
    // $settings['template']->paths[] = '';

    // Name of the site.
    $settings['template']->site = 'Report a Problem';

    // HTML analytics tracking code added to head element for the site.
    // $settings['template']->analytics = '';

    // HTML contact information for the site.
    // $settings['template']->contact = '';

    // Menu for the site.
    // $settings['template']->menu = [];

    assert($settings['libanswers'] instanceof LibAnswersConfig);

    // Host name from base URL of LibAnswers API.
    $settings['libanswers']->host = 'example.libanswers.com';

    // Client ID for LibAnswers API.
    $settings['libanswers']->clientId = '0';

    // Client Secret for LibAnswers API.
    $settings['libanswers']->clientSecret = '1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d';

    // ID number of the queue to create tickets in.
    $settings['libanswers']->queueId = 0;

    // Path to cache directory, which must be writable.
    if (is_string($settings['template']->cache)) {
        $settings['libanswers']->cache = $settings['template']->cache;
    }

    // Names of fields that should be hidden.
    // $settings['libanswers']->hidden = [];

    // Names of fields that should be kept populated after submission.
    // $settings['libanswers']->keep = ['confirm_email', 'pname', 'pemail'];

    // Custom field labels keyed by field name.
    // $settings['libanswers']->labels = [
    //     'confirm_email' =>
    //         'Receive an email confirmation of your submission.',
    //     'pname' => 'Name',
    //     'pemail' => 'Email',
    //     'pquestion' => 'Question',
    //     'pdetails' => 'More Detail/Explanation',
    // ];

    // Prepopulate named fields with values from given query parameters.
    // $settings['libanswers']->queries = [];

    // Make named fields read-only.
    // $settings['libanswers']->readonly = [];

    // Names of fields that are required.
    // $settings['libanswers']->required = [];
};