@@ -2156,6 +2156,7 @@ discard block |
||
2156 | 2156 | |
2157 | 2157 | /** |
2158 | 2158 | * @param String |
2159 | + * @param string $name |
|
2159 | 2160 | * @return Zend_Translate |
2160 | 2161 | */ |
2161 | 2162 | public static function get_translator($name) { |
@@ -2169,6 +2170,7 @@ discard block |
||
2169 | 2170 | * @param Zend_Translate Needs to implement {@link i18nTranslateAdapterInterface} |
2170 | 2171 | * @param String If left blank will override the default translator. |
2171 | 2172 | * @param Int |
2173 | + * @param string $name |
|
2172 | 2174 | */ |
2173 | 2175 | public static function register_translator($translator, $name, $priority = 10) { |
2174 | 2176 | if (!is_int($priority)) throw new InvalidArgumentException("register_translator expects an int priority"); |
@@ -2298,7 +2300,7 @@ discard block |
||
2298 | 2300 | * |
2299 | 2301 | * @see get_locale_name() |
2300 | 2302 | * |
2301 | - * @param mixed $code Language code |
|
2303 | + * @param string $code Language code |
|
2302 | 2304 | * @param boolean $native If true, the native name will be returned |
2303 | 2305 | * @return Name of the language |
2304 | 2306 | */ |
@@ -2455,6 +2457,7 @@ discard block |
||
2455 | 2457 | * |
2456 | 2458 | * Note: Does not check for {@link $allowed_locales}. |
2457 | 2459 | * |
2460 | + * @param string $locale |
|
2458 | 2461 | * @return boolean |
2459 | 2462 | */ |
2460 | 2463 | public static function validate_locale($locale) { |
@@ -387,7 +387,7 @@ discard block |
||
387 | 387 | * |
388 | 388 | * Note that columns may be double quoted as per ANSI sql standard |
389 | 389 | * |
390 | - * @return DataList |
|
390 | + * @return ArrayList |
|
391 | 391 | * @see SS_List::sort() |
392 | 392 | * @example $list->sort('Name'); // default ASC sorting |
393 | 393 | * @example $list->sort('Name DESC'); // DESC sorting |
@@ -523,6 +523,9 @@ discard block |
||
523 | 523 | return $list; |
524 | 524 | } |
525 | 525 | |
526 | + /** |
|
527 | + * @param integer $id |
|
528 | + */ |
|
526 | 529 | public function byID($id) { |
527 | 530 | $firstElement = $this->filter("ID", $id)->first(); |
528 | 531 | |
@@ -624,7 +627,6 @@ discard block |
||
624 | 627 | /** |
625 | 628 | * Returns whether an item with $key exists |
626 | 629 | * |
627 | - * @param mixed $key |
|
628 | 630 | * @return bool |
629 | 631 | */ |
630 | 632 | public function offsetExists($offset) { |
@@ -634,7 +636,6 @@ discard block |
||
634 | 636 | /** |
635 | 637 | * Returns item stored in list with index $key |
636 | 638 | * |
637 | - * @param mixed $key |
|
638 | 639 | * @return DataObject |
639 | 640 | */ |
640 | 641 | public function offsetGet($offset) { |
@@ -644,7 +645,6 @@ discard block |
||
644 | 645 | /** |
645 | 646 | * Set an item with the key in $key |
646 | 647 | * |
647 | - * @param mixed $key |
|
648 | 648 | * @param mixed $value |
649 | 649 | */ |
650 | 650 | public function offsetSet($offset, $value) { |
@@ -658,7 +658,6 @@ discard block |
||
658 | 658 | /** |
659 | 659 | * Unset an item with the key in $key |
660 | 660 | * |
661 | - * @param mixed $key |
|
662 | 661 | */ |
663 | 662 | public function offsetUnset($offset) { |
664 | 663 | unset($this->items[$offset]); |
@@ -406,6 +406,7 @@ discard block |
||
406 | 406 | * - minutes |
407 | 407 | * - seconds |
408 | 408 | * This includes the singular forms as well |
409 | + * @param string $date |
|
409 | 410 | * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of |
410 | 411 | * the addition |
411 | 412 | */ |
@@ -419,6 +420,7 @@ discard block |
||
419 | 420 | * e.g. '"SiteTree"."Created"' |
420 | 421 | * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime |
421 | 422 | * like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' |
423 | + * @param string $date1 |
|
422 | 424 | * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which |
423 | 425 | * is the result of the substraction |
424 | 426 | */ |
@@ -646,7 +648,7 @@ discard block |
||
646 | 648 | * @param boolean $create Flag indicating whether the database should be created |
647 | 649 | * if it doesn't exist. If $create is false and the database doesn't exist |
648 | 650 | * then an error will be raised |
649 | - * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error |
|
651 | + * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error |
|
650 | 652 | * should be raised |
651 | 653 | * @return boolean Flag indicating success |
652 | 654 | */ |
@@ -681,7 +683,7 @@ discard block |
||
681 | 683 | /** |
682 | 684 | * Returns the name of the currently selected database |
683 | 685 | * |
684 | - * @return string|null Name of the selected database, or null if none selected |
|
686 | + * @return string Name of the selected database, or null if none selected |
|
685 | 687 | */ |
686 | 688 | public function getSelectedDatabase() { |
687 | 689 | return $this->connector->getSelectedDatabase(); |
@@ -806,6 +808,7 @@ discard block |
||
806 | 808 | |
807 | 809 | /** |
808 | 810 | * @deprecated since version 4.0 Use DB::field_list instead |
811 | + * @param string $table |
|
809 | 812 | */ |
810 | 813 | public function fieldList($table) { |
811 | 814 | Deprecation::notice('4.0', 'Use DB::field_list instead'); |
@@ -38,7 +38,6 @@ discard block |
||
38 | 38 | /** |
39 | 39 | * Injector injection point for database controller |
40 | 40 | * |
41 | - * @param SS_Database $connector |
|
42 | 41 | */ |
43 | 42 | public function setDatabase(SS_Database $database) { |
44 | 43 | $this->database = $database; |
@@ -104,6 +103,7 @@ discard block |
||
104 | 103 | * |
105 | 104 | * @var callable $callback |
106 | 105 | * @throws Exception |
106 | + * @param Closure $callback |
|
107 | 107 | */ |
108 | 108 | public function schemaUpdate($callback) { |
109 | 109 | // Begin schema update |
@@ -476,7 +476,7 @@ discard block |
||
476 | 476 | /** |
477 | 477 | * Given an index spec determines the index type |
478 | 478 | * |
479 | - * @param array|string $spec |
|
479 | + * @param string $spec |
|
480 | 480 | * @return string |
481 | 481 | */ |
482 | 482 | protected function determineIndexType($spec) { |
@@ -544,7 +544,7 @@ discard block |
||
544 | 544 | /** |
545 | 545 | * Returns true if the given table is exists in the current database |
546 | 546 | * |
547 | - * @param string $table Name of table to check |
|
547 | + * @param string $tableName Name of table to check |
|
548 | 548 | * @return boolean Flag indicating existence of table |
549 | 549 | */ |
550 | 550 | abstract public function hasTable($tableName); |
@@ -115,6 +115,9 @@ |
||
115 | 115 | $this->query("ALTER TABLE \"$tableName\" $alterations"); |
116 | 116 | } |
117 | 117 | |
118 | + /** |
|
119 | + * @param string $tableName |
|
120 | + */ |
|
118 | 121 | public function isView($tableName) { |
119 | 122 | $info = $this->query("SHOW /*!50002 FULL*/ TABLES LIKE '$tableName'")->record(); |
120 | 123 | return $info && strtoupper($info['Table_type']) == 'VIEW'; |
@@ -50,6 +50,7 @@ |
||
50 | 50 | * |
51 | 51 | * @param DataObject (Optional) |
52 | 52 | * @param DataObject |
53 | + * @param DataObject|null $fromRecord |
|
53 | 54 | */ |
54 | 55 | public function __construct($fromRecord, DataObject $toRecord) { |
55 | 56 | if(!$toRecord) user_error("DataDifferencer constructed without a toRecord", E_USER_WARNING); |
@@ -28,6 +28,9 @@ discard block |
||
28 | 28 | */ |
29 | 29 | private static $currency_symbol = '$'; |
30 | 30 | |
31 | + /** |
|
32 | + * @param string $name |
|
33 | + */ |
|
31 | 34 | public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) { |
32 | 35 | parent::__construct($name, $wholeSize, $decimalSize, $defaultValue); |
33 | 36 | } |
@@ -51,6 +54,9 @@ discard block |
||
51 | 54 | else return $val; |
52 | 55 | } |
53 | 56 | |
57 | + /** |
|
58 | + * @param string $value |
|
59 | + */ |
|
54 | 60 | public function setValue($value, $record = null, $markChanged = true) { |
55 | 61 | $matches = null; |
56 | 62 | if(is_numeric($value)) { |
@@ -31,6 +31,9 @@ discard block |
||
31 | 31 | */ |
32 | 32 | class DBDate extends DBField { |
33 | 33 | |
34 | + /** |
|
35 | + * @param string $value |
|
36 | + */ |
|
34 | 37 | public function setValue($value, $record = null, $markChanged = true) { |
35 | 38 | if($value === false || $value === null || (is_string($value) && !strlen($value))) { |
36 | 39 | // don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be |
@@ -113,7 +116,7 @@ discard block |
||
113 | 116 | |
114 | 117 | /** |
115 | 118 | * Returns the day of the month. |
116 | - * @param boolean $includeOrdinals Include ordinal suffix to day, e.g. "th" or "rd" |
|
119 | + * @param boolean $includeOrdinal Include ordinal suffix to day, e.g. "th" or "rd" |
|
117 | 120 | * @return string |
118 | 121 | */ |
119 | 122 | public function DayOfMonth($includeOrdinal = false) { |
@@ -21,7 +21,7 @@ discard block |
||
21 | 21 | * @param string $name |
22 | 22 | * @param int $wholeSize |
23 | 23 | * @param int $decimalSize |
24 | - * @param float $defaultValue |
|
24 | + * @param integer $defaultValue |
|
25 | 25 | */ |
26 | 26 | public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) { |
27 | 27 | $this->wholeSize = is_int($wholeSize) ? $wholeSize : 9; |
@@ -33,14 +33,14 @@ discard block |
||
33 | 33 | } |
34 | 34 | |
35 | 35 | /** |
36 | - * @return float |
|
36 | + * @return string |
|
37 | 37 | */ |
38 | 38 | public function Nice() { |
39 | 39 | return number_format($this->value, $this->decimalSize); |
40 | 40 | } |
41 | 41 | |
42 | 42 | /** |
43 | - * @return int |
|
43 | + * @return double |
|
44 | 44 | */ |
45 | 45 | public function Int() { |
46 | 46 | return floor($this->value); |
@@ -86,7 +86,7 @@ discard block |
||
86 | 86 | } |
87 | 87 | |
88 | 88 | /** |
89 | - * @return float |
|
89 | + * @return integer |
|
90 | 90 | */ |
91 | 91 | public function nullValue() { |
92 | 92 | return 0; |