@@ -23,6 +23,9 @@ |
||
| 23 | 23 | |
| 24 | 24 | /* Language set */ |
| 25 | 25 | |
| 26 | + /** |
|
| 27 | + * @param string $lang |
|
| 28 | + */ |
|
| 26 | 29 | private function _lang_set($lang) |
| 27 | 30 | { |
| 28 | 31 | // We accept any language set as lang_id in **_dlg.js |
@@ -67,7 +67,7 @@ |
||
| 67 | 67 | * @param string a particular marked point |
| 68 | 68 | * @param string a particular marked point |
| 69 | 69 | * @param integer the number of decimal places |
| 70 | - * @return mixed |
|
| 70 | + * @return string |
|
| 71 | 71 | */ |
| 72 | 72 | function elapsed_time($point1 = '', $point2 = '', $decimals = 4) |
| 73 | 73 | { |
@@ -303,6 +303,9 @@ |
||
| 303 | 303 | */ |
| 304 | 304 | if ( ! function_exists('show_error')) |
| 305 | 305 | { |
| 306 | + /** |
|
| 307 | + * @param string $message |
|
| 308 | + */ |
|
| 306 | 309 | function show_error($message, $status_code = 500, $heading = 'An Error Was Encountered') |
| 307 | 310 | { |
| 308 | 311 | $_error =& load_class('Exceptions', 'core'); |
@@ -56,7 +56,7 @@ discard block |
||
| 56 | 56 | * @param string the config file name |
| 57 | 57 | * @param boolean if configuration values should be loaded into their own section |
| 58 | 58 | * @param boolean true if errors should just return false, false if an error message should be displayed |
| 59 | - * @return boolean if the file was successfully loaded or not |
|
| 59 | + * @return boolean|null if the file was successfully loaded or not |
|
| 60 | 60 | */ |
| 61 | 61 | function __construct() |
| 62 | 62 | { |
@@ -184,6 +184,7 @@ discard block |
||
| 184 | 184 | * @param string the config item name |
| 185 | 185 | * @param string the index name |
| 186 | 186 | * @param bool |
| 187 | + * @param string $item |
|
| 187 | 188 | * @return string |
| 188 | 189 | */ |
| 189 | 190 | function item($item, $index = '') |
@@ -223,6 +224,7 @@ discard block |
||
| 223 | 224 | * @access public |
| 224 | 225 | * @param string the config item name |
| 225 | 226 | * @param bool |
| 227 | + * @param string $item |
|
| 226 | 228 | * @return string |
| 227 | 229 | */ |
| 228 | 230 | function slash_item($item) |
@@ -288,7 +290,7 @@ discard block |
||
| 288 | 290 | * Build URI string for use in Config::site_url() and Config::base_url() |
| 289 | 291 | * |
| 290 | 292 | * @access protected |
| 291 | - * @param $uri |
|
| 293 | + * @param string $uri |
|
| 292 | 294 | * @return string |
| 293 | 295 | */ |
| 294 | 296 | protected function _uri_string($uri) |
@@ -130,6 +130,8 @@ |
||
| 130 | 130 | * @param string the message |
| 131 | 131 | * @param string the template name |
| 132 | 132 | * @param int the status code |
| 133 | + * @param string $heading |
|
| 134 | + * @param string $message |
|
| 133 | 135 | * @return string |
| 134 | 136 | */ |
| 135 | 137 | function show_error($heading, $message, $template = 'error_general', $status_code = 500) |
@@ -108,7 +108,7 @@ discard block |
||
| 108 | 108 | * |
| 109 | 109 | * @access private |
| 110 | 110 | * @param string the hook name |
| 111 | - * @return mixed |
|
| 111 | + * @return boolean |
|
| 112 | 112 | */ |
| 113 | 113 | function _call_hook($which = '') |
| 114 | 114 | { |
@@ -141,7 +141,7 @@ discard block |
||
| 141 | 141 | * |
| 142 | 142 | * @access private |
| 143 | 143 | * @param array the hook details |
| 144 | - * @return bool |
|
| 144 | + * @return null|boolean |
|
| 145 | 145 | */ |
| 146 | 146 | function _run_hook($data) |
| 147 | 147 | { |
@@ -139,6 +139,7 @@ discard block |
||
| 139 | 139 | * @access public |
| 140 | 140 | * @param string |
| 141 | 141 | * @param bool |
| 142 | + * @param string $index |
|
| 142 | 143 | * @return string |
| 143 | 144 | */ |
| 144 | 145 | function get($index = NULL, $xss_clean = FALSE) |
@@ -167,6 +168,7 @@ discard block |
||
| 167 | 168 | * @access public |
| 168 | 169 | * @param string |
| 169 | 170 | * @param bool |
| 171 | + * @param string $index |
|
| 170 | 172 | * @return string |
| 171 | 173 | */ |
| 172 | 174 | function post($index = NULL, $xss_clean = FALSE) |
@@ -140,7 +140,7 @@ discard block |
||
| 140 | 140 | * This method is called once in CI_Controller. |
| 141 | 141 | * |
| 142 | 142 | * @param array |
| 143 | - * @return object |
|
| 143 | + * @return CI_Loader |
|
| 144 | 144 | */ |
| 145 | 145 | public function initialize() |
| 146 | 146 | { |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | * @param string the name of the class |
| 190 | 190 | * @param mixed the optional parameters |
| 191 | 191 | * @param string an optional object name |
| 192 | - * @return void |
|
| 192 | + * @return null|false |
|
| 193 | 193 | */ |
| 194 | 194 | public function library($library = '', $params = NULL, $object_name = NULL) |
| 195 | 195 | { |
@@ -412,7 +412,7 @@ discard block |
||
| 412 | 412 | * @param string |
| 413 | 413 | * @param array |
| 414 | 414 | * @param bool |
| 415 | - * @return void |
|
| 415 | + * @return string|null |
|
| 416 | 416 | */ |
| 417 | 417 | public function view($view, $vars = array(), $return = FALSE) |
| 418 | 418 | { |
@@ -606,7 +606,7 @@ discard block |
||
| 606 | 606 | * @param string the name of the class |
| 607 | 607 | * @param mixed the optional parameters |
| 608 | 608 | * @param string an optional object name |
| 609 | - * @return void |
|
| 609 | + * @return false|null |
|
| 610 | 610 | */ |
| 611 | 611 | public function driver($library = '', $params = NULL, $object_name = NULL) |
| 612 | 612 | { |
@@ -736,7 +736,7 @@ discard block |
||
| 736 | 736 | * variables made available to view files |
| 737 | 737 | * |
| 738 | 738 | * @param array |
| 739 | - * @return void |
|
| 739 | + * @return string|null |
|
| 740 | 740 | */ |
| 741 | 741 | protected function _ci_load($_ci_data) |
| 742 | 742 | { |
@@ -874,6 +874,7 @@ discard block |
||
| 874 | 874 | * @param string the item that is being loaded |
| 875 | 875 | * @param mixed any additional parameters |
| 876 | 876 | * @param string an optional object name |
| 877 | + * @param string $class |
|
| 877 | 878 | * @return void |
| 878 | 879 | */ |
| 879 | 880 | protected function _ci_load_class($class, $params = NULL, $object_name = NULL) |
@@ -1002,6 +1003,7 @@ discard block |
||
| 1002 | 1003 | * @param string |
| 1003 | 1004 | * @param bool |
| 1004 | 1005 | * @param string an optional object name |
| 1006 | + * @param string $class |
|
| 1005 | 1007 | * @return null |
| 1006 | 1008 | */ |
| 1007 | 1009 | protected function _ci_init_class($class, $prefix = '', $config = FALSE, $object_name = NULL) |
@@ -1109,7 +1111,7 @@ discard block |
||
| 1109 | 1111 | * libraries, and helpers to be loaded automatically. |
| 1110 | 1112 | * |
| 1111 | 1113 | * @param array |
| 1112 | - * @return void |
|
| 1114 | + * @return false|null |
|
| 1113 | 1115 | */ |
| 1114 | 1116 | private function _ci_autoloader() |
| 1115 | 1117 | { |
@@ -1207,6 +1209,7 @@ discard block |
||
| 1207 | 1209 | * Get a reference to a specific library or model |
| 1208 | 1210 | * |
| 1209 | 1211 | * @param string |
| 1212 | + * @param string $component |
|
| 1210 | 1213 | * @return bool |
| 1211 | 1214 | */ |
| 1212 | 1215 | protected function &_ci_get_component($component) |
@@ -1224,6 +1227,7 @@ discard block |
||
| 1224 | 1227 | * |
| 1225 | 1228 | * @param mixed |
| 1226 | 1229 | * @param string |
| 1230 | + * @param string $extension |
|
| 1227 | 1231 | * @return array |
| 1228 | 1232 | */ |
| 1229 | 1233 | protected function _ci_prep_filename($filename, $extension) |
@@ -133,7 +133,7 @@ discard block |
||
| 133 | 133 | * |
| 134 | 134 | * @access public |
| 135 | 135 | * @param string |
| 136 | - * @return void |
|
| 136 | + * @return CI_Output |
|
| 137 | 137 | */ |
| 138 | 138 | function set_output($output) |
| 139 | 139 | { |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | * |
| 152 | 152 | * @access public |
| 153 | 153 | * @param string |
| 154 | - * @return void |
|
| 154 | + * @return CI_Output |
|
| 155 | 155 | */ |
| 156 | 156 | function append_output($output) |
| 157 | 157 | { |
@@ -180,7 +180,7 @@ discard block |
||
| 180 | 180 | * @access public |
| 181 | 181 | * @param string |
| 182 | 182 | * @param bool |
| 183 | - * @return void |
|
| 183 | + * @return null|CI_Output |
|
| 184 | 184 | */ |
| 185 | 185 | function set_header($header, $replace = TRUE) |
| 186 | 186 | { |
@@ -206,7 +206,7 @@ discard block |
||
| 206 | 206 | * |
| 207 | 207 | * @access public |
| 208 | 208 | * @param string extension of the file we're outputting |
| 209 | - * @return void |
|
| 209 | + * @return CI_Output |
|
| 210 | 210 | */ |
| 211 | 211 | function set_content_type($mime_type) |
| 212 | 212 | { |
@@ -242,7 +242,7 @@ discard block |
||
| 242 | 242 | * @access public |
| 243 | 243 | * @param int the status code |
| 244 | 244 | * @param string |
| 245 | - * @return void |
|
| 245 | + * @return CI_Output |
|
| 246 | 246 | */ |
| 247 | 247 | function set_status_header($code = 200, $text = '') |
| 248 | 248 | { |
@@ -258,7 +258,7 @@ discard block |
||
| 258 | 258 | * |
| 259 | 259 | * @access public |
| 260 | 260 | * @param bool |
| 261 | - * @return void |
|
| 261 | + * @return CI_Output |
|
| 262 | 262 | */ |
| 263 | 263 | function enable_profiler($val = TRUE) |
| 264 | 264 | { |
@@ -276,7 +276,7 @@ discard block |
||
| 276 | 276 | * |
| 277 | 277 | * @access public |
| 278 | 278 | * @param array |
| 279 | - * @return void |
|
| 279 | + * @return CI_Output |
|
| 280 | 280 | */ |
| 281 | 281 | function set_profiler_sections($sections) |
| 282 | 282 | { |
@@ -295,7 +295,7 @@ discard block |
||
| 295 | 295 | * |
| 296 | 296 | * @access public |
| 297 | 297 | * @param integer |
| 298 | - * @return void |
|
| 298 | + * @return CI_Output |
|
| 299 | 299 | */ |
| 300 | 300 | function cache($time) |
| 301 | 301 | { |
@@ -319,7 +319,7 @@ discard block |
||
| 319 | 319 | * |
| 320 | 320 | * @access public |
| 321 | 321 | * @param string |
| 322 | - * @return mixed |
|
| 322 | + * @return boolean|null |
|
| 323 | 323 | */ |
| 324 | 324 | function _display($output = '') |
| 325 | 325 | { |
@@ -456,6 +456,7 @@ discard block |
||
| 456 | 456 | * |
| 457 | 457 | * @access public |
| 458 | 458 | * @param string |
| 459 | + * @param string $output |
|
| 459 | 460 | * @return void |
| 460 | 461 | */ |
| 461 | 462 | function _write_cache($output) |
@@ -509,7 +510,7 @@ discard block |
||
| 509 | 510 | * @access public |
| 510 | 511 | * @param object config class |
| 511 | 512 | * @param object uri class |
| 512 | - * @return void |
|
| 513 | + * @return boolean |
|
| 513 | 514 | */ |
| 514 | 515 | function _display_cache(&$CFG, &$URI) |
| 515 | 516 | { |