@@ -15,12 +15,12 @@ |
||
| 15 | 15 | class unexpected_value extends base |
| 16 | 16 | { |
| 17 | 17 | /** |
| 18 | - * Translate this exception |
|
| 19 | - * |
|
| 20 | - * @param \phpbb\user $user |
|
| 21 | - * @return array|string |
|
| 22 | - * @access public |
|
| 23 | - */ |
|
| 18 | + * Translate this exception |
|
| 19 | + * |
|
| 20 | + * @param \phpbb\user $user |
|
| 21 | + * @return array|string |
|
| 22 | + * @access public |
|
| 23 | + */ |
|
| 24 | 24 | public function get_message(\phpbb\user $user) |
| 25 | 25 | { |
| 26 | 26 | return $this->translate_portions($user, $this->message_full, 'EXCEPTION_UNEXPECTED_VALUE'); |
@@ -33,13 +33,13 @@ |
||
| 33 | 33 | protected $data = array(); |
| 34 | 34 | |
| 35 | 35 | /** |
| 36 | - * Construct |
|
| 37 | - * |
|
| 38 | - * @param \phpbb\db\driver\driver_interface $db Database connection |
|
| 39 | - * @param string $items_table Table name |
|
| 40 | - * @param string $pk Primary key |
|
| 41 | - * @param string $sql_where Column restriction |
|
| 42 | - */ |
|
| 36 | + * Construct |
|
| 37 | + * |
|
| 38 | + * @param \phpbb\db\driver\driver_interface $db Database connection |
|
| 39 | + * @param string $items_table Table name |
|
| 40 | + * @param string $pk Primary key |
|
| 41 | + * @param string $sql_where Column restriction |
|
| 42 | + */ |
|
| 43 | 43 | public function __construct(\phpbb\db\driver\driver_interface $db, $items_table, $pk, $sql_where = '') |
| 44 | 44 | { |
| 45 | 45 | $this->db = $db; |
@@ -15,12 +15,12 @@ |
||
| 15 | 15 | class unexpected_value extends base |
| 16 | 16 | { |
| 17 | 17 | /** |
| 18 | - * Translate this exception |
|
| 19 | - * |
|
| 20 | - * @param \phpbb\user $user |
|
| 21 | - * @return array|string |
|
| 22 | - * @access public |
|
| 23 | - */ |
|
| 18 | + * Translate this exception |
|
| 19 | + * |
|
| 20 | + * @param \phpbb\user $user |
|
| 21 | + * @return array|string |
|
| 22 | + * @access public |
|
| 23 | + */ |
|
| 24 | 24 | public function get_message(\phpbb\user $user) |
| 25 | 25 | { |
| 26 | 26 | return $this->translate_portions($user, $this->message_full, 'EXCEPTION_UNEXPECTED_VALUE'); |
@@ -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; |
@@ -15,12 +15,12 @@ |
||
| 15 | 15 | class unexpected_value extends base |
| 16 | 16 | { |
| 17 | 17 | /** |
| 18 | - * Translate this exception |
|
| 19 | - * |
|
| 20 | - * @param \phpbb\user $user |
|
| 21 | - * @return array|string |
|
| 22 | - * @access public |
|
| 23 | - */ |
|
| 18 | + * Translate this exception |
|
| 19 | + * |
|
| 20 | + * @param \phpbb\user $user |
|
| 21 | + * @return array|string |
|
| 22 | + * @access public |
|
| 23 | + */ |
|
| 24 | 24 | public function get_message(\phpbb\user $user) |
| 25 | 25 | { |
| 26 | 26 | return $this->translate_portions($user, $this->message_full, 'EXCEPTION_UNEXPECTED_VALUE'); |
@@ -56,8 +56,8 @@ discard block |
||
| 56 | 56 | } |
| 57 | 57 | |
| 58 | 58 | /** |
| 59 | - * {@inheritdoc} |
|
| 60 | - */ |
|
| 59 | + * {@inheritdoc} |
|
| 60 | + */ |
|
| 61 | 61 | public function to_array() |
| 62 | 62 | { |
| 63 | 63 | $attributes = $this->get_attributes(); |
@@ -74,8 +74,8 @@ discard block |
||
| 74 | 74 | } |
| 75 | 75 | |
| 76 | 76 | /** |
| 77 | - * {@inheritdoc} |
|
| 78 | - */ |
|
| 77 | + * {@inheritdoc} |
|
| 78 | + */ |
|
| 79 | 79 | public function to_db() |
| 80 | 80 | { |
| 81 | 81 | $this->check_required(); |
@@ -14,12 +14,12 @@ |
||
| 14 | 14 | class nestedset extends builder |
| 15 | 15 | { |
| 16 | 16 | /** |
| 17 | - * Construct |
|
| 18 | - * |
|
| 19 | - * @param \phpbb\db\driver\driver_interface $db Database connection |
|
| 20 | - * @param \phpbb\lock\db $lock Lock class used to lock the table when moving forums around |
|
| 21 | - * @param string $table_name Table name |
|
| 22 | - */ |
|
| 17 | + * Construct |
|
| 18 | + * |
|
| 19 | + * @param \phpbb\db\driver\driver_interface $db Database connection |
|
| 20 | + * @param \phpbb\lock\db $lock Lock class used to lock the table when moving forums around |
|
| 21 | + * @param string $table_name Table name |
|
| 22 | + */ |
|
| 23 | 23 | public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\lock\db $lock, $table_name) |
| 24 | 24 | { |
| 25 | 25 | parent::__construct( |
@@ -17,15 +17,15 @@ |
||
| 17 | 17 | class stats extends block |
| 18 | 18 | { |
| 19 | 19 | /** |
| 20 | - * phpBB configuration |
|
| 21 | - * @var \phpbb\config\config |
|
| 22 | - */ |
|
| 20 | + * phpBB configuration |
|
| 21 | + * @var \phpbb\config\config |
|
| 22 | + */ |
|
| 23 | 23 | protected $config; |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * User object |
|
| 27 | - * @var \phpbb\user |
|
| 28 | - */ |
|
| 26 | + * User object |
|
| 27 | + * @var \phpbb\user |
|
| 28 | + */ |
|
| 29 | 29 | protected $user; |
| 30 | 30 | |
| 31 | 31 | /** |