@@ -54,7 +54,7 @@ discard block |
||
| 54 | 54 | * @param null $uri |
| 55 | 55 | * @param bool $return_only |
| 56 | 56 | * |
| 57 | - * @return bool |
|
| 57 | + * @return boolean|null |
|
| 58 | 58 | */ |
| 59 | 59 | public function restrict($uri=null, $return_only=false) |
| 60 | 60 | { |
@@ -104,7 +104,7 @@ discard block |
||
| 104 | 104 | * @param mixed $groups |
| 105 | 105 | * @param string $uri The URI to redirect to on fail. |
| 106 | 106 | * |
| 107 | - * @return bool |
|
| 107 | + * @return boolean|null |
|
| 108 | 108 | */ |
| 109 | 109 | public function restrictToGroups($groups, $uri='') |
| 110 | 110 | { |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | * @param $permissions |
| 146 | 146 | * @param string $uri The URI to redirect to on fail. |
| 147 | 147 | * |
| 148 | - * @return bool |
|
| 148 | + * @return boolean|null |
|
| 149 | 149 | */ |
| 150 | 150 | public function restrictWithPermissions($permissions, $uri='') |
| 151 | 151 | { |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | * model that should be used. |
| 69 | 69 | * |
| 70 | 70 | * @param $model |
| 71 | - * @return mixed |
|
| 71 | + * @return FlatAuthorization |
|
| 72 | 72 | */ |
| 73 | 73 | public function useModel($model) |
| 74 | 74 | { |
@@ -92,7 +92,7 @@ discard block |
||
| 92 | 92 | * |
| 93 | 93 | * @param $groups |
| 94 | 94 | * |
| 95 | - * @return bool |
|
| 95 | + * @return null|boolean |
|
| 96 | 96 | */ |
| 97 | 97 | public function inGroup( $groups, $user_id ) |
| 98 | 98 | { |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | * @param int|string $permission |
| 146 | 146 | * @param int|string $user_id |
| 147 | 147 | * |
| 148 | - * @return mixed |
|
| 148 | + * @return null|boolean |
|
| 149 | 149 | */ |
| 150 | 150 | public function hasPermission( $permission, $user_id ) |
| 151 | 151 | { |
@@ -185,7 +185,7 @@ discard block |
||
| 185 | 185 | * @param $user_id |
| 186 | 186 | * @param $group // Either ID or name |
| 187 | 187 | * |
| 188 | - * @return bool |
|
| 188 | + * @return null|boolean |
|
| 189 | 189 | */ |
| 190 | 190 | public function addUserToGroup( $user_id, $group ) |
| 191 | 191 | { |
@@ -232,7 +232,7 @@ discard block |
||
| 232 | 232 | * @param $user_id |
| 233 | 233 | * @param $group |
| 234 | 234 | * |
| 235 | - * @return mixed |
|
| 235 | + * @return null|boolean |
|
| 236 | 236 | */ |
| 237 | 237 | public function removeUserFromGroup( $user_id, $group ) |
| 238 | 238 | { |
@@ -276,10 +276,10 @@ discard block |
||
| 276 | 276 | /** |
| 277 | 277 | * Adds a single permission to a single group. |
| 278 | 278 | * |
| 279 | - * @param int|string $permission |
|
| 280 | - * @param int|string $group |
|
| 279 | + * @param string $permission |
|
| 280 | + * @param string $group |
|
| 281 | 281 | * |
| 282 | - * @return mixed |
|
| 282 | + * @return boolean |
|
| 283 | 283 | */ |
| 284 | 284 | public function addPermissionToGroup( $permission, $group ) |
| 285 | 285 | { |
@@ -317,7 +317,7 @@ discard block |
||
| 317 | 317 | * @param int|string $permission |
| 318 | 318 | * @param int|string $group |
| 319 | 319 | * |
| 320 | - * @return mixed |
|
| 320 | + * @return boolean |
|
| 321 | 321 | */ |
| 322 | 322 | public function removePermissionFromGroup( $permission, $group ) |
| 323 | 323 | { |
@@ -455,8 +455,8 @@ discard block |
||
| 455 | 455 | /** |
| 456 | 456 | * Checks to see if a user has private permission assigned to it. |
| 457 | 457 | * |
| 458 | - * @param $user_id |
|
| 459 | - * @param $permission |
|
| 458 | + * @param integer $user_id |
|
| 459 | + * @param integer $permission |
|
| 460 | 460 | * |
| 461 | 461 | * @return bool|null |
| 462 | 462 | */ |
@@ -531,7 +531,7 @@ discard block |
||
| 531 | 531 | //-------------------------------------------------------------------- |
| 532 | 532 | |
| 533 | 533 | /** |
| 534 | - * @param $name |
|
| 534 | + * @param string $name |
|
| 535 | 535 | * @param string $description |
| 536 | 536 | * |
| 537 | 537 | * @return mixed |
@@ -585,7 +585,7 @@ discard block |
||
| 585 | 585 | * @param $name |
| 586 | 586 | * @param string $description |
| 587 | 587 | * |
| 588 | - * @return mixed |
|
| 588 | + * @return boolean |
|
| 589 | 589 | */ |
| 590 | 590 | public function updateGroup( $id, $name, $description = '' ) |
| 591 | 591 | { |
@@ -677,7 +677,7 @@ discard block |
||
| 677 | 677 | /** |
| 678 | 678 | * Creates a single permission. |
| 679 | 679 | * |
| 680 | - * @param $name |
|
| 680 | + * @param string $name |
|
| 681 | 681 | * @param string $description |
| 682 | 682 | * |
| 683 | 683 | * @return mixed |
@@ -708,7 +708,7 @@ discard block |
||
| 708 | 708 | * |
| 709 | 709 | * @param $permission |
| 710 | 710 | * |
| 711 | - * @return mixed |
|
| 711 | + * @return boolean |
|
| 712 | 712 | */ |
| 713 | 713 | public function deletePermission( $permission_id ) |
| 714 | 714 | { |
@@ -195,7 +195,7 @@ discard block |
||
| 195 | 195 | * string with letters and numbers. |
| 196 | 196 | * |
| 197 | 197 | * @param $user |
| 198 | - * @return mixed |
|
| 198 | + * @return string |
|
| 199 | 199 | */ |
| 200 | 200 | public function generateRememberToken($user) |
| 201 | 201 | { |
@@ -278,7 +278,7 @@ discard block |
||
| 278 | 278 | * Gets the timestamp of the last attempted login for this user. |
| 279 | 279 | * |
| 280 | 280 | * @param $email |
| 281 | - * @return int|null |
|
| 281 | + * @return integer |
|
| 282 | 282 | */ |
| 283 | 283 | public function lastLoginAttemptTime($email) |
| 284 | 284 | { |
@@ -142,7 +142,6 @@ discard block |
||
| 142 | 142 | * Named options must be in the following formats: |
| 143 | 143 | * php index.php user -v --v -name=John --name=John |
| 144 | 144 | * |
| 145 | - * @param string|int $name the name of the option (int if unnamed) |
|
| 146 | 145 | * @return string |
| 147 | 146 | */ |
| 148 | 147 | public static function input($prefix = '') |
@@ -281,6 +280,7 @@ discard block |
||
| 281 | 280 | * with a line break. |
| 282 | 281 | * |
| 283 | 282 | * @param string|array $text the text to output, or array of lines |
| 283 | + * @param string $foreground |
|
| 284 | 284 | */ |
| 285 | 285 | public static function write($text = '', $foreground = null, $background = null) |
| 286 | 286 | { |
@@ -535,9 +535,9 @@ discard block |
||
| 535 | 535 | * Checks to see if an option was passed to us on the CLI and returns |
| 536 | 536 | * the value if so. Otherwise, returns null. |
| 537 | 537 | * |
| 538 | - * @param $name |
|
| 538 | + * @param string $name |
|
| 539 | 539 | * |
| 540 | - * @return null |
|
| 540 | + * @return string |
|
| 541 | 541 | */ |
| 542 | 542 | public static function option($name) |
| 543 | 543 | { |
@@ -368,7 +368,7 @@ |
||
| 368 | 368 | /** |
| 369 | 369 | * Adds an external javascript file to the 'external_scripts' array. |
| 370 | 370 | * |
| 371 | - * @param [type] $filename [description] |
|
| 371 | + * @param string $filename [description] |
|
| 372 | 372 | */ |
| 373 | 373 | public function addScript($filename) |
| 374 | 374 | { |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | /** |
| 67 | 67 | * Stores our scheduled string and actual task. |
| 68 | 68 | * |
| 69 | - * @param $schedule |
|
| 69 | + * @param string $schedule |
|
| 70 | 70 | * @param callable $task |
| 71 | 71 | */ |
| 72 | 72 | public function __construct($schedule, $task) |
@@ -90,7 +90,7 @@ discard block |
||
| 90 | 90 | * |
| 91 | 91 | * @param int|'now' $current_time |
| 92 | 92 | * |
| 93 | - * @return timestamp|null |
|
| 93 | + * @return integer|null |
|
| 94 | 94 | */ |
| 95 | 95 | public function nextRunDate($current_time='now') |
| 96 | 96 | { |
@@ -121,7 +121,7 @@ discard block |
||
| 121 | 121 | * |
| 122 | 122 | * @param int|'now' $current_time |
| 123 | 123 | * |
| 124 | - * @return timestamp|null |
|
| 124 | + * @return integer|null |
|
| 125 | 125 | */ |
| 126 | 126 | public function previousRunDate($current_time='now') |
| 127 | 127 | { |
@@ -171,7 +171,7 @@ discard block |
||
| 171 | 171 | * into any format available to date. |
| 172 | 172 | * |
| 173 | 173 | * @param $format_string |
| 174 | - * @return bool|string |
|
| 174 | + * @return string |
|
| 175 | 175 | */ |
| 176 | 176 | public function format($format_string) |
| 177 | 177 | { |
@@ -266,8 +266,8 @@ discard block |
||
| 266 | 266 | * 'every 5 minutes', every 3 days, etc. |
| 267 | 267 | * |
| 268 | 268 | * @param $schedule |
| 269 | - * @param $type |
|
| 270 | - * @return float|int|null |
|
| 269 | + * @param string $type |
|
| 270 | + * @return integer|null |
|
| 271 | 271 | */ |
| 272 | 272 | public function findDateInterval($schedule, $type, $current_time='now') |
| 273 | 273 | { |
@@ -131,7 +131,7 @@ discard block |
||
| 131 | 131 | * Parses the contents. Currently runs through the Markdown Extended |
| 132 | 132 | * parser to convert to HTML. |
| 133 | 133 | * |
| 134 | - * @param $str |
|
| 134 | + * @param string|null $str |
|
| 135 | 135 | * @return mixed |
| 136 | 136 | */ |
| 137 | 137 | public function parse($str) |
@@ -495,7 +495,7 @@ discard block |
||
| 495 | 495 | * Analyzes the passed in current url string and checks against |
| 496 | 496 | * a list of groups to determine what the current group is. |
| 497 | 497 | * |
| 498 | - * @param $current_url |
|
| 498 | + * @param string $current_url |
|
| 499 | 499 | * @param $groups |
| 500 | 500 | * @return string |
| 501 | 501 | */ |
@@ -576,8 +576,8 @@ discard block |
||
| 576 | 576 | * Re-formats the passed in link. |
| 577 | 577 | * |
| 578 | 578 | * @param $link |
| 579 | - * @param $current_url |
|
| 580 | - * @param $site_url |
|
| 579 | + * @param string $current_url |
|
| 580 | + * @param string $site_url |
|
| 581 | 581 | * @return mixed |
| 582 | 582 | */ |
| 583 | 583 | private function reformatAnchor($link, $groups, $current_url, $site_url) |
@@ -659,8 +659,8 @@ discard block |
||
| 659 | 659 | * Also adds named anchors into the $content so the map |
| 660 | 660 | * can link to the content properly. |
| 661 | 661 | * |
| 662 | - * @param $content |
|
| 663 | - * @param $xml |
|
| 662 | + * @param string $content |
|
| 663 | + * @param \SimpleXMLElement $xml |
|
| 664 | 664 | * @param $map |
| 665 | 665 | * @return array |
| 666 | 666 | */ |
@@ -501,7 +501,7 @@ |
||
| 501 | 501 | * |
| 502 | 502 | * Allows any data passed to views to be available in the profiler bar. |
| 503 | 503 | * |
| 504 | - * @return array |
|
| 504 | + * @return string |
|
| 505 | 505 | */ |
| 506 | 506 | public function _compile_view_data() |
| 507 | 507 | { |
@@ -167,10 +167,10 @@ discard block |
||
| 167 | 167 | /** |
| 168 | 168 | * Creates a new directory at the specified path. |
| 169 | 169 | * |
| 170 | - * @param $path |
|
| 171 | - * @param int|string $perms |
|
| 170 | + * @param string $path |
|
| 171 | + * @param integer $perms |
|
| 172 | 172 | * |
| 173 | - * @return bool |
|
| 173 | + * @return BaseGenerator |
|
| 174 | 174 | */ |
| 175 | 175 | public function createDirectory($path, $perms=0755) |
| 176 | 176 | { |
@@ -221,7 +221,7 @@ discard block |
||
| 221 | 221 | * parses it with the passed in data, and writes to the new location. |
| 222 | 222 | * |
| 223 | 223 | * @param $template |
| 224 | - * @param $destination |
|
| 224 | + * @param string $destination |
|
| 225 | 225 | * @param array $data |
| 226 | 226 | * @param bool $overwrite |
| 227 | 227 | * |
@@ -253,7 +253,7 @@ discard block |
||
| 253 | 253 | * replace => '' - a simple string to be replaced. All locations will be replaced. |
| 254 | 254 | * regex => '' - a pregex pattern to use to replace all locations. |
| 255 | 255 | * |
| 256 | - * @param $path |
|
| 256 | + * @param string $path |
|
| 257 | 257 | * @param $content |
| 258 | 258 | * @param array $options |
| 259 | 259 | * |
@@ -318,7 +318,7 @@ discard block |
||
| 318 | 318 | * the next command. |
| 319 | 319 | * |
| 320 | 320 | * @param $command |
| 321 | - * @param null $options |
|
| 321 | + * @param string|null $options |
|
| 322 | 322 | */ |
| 323 | 323 | public function generate($command, $options = '', $quiet=false) |
| 324 | 324 | { |
@@ -544,7 +544,7 @@ discard block |
||
| 544 | 544 | /** |
| 545 | 545 | * Scans through the collections for the folder for this generator. |
| 546 | 546 | * |
| 547 | - * @param $name |
|
| 547 | + * @param string $name |
|
| 548 | 548 | * |
| 549 | 549 | * @return null|string |
| 550 | 550 | */ |