@@ -16,23 +16,23 @@ discard block |
||
16 | 16 | class base extends \Exception |
17 | 17 | { |
18 | 18 | /** |
19 | - * Null if the message is a string, array if the message was submitted as an array |
|
20 | - * @var string|array |
|
21 | - */ |
|
19 | + * Null if the message is a string, array if the message was submitted as an array |
|
20 | + * @var string|array |
|
21 | + */ |
|
22 | 22 | protected $message_full; |
23 | 23 | |
24 | 24 | protected $previous; |
25 | 25 | |
26 | 26 | /** |
27 | - * Constructor |
|
28 | - * |
|
29 | - * Different from normal exceptions in that we do not enforce $message to be a string. |
|
30 | - * |
|
31 | - * @param string|array $message |
|
32 | - * @param int $code |
|
33 | - * @param \Exception $previous |
|
34 | - * @access public |
|
35 | - */ |
|
27 | + * Constructor |
|
28 | + * |
|
29 | + * Different from normal exceptions in that we do not enforce $message to be a string. |
|
30 | + * |
|
31 | + * @param string|array $message |
|
32 | + * @param int $code |
|
33 | + * @param \Exception $previous |
|
34 | + * @access public |
|
35 | + */ |
|
36 | 36 | public function __construct($message = null, $code = 0, \Exception $previous = null) |
37 | 37 | { |
38 | 38 | // We're slightly changing the way exceptions work |
@@ -53,12 +53,12 @@ discard block |
||
53 | 53 | } |
54 | 54 | |
55 | 55 | /** |
56 | - * Basic message translation for our exceptions |
|
57 | - * |
|
58 | - * @param \phpbb\user $user |
|
59 | - * @return string|array |
|
60 | - * @access public |
|
61 | - */ |
|
56 | + * Basic message translation for our exceptions |
|
57 | + * |
|
58 | + * @param \phpbb\user $user |
|
59 | + * @return string|array |
|
60 | + * @access public |
|
61 | + */ |
|
62 | 62 | public function get_message(\phpbb\user $user) |
63 | 63 | { |
64 | 64 | // Make sure our language file has been loaded |
@@ -73,18 +73,18 @@ discard block |
||
73 | 73 | } |
74 | 74 | |
75 | 75 | /** |
76 | - * Translate all portions of the message sent to the exception |
|
77 | - * |
|
78 | - * Goes through each element of the array and tries to translate them |
|
79 | - * |
|
80 | - * @param \phpbb\user $user |
|
81 | - * @param string|array $message_portions The message portions to translate |
|
82 | - * @param string|null $parent_message Send a string to translate all of the |
|
83 | - * portions with the parent message (typically used to format a string |
|
84 | - * with the given message portions). Null to ignore. Default: Null |
|
85 | - * @return array|string Array if $parent_message === null else a string |
|
86 | - * @access protected |
|
87 | - */ |
|
76 | + * Translate all portions of the message sent to the exception |
|
77 | + * |
|
78 | + * Goes through each element of the array and tries to translate them |
|
79 | + * |
|
80 | + * @param \phpbb\user $user |
|
81 | + * @param string|array $message_portions The message portions to translate |
|
82 | + * @param string|null $parent_message Send a string to translate all of the |
|
83 | + * portions with the parent message (typically used to format a string |
|
84 | + * with the given message portions). Null to ignore. Default: Null |
|
85 | + * @return array|string Array if $parent_message === null else a string |
|
86 | + * @access protected |
|
87 | + */ |
|
88 | 88 | protected function translate_portions(\phpbb\user $user, $message_portions, $parent_message = null) |
89 | 89 | { |
90 | 90 | // Make sure our language file has been loaded |
@@ -126,12 +126,12 @@ discard block |
||
126 | 126 | } |
127 | 127 | |
128 | 128 | /** |
129 | - * Add our language file |
|
130 | - * |
|
131 | - * @param \phpbb\user $user |
|
132 | - * @return null |
|
133 | - * @access public |
|
134 | - */ |
|
129 | + * Add our language file |
|
130 | + * |
|
131 | + * @param \phpbb\user $user |
|
132 | + * @return null |
|
133 | + * @access public |
|
134 | + */ |
|
135 | 135 | public function add_lang(\phpbb\user $user) |
136 | 136 | { |
137 | 137 | static $is_loaded = false; |
@@ -150,15 +150,15 @@ discard block |
||
150 | 150 | } |
151 | 151 | |
152 | 152 | /** |
153 | - * Output a string of this error message |
|
154 | - * |
|
155 | - * This will hopefully be never called, always catch the expected exceptions |
|
156 | - * and call get_message to translate them into an error that a user can |
|
157 | - * understand |
|
158 | - * |
|
159 | - * @return string |
|
160 | - * @access public |
|
161 | - */ |
|
153 | + * Output a string of this error message |
|
154 | + * |
|
155 | + * This will hopefully be never called, always catch the expected exceptions |
|
156 | + * and call get_message to translate them into an error that a user can |
|
157 | + * understand |
|
158 | + * |
|
159 | + * @return string |
|
160 | + * @access public |
|
161 | + */ |
|
162 | 162 | public function __toString() |
163 | 163 | { |
164 | 164 | return (is_array($this->message_full)) ? var_export($this->message_full, true) : (string) $this->message_full; |