@@ -59,7 +59,7 @@ |
||
| 59 | 59 | * @param string|array $permissionCode Optional |
| 60 | 60 | * @param boolean $tryUsingSessionLogin If true, then the method with authenticate against the |
| 61 | 61 | * session log-in if those credentials are disabled. |
| 62 | - * @return bool|Member |
|
| 62 | + * @return null|Member |
|
| 63 | 63 | * @throws HTTPResponse_Exception |
| 64 | 64 | */ |
| 65 | 65 | public static function requireLogin( |
@@ -201,12 +201,12 @@ discard block |
||
| 201 | 201 | |
| 202 | 202 | /** |
| 203 | 203 | * Email constructor. |
| 204 | - * @param string|array|null $from |
|
| 205 | - * @param string|array|null $to |
|
| 204 | + * @param string $from |
|
| 205 | + * @param string $to |
|
| 206 | 206 | * @param string|null $subject |
| 207 | 207 | * @param string|null $body |
| 208 | - * @param string|array|null $cc |
|
| 209 | - * @param string|array|null $bcc |
|
| 208 | + * @param string $cc |
|
| 209 | + * @param string $bcc |
|
| 210 | 210 | * @param string|null $returnPath |
| 211 | 211 | */ |
| 212 | 212 | public function __construct( |
@@ -292,7 +292,7 @@ discard block |
||
| 292 | 292 | } |
| 293 | 293 | |
| 294 | 294 | /** |
| 295 | - * @param string|array $address |
|
| 295 | + * @param string $address |
|
| 296 | 296 | * @param string|null $name |
| 297 | 297 | * @return $this |
| 298 | 298 | */ |
@@ -369,7 +369,7 @@ discard block |
||
| 369 | 369 | } |
| 370 | 370 | |
| 371 | 371 | /** |
| 372 | - * @param string|array $address |
|
| 372 | + * @param string $address |
|
| 373 | 373 | * @param string|null $name |
| 374 | 374 | * @return $this |
| 375 | 375 | */ |
@@ -401,7 +401,7 @@ discard block |
||
| 401 | 401 | } |
| 402 | 402 | |
| 403 | 403 | /** |
| 404 | - * @param string|array $address |
|
| 404 | + * @param string $address |
|
| 405 | 405 | * @param string|null $name |
| 406 | 406 | * @return $this |
| 407 | 407 | */ |
@@ -433,7 +433,7 @@ discard block |
||
| 433 | 433 | } |
| 434 | 434 | |
| 435 | 435 | /** |
| 436 | - * @param string|array $address |
|
| 436 | + * @param string $address |
|
| 437 | 437 | * @param string|null $name |
| 438 | 438 | * @return $this |
| 439 | 439 | */ |
@@ -450,7 +450,7 @@ discard block |
||
| 450 | 450 | } |
| 451 | 451 | |
| 452 | 452 | /** |
| 453 | - * @param string|array $address |
|
| 453 | + * @param string $address |
|
| 454 | 454 | * @param string|null $name |
| 455 | 455 | * @return $this |
| 456 | 456 | */ |
@@ -462,7 +462,7 @@ discard block |
||
| 462 | 462 | } |
| 463 | 463 | |
| 464 | 464 | /** |
| 465 | - * @param string|array $address |
|
| 465 | + * @param string $address |
|
| 466 | 466 | * @param string|null $name |
| 467 | 467 | * @return $this |
| 468 | 468 | */ |
@@ -568,7 +568,7 @@ discard block |
||
| 568 | 568 | } |
| 569 | 569 | |
| 570 | 570 | /** |
| 571 | - * @param string|array $name The data name to add or array to names => value |
|
| 571 | + * @param string $name The data name to add or array to names => value |
|
| 572 | 572 | * @param string|null $value The value of the data to add |
| 573 | 573 | * @return $this |
| 574 | 574 | */ |
@@ -739,7 +739,7 @@ discard block |
||
| 739 | 739 | } |
| 740 | 740 | |
| 741 | 741 | /** |
| 742 | - * @return array|bool |
|
| 742 | + * @return boolean |
|
| 743 | 743 | */ |
| 744 | 744 | public function sendPlain() |
| 745 | 745 | { |
@@ -795,7 +795,7 @@ discard block |
||
| 795 | 795 | } |
| 796 | 796 | |
| 797 | 797 | /** |
| 798 | - * @return Swift_MimePart|false |
|
| 798 | + * @return \Swift_Mime_MimeEntity |
|
| 799 | 799 | */ |
| 800 | 800 | public function findPlainPart() |
| 801 | 801 | { |
@@ -47,6 +47,9 @@ discard block |
||
| 47 | 47 | */ |
| 48 | 48 | protected $token = null; |
| 49 | 49 | |
| 50 | + /** |
|
| 51 | + * @param string $token |
|
| 52 | + */ |
|
| 50 | 53 | protected function pathForToken($token) |
| 51 | 54 | { |
| 52 | 55 | return TEMP_FOLDER.'/token_'.preg_replace('/[^a-z0-9]+/', '', $token); |
@@ -222,7 +225,7 @@ discard block |
||
| 222 | 225 | * Given a list of token names, suppress all tokens that have not been validated, and |
| 223 | 226 | * return the non-validated token with the highest priority |
| 224 | 227 | * |
| 225 | - * @param array $keys List of token keys in ascending priority (low to high) |
|
| 228 | + * @param string[] $keys List of token keys in ascending priority (low to high) |
|
| 226 | 229 | * @param HTTPRequest $request |
| 227 | 230 | * @return ParameterConfirmationToken The token container for the unvalidated $key given with the highest priority |
| 228 | 231 | */ |
@@ -141,6 +141,10 @@ |
||
| 141 | 141 | * |
| 142 | 142 | * @return BulkLoader_Result See {@link self::processAll()} |
| 143 | 143 | */ |
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * @param string $filepath |
|
| 147 | + */ |
|
| 144 | 148 | public function load($filepath) |
| 145 | 149 | { |
| 146 | 150 | Environment::increaseTimeLimitTo(3600); |
@@ -284,6 +284,9 @@ |
||
| 284 | 284 | return $this->errors; |
| 285 | 285 | } |
| 286 | 286 | |
| 287 | + /** |
|
| 288 | + * @param string $filename |
|
| 289 | + */ |
|
| 287 | 290 | public function writeToFile($filename, $content) |
| 288 | 291 | { |
| 289 | 292 | $base = $this->getBaseDir(); |
@@ -775,7 +775,7 @@ discard block |
||
| 775 | 775 | * @param string $expectedSQL |
| 776 | 776 | * @param string $actualSQL |
| 777 | 777 | * @param string $message |
| 778 | - * @param float|int $delta |
|
| 778 | + * @param integer $delta |
|
| 779 | 779 | * @param integer $maxDepth |
| 780 | 780 | * @param boolean $canonicalize |
| 781 | 781 | * @param boolean $ignoreCase |
@@ -1074,7 +1074,7 @@ discard block |
||
| 1074 | 1074 | * Create a member and group with the given permission code, and log in with it. |
| 1075 | 1075 | * Returns the member ID. |
| 1076 | 1076 | * |
| 1077 | - * @param string|array $permCode Either a permission, or list of permissions |
|
| 1077 | + * @param string $permCode Either a permission, or list of permissions |
|
| 1078 | 1078 | * @return int Member ID |
| 1079 | 1079 | */ |
| 1080 | 1080 | public function logInWithPermission($permCode = "ADMIN") |
@@ -53,12 +53,6 @@ |
||
| 53 | 53 | * @param string $entity Entity that identifies the string. It must be in the form |
| 54 | 54 | * "Namespace.Entity" where Namespace will be usually the class name where this |
| 55 | 55 | * string is used and Entity identifies the string inside the namespace. |
| 56 | - * @param mixed $arg,... Additional arguments are parsed as such: |
|
| 57 | - * - Next string argument is a default. Pass in a `|` pipe-delimeted value with `{count}` |
|
| 58 | - * to do pluralisation. |
|
| 59 | - * - Any other string argument after default is context for i18nTextCollector |
|
| 60 | - * - Any array argument in any order is an injection parameter list. Pass in a `count` |
|
| 61 | - * injection parameter to pluralise. |
|
| 62 | 56 | * @return string |
| 63 | 57 | */ |
| 64 | 58 | function _t($entity, $arg = null) |
@@ -2397,6 +2397,7 @@ discard block |
||
| 2397 | 2397 | |
| 2398 | 2398 | /** |
| 2399 | 2399 | * {@inheritdoc} |
| 2400 | + * @param string $field |
|
| 2400 | 2401 | */ |
| 2401 | 2402 | public function castingHelper($field) |
| 2402 | 2403 | { |
@@ -2502,7 +2503,7 @@ discard block |
||
| 2502 | 2503 | * </code> |
| 2503 | 2504 | * |
| 2504 | 2505 | * @param string $methodName Method on the same object, e.g. {@link canEdit()} |
| 2505 | - * @param Member|int $member |
|
| 2506 | + * @param null|Member $member |
|
| 2506 | 2507 | * @param array $context Optional context |
| 2507 | 2508 | * @return boolean|null |
| 2508 | 2509 | */ |
@@ -2525,7 +2526,7 @@ discard block |
||
| 2525 | 2526 | |
| 2526 | 2527 | /** |
| 2527 | 2528 | * @param Member $member |
| 2528 | - * @return boolean |
|
| 2529 | + * @return boolean|string |
|
| 2529 | 2530 | */ |
| 2530 | 2531 | public function canView($member = null) |
| 2531 | 2532 | { |
@@ -2538,7 +2539,7 @@ discard block |
||
| 2538 | 2539 | |
| 2539 | 2540 | /** |
| 2540 | 2541 | * @param Member $member |
| 2541 | - * @return boolean |
|
| 2542 | + * @return boolean|string |
|
| 2542 | 2543 | */ |
| 2543 | 2544 | public function canEdit($member = null) |
| 2544 | 2545 | { |
@@ -2551,7 +2552,7 @@ discard block |
||
| 2551 | 2552 | |
| 2552 | 2553 | /** |
| 2553 | 2554 | * @param Member $member |
| 2554 | - * @return boolean |
|
| 2555 | + * @return boolean|string |
|
| 2555 | 2556 | */ |
| 2556 | 2557 | public function canDelete($member = null) |
| 2557 | 2558 | { |
@@ -2566,7 +2567,7 @@ discard block |
||
| 2566 | 2567 | * @param Member $member |
| 2567 | 2568 | * @param array $context Additional context-specific data which might |
| 2568 | 2569 | * affect whether (or where) this object could be created. |
| 2569 | - * @return boolean |
|
| 2570 | + * @return boolean|string |
|
| 2570 | 2571 | */ |
| 2571 | 2572 | public function canCreate($member = null, $context = array()) |
| 2572 | 2573 | { |
@@ -2683,7 +2684,7 @@ discard block |
||
| 2683 | 2684 | * Traverses to a field referenced by relationships between data objects, returning the value |
| 2684 | 2685 | * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName) |
| 2685 | 2686 | * |
| 2686 | - * @param $fieldName string |
|
| 2687 | + * @param string $fieldName string |
|
| 2687 | 2688 | * @return string | null - will return null on a missing value |
| 2688 | 2689 | */ |
| 2689 | 2690 | public function relField($fieldName) |
@@ -2762,7 +2763,7 @@ discard block |
||
| 2762 | 2763 | * @param string $callerClass The class of objects to be returned |
| 2763 | 2764 | * @param string|array $filter A filter to be inserted into the WHERE clause. |
| 2764 | 2765 | * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples. |
| 2765 | - * @param string|array $sort A sort expression to be inserted into the ORDER |
|
| 2766 | + * @param string $sort A sort expression to be inserted into the ORDER |
|
| 2766 | 2767 | * BY clause. If omitted, self::$default_sort will be used. |
| 2767 | 2768 | * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead. |
| 2768 | 2769 | * @param string|array $limit A limit expression to be inserted into the LIMIT clause. |
@@ -51,7 +51,7 @@ discard block |
||
| 51 | 51 | * Only increases up to the maximum defined in {@link setMemoryLimitMax()}, |
| 52 | 52 | * and defaults to the 'memory_limit' setting in the PHP configuration. |
| 53 | 53 | * |
| 54 | - * @param string|float|int $memoryLimit A memory limit string, such as "64M". If omitted, unlimited memory will be set. |
|
| 54 | + * @param integer $memoryLimit A memory limit string, such as "64M". If omitted, unlimited memory will be set. |
|
| 55 | 55 | * @return bool true indicates a successful change, false a denied change. |
| 56 | 56 | */ |
| 57 | 57 | public static function increaseMemoryLimitTo($memoryLimit = -1) |
@@ -96,7 +96,7 @@ discard block |
||
| 96 | 96 | } |
| 97 | 97 | |
| 98 | 98 | /** |
| 99 | - * @return int Memory limit in bytes |
|
| 99 | + * @return double Memory limit in bytes |
|
| 100 | 100 | */ |
| 101 | 101 | public static function getMemoryLimitMax() |
| 102 | 102 | { |