@@ -112,6 +112,7 @@ |
||
| 112 | 112 | |
| 113 | 113 | /** |
| 114 | 114 | * Clean up the input to be used as a regex. |
| 115 | + * @param string $value |
|
| 115 | 116 | */ |
| 116 | 117 | public function __formatAsRegex($value) |
| 117 | 118 | { |
@@ -13,6 +13,9 @@ |
||
| 13 | 13 | { |
| 14 | 14 | protected static $realm = 'YetiForceApi'; |
| 15 | 15 | |
| 16 | + /** |
|
| 17 | + * @param \Api\Controller $self |
|
| 18 | + */ |
|
| 16 | 19 | public static function init($self) |
| 17 | 20 | { |
| 18 | 21 | $method = \AppConfig::api('AUTH_METHOD'); |
@@ -61,7 +61,7 @@ |
||
| 61 | 61 | * |
| 62 | 62 | * @throws \Api\Core\Exception |
| 63 | 63 | * |
| 64 | - * @return bool |
|
| 64 | + * @return boolean|null |
|
| 65 | 65 | */ |
| 66 | 66 | public function checkPermission() |
| 67 | 67 | { |
@@ -11,6 +11,9 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | class Exception extends \Exception |
| 13 | 13 | { |
| 14 | + /** |
|
| 15 | + * @param string $message |
|
| 16 | + */ |
|
| 14 | 17 | public function __construct($message, $code = 200, self $previous = null) |
| 15 | 18 | { |
| 16 | 19 | if (!empty($previous)) { |
@@ -32,7 +32,7 @@ discard block |
||
| 32 | 32 | * |
| 33 | 33 | * @throws \Api\Core\Exception |
| 34 | 34 | * |
| 35 | - * @return bool |
|
| 35 | + * @return boolean|null |
|
| 36 | 36 | */ |
| 37 | 37 | public function checkPermission() |
| 38 | 38 | { |
@@ -84,7 +84,7 @@ discard block |
||
| 84 | 84 | * @param int $parentId |
| 85 | 85 | * @param string $type |
| 86 | 86 | * |
| 87 | - * @return bool |
|
| 87 | + * @return boolean|null |
|
| 88 | 88 | */ |
| 89 | 89 | public function getRecords(\App\QueryGenerator $mainQueryGenerator, $parentId, $type = 'child') |
| 90 | 90 | { |
@@ -26,7 +26,7 @@ |
||
| 26 | 26 | /** |
| 27 | 27 | * Put method. |
| 28 | 28 | * |
| 29 | - * @return array |
|
| 29 | + * @return boolean |
|
| 30 | 30 | */ |
| 31 | 31 | public function put() |
| 32 | 32 | { |
@@ -61,7 +61,6 @@ discard block |
||
| 61 | 61 | } |
| 62 | 62 | |
| 63 | 63 | /** |
| 64 | - * @param Users $user |
|
| 65 | 64 | * |
| 66 | 65 | * @return string |
| 67 | 66 | */ |
@@ -156,7 +155,6 @@ discard block |
||
| 156 | 155 | |
| 157 | 156 | /** |
| 158 | 157 | * @param string $date |
| 159 | - * @param Users $user |
|
| 160 | 158 | * |
| 161 | 159 | * @return string |
| 162 | 160 | */ |
@@ -346,6 +344,9 @@ discard block |
||
| 346 | 344 | return $time; |
| 347 | 345 | } |
| 348 | 346 | |
| 347 | + /** |
|
| 348 | + * @param string $value |
|
| 349 | + */ |
|
| 349 | 350 | private static function sanitizeDate($value, $user) |
| 350 | 351 | { |
| 351 | 352 | if (empty($user)) { |
@@ -273,7 +273,7 @@ discard block |
||
| 273 | 273 | * @param int $month |
| 274 | 274 | * @param DateTime $dateObject |
| 275 | 275 | * |
| 276 | - * @return date range of present quarter |
|
| 276 | + * @return string[] range of present quarter |
|
| 277 | 277 | */ |
| 278 | 278 | public static function getPresentQuarterRange($month = 0, &$dateObject = null) |
| 279 | 279 | { |
@@ -308,7 +308,7 @@ discard block |
||
| 308 | 308 | * @param int $month |
| 309 | 309 | * @param DateTime $dateObject |
| 310 | 310 | * |
| 311 | - * @return date range of present quarter |
|
| 311 | + * @return string[] range of present quarter |
|
| 312 | 312 | */ |
| 313 | 313 | public static function getPreviousQuarterRange($month = 0, &$dateObject = null) |
| 314 | 314 | { |
@@ -344,7 +344,7 @@ discard block |
||
| 344 | 344 | * @param int $month |
| 345 | 345 | * @param DateTime $dateObject |
| 346 | 346 | * |
| 347 | - * @return date range of present quarter |
|
| 347 | + * @return string[] range of present quarter |
|
| 348 | 348 | */ |
| 349 | 349 | public static function getNextQuarterRange($month = 0, $dateObject = null) |
| 350 | 350 | { |
@@ -58,6 +58,7 @@ discard block |
||
| 58 | 58 | |
| 59 | 59 | /** |
| 60 | 60 | * Set headers to send. |
| 61 | + * @param string $header |
|
| 61 | 62 | */ |
| 62 | 63 | public function setHeader($header) |
| 63 | 64 | { |
@@ -78,6 +79,7 @@ discard block |
||
| 78 | 79 | |
| 79 | 80 | /** |
| 80 | 81 | * Set emit type. |
| 82 | + * @param integer $type |
|
| 81 | 83 | */ |
| 82 | 84 | public function setEmitType($type) |
| 83 | 85 | { |