@@ -35,6 +35,7 @@ discard block |
||
35 | 35 | /** |
36 | 36 | * Returns a user instance according to auth data stored in a cookie. |
37 | 37 | * @param THttpCookie the cookie storing user authentication information |
38 | + * @param THttpCookie $cookie |
|
38 | 39 | * @return TUser the user instance generated based on the cookie auth data, null if the cookie does not have valid auth data. |
39 | 40 | * @since 3.1.1 |
40 | 41 | */ |
@@ -42,7 +43,9 @@ discard block |
||
42 | 43 | /** |
43 | 44 | * Saves user auth data into a cookie. |
44 | 45 | * @param THttpCookie the cookie to receive the user auth data. |
46 | + * @param THttpCookie $cookie |
|
45 | 47 | * @since 3.1.1 |
48 | + * @return void |
|
46 | 49 | */ |
47 | 50 | public function saveUserToCookie($cookie); |
48 | 51 | /** |
@@ -219,11 +219,17 @@ discard block |
||
219 | 219 | return 0; |
220 | 220 | } |
221 | 221 | |
222 | + /** |
|
223 | + * @param IUser $user |
|
224 | + */ |
|
222 | 225 | private function isUserMatched($user) |
223 | 226 | { |
224 | 227 | return ($this->_everyone || ($this->_guest && $user->getIsGuest()) || ($this->_authenticated && !$user->getIsGuest()) || in_array(strtolower($user->getName()),$this->_users)); |
225 | 228 | } |
226 | 229 | |
230 | + /** |
|
231 | + * @param IUser $user |
|
232 | + */ |
|
227 | 233 | private function isRoleMatched($user) |
228 | 234 | { |
229 | 235 | foreach($this->_roles as $role) |
@@ -256,6 +262,9 @@ discard block |
||
256 | 262 | * @param IUser the user to be authorized |
257 | 263 | * @param string verb, can be empty, 'post' or 'get'. |
258 | 264 | * @param string the request IP address |
265 | + * @param IUser $user |
|
266 | + * @param string $verb |
|
267 | + * @param string $ip |
|
259 | 268 | * @return boolean whether the user is allowed |
260 | 269 | */ |
261 | 270 | public function isUserAllowed($user,$verb,$ip) |
@@ -163,6 +163,7 @@ |
||
163 | 163 | /** |
164 | 164 | * Creates the DB connection. |
165 | 165 | * @param string the module ID for TDataSourceConfig |
166 | + * @param string $connectionID |
|
166 | 167 | * @return TDbConnection the created DB connection |
167 | 168 | * @throws TConfigurationException if module ID is invalid or empty |
168 | 169 | */ |
@@ -342,6 +342,7 @@ discard block |
||
342 | 342 | * to determine the application configuration file, |
343 | 343 | * application root path and the runtime path. |
344 | 344 | * @param string the application root path or the application configuration file |
345 | + * @param string $basePath |
|
345 | 346 | * @see setBasePath |
346 | 347 | * @see setRuntimePath |
347 | 348 | * @see setConfigurationFile |
@@ -440,6 +441,7 @@ discard block |
||
440 | 441 | * A global value is one that is persistent across users sessions and requests. |
441 | 442 | * @param string the name of the value to be returned |
442 | 443 | * @param mixed the default value. If $key is not found, $defaultValue will be returned |
444 | + * @param integer $defaultValue |
|
443 | 445 | * @return mixed the global value corresponding to $key |
444 | 446 | */ |
445 | 447 | public function getGlobalState($key,$defaultValue=null) |
@@ -456,6 +458,7 @@ discard block |
||
456 | 458 | * @param mixed the global value to be set |
457 | 459 | * @param mixed the default value. If $key is not found, $defaultValue will be returned |
458 | 460 | * @param boolean wheter to force an immediate GlobalState save. defaults to false |
461 | + * @param string $key |
|
459 | 462 | */ |
460 | 463 | public function setGlobalState($key,$value,$defaultValue=null,$forceSave=false) |
461 | 464 | { |
@@ -545,7 +548,7 @@ discard block |
||
545 | 548 | } |
546 | 549 | |
547 | 550 | /** |
548 | - * @return TApplicationMode application mode. Defaults to TApplicationMode::Debug. |
|
551 | + * @return string application mode. Defaults to TApplicationMode::Debug. |
|
549 | 552 | */ |
550 | 553 | public function getMode() |
551 | 554 | { |
@@ -570,6 +573,7 @@ discard block |
||
570 | 573 | |
571 | 574 | /** |
572 | 575 | * @param string the directory containing the application configuration file |
576 | + * @param string $value |
|
573 | 577 | */ |
574 | 578 | public function setBasePath($value) |
575 | 579 | { |
@@ -586,6 +590,7 @@ discard block |
||
586 | 590 | |
587 | 591 | /** |
588 | 592 | * @param string the application configuration file (absolute path) |
593 | + * @param string $value |
|
589 | 594 | */ |
590 | 595 | public function setConfigurationFile($value) |
591 | 596 | { |
@@ -602,6 +607,7 @@ discard block |
||
602 | 607 | |
603 | 608 | /** |
604 | 609 | * @param string the application configuration type. 'xml' and 'php' are valid values |
610 | + * @param string $value |
|
605 | 611 | */ |
606 | 612 | public function setConfigurationType($value) |
607 | 613 | { |
@@ -657,6 +663,7 @@ discard block |
||
657 | 663 | |
658 | 664 | /** |
659 | 665 | * @param string the directory storing cache data and application-level persistent data. (absolute path) |
666 | + * @param string $value |
|
660 | 667 | */ |
661 | 668 | public function setRuntimePath($value) |
662 | 669 | { |
@@ -677,6 +684,7 @@ discard block |
||
677 | 684 | |
678 | 685 | /** |
679 | 686 | * @param IService the currently requested service |
687 | + * @param IService $value |
|
680 | 688 | */ |
681 | 689 | public function setService($value) |
682 | 690 | { |
@@ -1126,6 +1134,7 @@ discard block |
||
1126 | 1134 | * This method is invoked when an exception is raised during the lifecycles |
1127 | 1135 | * of the application. |
1128 | 1136 | * @param mixed event parameter |
1137 | + * @param Exception $param |
|
1129 | 1138 | */ |
1130 | 1139 | public function onError($param) |
1131 | 1140 | { |
@@ -49,6 +49,7 @@ |
||
49 | 49 | |
50 | 50 | /** |
51 | 51 | * @param string id of this service |
52 | + * @param string $value |
|
52 | 53 | */ |
53 | 54 | public function setID($value) |
54 | 55 | { |
@@ -98,6 +98,7 @@ |
||
98 | 98 | * @param integer level filter |
99 | 99 | * @param array category filter |
100 | 100 | * @param array control filter |
101 | + * @param integer $levels |
|
101 | 102 | * @return array list of messages. Each array elements represents one message |
102 | 103 | * with the following structure: |
103 | 104 | * array( |
@@ -105,6 +105,9 @@ |
||
105 | 105 | * @param string RPC server URL |
106 | 106 | * @param array payload data |
107 | 107 | * @param string request mime type |
108 | + * @param string $serverUrl |
|
109 | + * @param string $mimeType |
|
110 | + * @return string |
|
108 | 111 | */ |
109 | 112 | protected function performRequest($serverUrl, $payload, $mimeType) |
110 | 113 | { |
@@ -55,6 +55,9 @@ |
||
55 | 55 | return self::$_output; |
56 | 56 | } |
57 | 57 | |
58 | + /** |
|
59 | + * @param integer $level |
|
60 | + */ |
|
58 | 61 | private static function dumpInternal($var,$level) |
59 | 62 | { |
60 | 63 | switch(gettype($var)) |
@@ -73,6 +73,9 @@ discard block |
||
73 | 73 | |
74 | 74 | // -- Protected Instance Methods --------------------------------------------- |
75 | 75 | |
76 | + /** |
|
77 | + * @param integer $d |
|
78 | + */ |
|
76 | 79 | protected function action($d) { |
77 | 80 | switch($d) { |
78 | 81 | case 1: |
@@ -132,6 +135,9 @@ discard block |
||
132 | 135 | } |
133 | 136 | } |
134 | 137 | |
138 | + /** |
|
139 | + * @return string |
|
140 | + */ |
|
135 | 141 | protected function get() { |
136 | 142 | $c = $this->lookAhead; |
137 | 143 | $this->lookAhead = null; |
@@ -156,6 +162,9 @@ discard block |
||
156 | 162 | return ' '; |
157 | 163 | } |
158 | 164 | |
165 | + /** |
|
166 | + * @param string $c |
|
167 | + */ |
|
159 | 168 | protected function isAlphaNum($c) { |
160 | 169 | return ord($c) > 126 || $c === '\\' || preg_match('/^[\w\$]$/', $c) === 1; |
161 | 170 | } |