FilesExpand file tree

 master

/

help.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

164 lines (141 loc) · 4 KB

 master

/

help.php

Copy path

Top

File metadata and controls

• Code
• Blame

164 lines (141 loc) · 4 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

<?php

/**

*

* This file is part of the phpBB Forum Software package.

*

* @copyright (c) phpBB Limited <https://www.phpbb.com>

* @license GNU General Public License, version 2 (GPL-2.0)

*

* For full copyright and license information, please see

* the docs/CREDITS.txt file.

*

*/

namespace phpbb\help\controller;

use phpbb\exception\http_exception;

class help

{

/** @var \phpbb\controller\helper */

protected $helper;

/** @var \phpbb\event\dispatcher_interface */

protected $dispatcher;

/** @var \phpbb\template\template */

protected $template;

/** @var \phpbb\user */

protected $user;

/** @var string */

protected $root_path;

/** @var string */

protected $php_ext;

/**

* Constructor

*

* @param \phpbb\controller\helper $helper

* @param \phpbb\event\dispatcher_interface $dispatcher

* @param \phpbb\template\template $template

* @param \phpbb\user $user

* @param string $root_path

* @param string $php_ext

*/

public function __construct(\phpbb\controller\helper $helper, \phpbb\event\dispatcher_interface $dispatcher, \phpbb\template\template $template, \phpbb\user $user, $root_path, $php_ext)

{

$this->helper = $helper;

$this->dispatcher = $dispatcher;

$this->template = $template;

$this->user = $user;

$this->root_path = $root_path;

$this->php_ext = $php_ext;

}

/**

* Controller for /help/{mode} routes

*

* @param string $mode

* @return \Symfony\Component\HttpFoundation\Response A Symfony Response object

* @throws http_exception when the $mode is not known by any extension

*/

public function handle($mode)

{

$template_file = 'faq_body.html';

switch ($mode)

{

case 'faq':

case 'bbcode':

$page_title = ($mode === 'faq') ? $this->user->lang['FAQ_EXPLAIN'] : $this->user->lang['BBCODE_GUIDE'];

$this->user->add_lang($mode, false, true);

break;

default:

$page_title = $this->user->lang['FAQ_EXPLAIN'];

$ext_name = $lang_file = '';

/**

* You can use this event display a custom help page

*

* @event core.faq_mode_validation

* @var string page_title Title of the page

* @var string mode FAQ that is going to be displayed

* @var string lang_file Language file containing the help data

* @var string ext_name Vendor and extension name where the help

* language file can be loaded from

* @var string template_file Template file name

* @since 3.1.4-RC1

* @changed 3.1.11-RC1 Added template_file var

*/

$vars = array(

'page_title',

'mode',

'lang_file',

'ext_name',

'template_file',

);

extract($this->dispatcher->trigger_event('core.faq_mode_validation', compact($vars)));

if ($ext_name === '' || $lang_file === '')

{

throw new http_exception(404, 'Not Found');

}

$this->user->add_lang($lang_file, false, true, $ext_name);

break;

}

$this->template->assign_vars(array(

'L_FAQ_TITLE' => $page_title,

'S_IN_FAQ' => true,

));

$this->assign_to_template($this->user->help);

make_jumpbox(append_sid("{$this->root_path}viewforum.{$this->php_ext}"));

return $this->helper->render($template_file, $page_title);

}

/**

* Assigns the help data to the template blocks

*

* @param array $help_data

* @return void

*/

protected function assign_to_template(array $help_data)

{

// Pull the array data from the lang pack

$switch_column = $found_switch = false;

foreach ($help_data as $help_ary)

{

if ($help_ary[0] == '--')

{

if ($help_ary[1] == '--')

{

$switch_column = true;

$found_switch = true;

continue;

}

$this->template->assign_block_vars('faq_block', array(

'BLOCK_TITLE' => $help_ary[1],

'SWITCH_COLUMN' => $switch_column,

));

if ($switch_column)

{

$switch_column = false;

}

continue;

}

$this->template->assign_block_vars('faq_block.faq_row', array(

'FAQ_QUESTION' => $help_ary[0],

'FAQ_ANSWER' => $help_ary[1],

));

}

$this->template->assign_var('SWITCH_COLUMN_MANUALLY', !$found_switch);

}

}