FilesExpand file tree

 develop

/

template.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

182 lines (164 loc) · 5.74 KB

 develop

/

template.php

Copy path

Top

File metadata and controls

• Code
• Blame

182 lines (164 loc) · 5.74 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

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

<?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\template;

interface template

{

/**

* Clear the cache

*

* @return \phpbb\template\template

*/

public function clear_cache();

/**

* Sets the template filenames for handles.

*

* @param array $filename_array Should be a hash of handle => filename pairs.

* @return \phpbb\template\template $this

*/

public function set_filenames(array $filename_array);

/**

* Get the style tree of the style preferred by the current user

*

* @return array Style tree, most specific first

*/

public function get_user_style();

/**

* Set style location based on (current) user's chosen style.

*

* @param array $style_directories The directories to add style paths for

* E.g. array('ext/foo/bar/styles', 'styles')

* Default: array('styles') (phpBB's style directory)

* @return \phpbb\template\template $this

*/

public function set_style($style_directories = array('styles'));

/**

* Set custom style location (able to use directory outside of phpBB).

*

* Note: Templates are still compiled to phpBB's cache directory.

*

* @param string|array $names Array of names or string of name of template(s) in inheritance tree order, used by extensions.

* @param string|array or string $paths Array of style paths, relative to current root directory

* @return \phpbb\template\template $this

*/

public function set_custom_style($names, $paths);

/**

* Clears all variables and blocks assigned to this template.

*

* @return \phpbb\template\template $this

*/

public function destroy();

/**

* Reset/empty complete block

*

* @param string $blockname Name of block to destroy

* @return \phpbb\template\template $this

*/

public function destroy_block_vars($blockname);

/**

* Display a template for provided handle.

*

* The template will be loaded and compiled, if necessary, first.

*

* This function calls hooks.

*

* @param string $handle Handle to display

* @return \phpbb\template\template $this

*/

public function display($handle);

/**

* Display the handle and assign the output to a template variable

* or return the compiled result.

*

* @param string $handle Handle to operate on

* @param string $template_var Template variable to assign compiled handle to

* @param bool $return_content If true return compiled handle, otherwise assign to $template_var

* @return \phpbb\template\template|string if $return_content is true return string of the compiled handle, otherwise return $this

*/

public function assign_display($handle, $template_var = '', $return_content = true);

/**

* Assign key variable pairs from an array

*

* @param array $vararray A hash of variable name => value pairs

* @return \phpbb\template\template $this

*/

public function assign_vars(array $vararray);

/**

* Assign a single scalar value to a single key.

*

* Value can be a string, an integer or a boolean.

*

* @param string $varname Variable name

* @param string $varval Value to assign to variable

* @return \phpbb\template\template $this

*/

public function assign_var($varname, $varval);

/**

* Append text to the string value stored in a key.

*

* Text is appended using the string concatenation operator (.).

*

* @param string $varname Variable name

* @param string $varval Value to append to variable

* @return \phpbb\template\template $this

*/

public function append_var($varname, $varval);

/**

* Assign key variable pairs from an array to a specified block

* @param string $blockname Name of block to assign $vararray to

* @param array $vararray A hash of variable name => value pairs

* @return \phpbb\template\template $this

*/

public function assign_block_vars($blockname, array $vararray);

/**

* Assign key variable pairs from an array to a whole specified block loop

* @param string $blockname Name of block to assign $block_vars_array to

* @param array $block_vars_array An array of hashes of variable name => value pairs

* @return \phpbb\template\template $this

*/

public function assign_block_vars_array($blockname, array $block_vars_array);

/**

* Change already assigned key variable pair (one-dimensional - single loop entry)

*

* An example of how to use this function:

* {@example alter_block_array.php}

*

* @param string $blockname the blockname, for example 'loop'

* @param array $vararray the var array to insert/add or merge

* @param mixed $key Key to search for

*

* array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]

*

* int: Position [the position to change or insert at directly given]

*

* If key is false the position is set to 0

* If key is true the position is set to the last entry

*

* @param string $mode Mode to execute (valid modes are 'insert' and 'change')

*

* If insert, the vararray is inserted at the given position (position counting from zero).

* If change, the current block gets merged with the vararray (resulting in new \key/value pairs be added and existing keys be replaced by the new \value).

*

* Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)

* and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)

*

* @return bool false on error, true on success

*/

public function alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert');

/**

* Get path to template for handle (required for BBCode parser)

*

* @param string $handle Handle to retrieve the source file

* @return string

*/

public function get_source_file_for_handle($handle);

}