@@ -646,7 +646,7 @@ discard block |
||
646 | 646 | * @param boolean $create Flag indicating whether the database should be created |
647 | 647 | * if it doesn't exist. If $create is false and the database doesn't exist |
648 | 648 | * 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 |
|
649 | + * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error |
|
650 | 650 | * should be raised |
651 | 651 | * @return boolean Flag indicating success |
652 | 652 | */ |
@@ -681,7 +681,7 @@ discard block |
||
681 | 681 | /** |
682 | 682 | * Returns the name of the currently selected database |
683 | 683 | * |
684 | - * @return string|null Name of the selected database, or null if none selected |
|
684 | + * @return string Name of the selected database, or null if none selected |
|
685 | 685 | */ |
686 | 686 | public function getSelectedDatabase() { |
687 | 687 | return $this->connector->getSelectedDatabase(); |
@@ -806,6 +806,7 @@ discard block |
||
806 | 806 | |
807 | 807 | /** |
808 | 808 | * @deprecated since version 4.0 Use DB::field_list instead |
809 | + * @param string $table |
|
809 | 810 | */ |
810 | 811 | public function fieldList($table) { |
811 | 812 | Deprecation::notice('4.0', 'Use DB::field_list instead'); |
@@ -186,6 +186,9 @@ |
||
186 | 186 | return $classNames; |
187 | 187 | } |
188 | 188 | |
189 | + /** |
|
190 | + * @param \DBClassNameTest_ObjectSubClass $record |
|
191 | + */ |
|
189 | 192 | public function setValue($value, $record = null, $markChanged = true) { |
190 | 193 | parent::setValue($value, $record, $markChanged); |
191 | 194 |
@@ -205,6 +205,9 @@ |
||
205 | 205 | return null; |
206 | 206 | } |
207 | 207 | |
208 | + /** |
|
209 | + * @param string $field |
|
210 | + */ |
|
208 | 211 | public function hasField($field) { |
209 | 212 | $fields = $this->compositeDatabaseFields(); |
210 | 213 | return isset($fields[$field]); |
@@ -23,6 +23,9 @@ discard block |
||
23 | 23 | */ |
24 | 24 | private static $currency_symbol = '$'; |
25 | 25 | |
26 | + /** |
|
27 | + * @param string $name |
|
28 | + */ |
|
26 | 29 | public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) { |
27 | 30 | parent::__construct($name, $wholeSize, $decimalSize, $defaultValue); |
28 | 31 | } |
@@ -46,6 +49,9 @@ discard block |
||
46 | 49 | else return $val; |
47 | 50 | } |
48 | 51 | |
52 | + /** |
|
53 | + * @param string $value |
|
54 | + */ |
|
49 | 55 | public function setValue($value, $record = null, $markChanged = true) { |
50 | 56 | $matches = null; |
51 | 57 | if(is_numeric($value)) { |
@@ -20,6 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class Date extends DBField { |
22 | 22 | |
23 | + /** |
|
24 | + * @param string|null $value |
|
25 | + */ |
|
23 | 26 | public function setValue($value, $record = null, $markChanged = true) { |
24 | 27 | if($value === false || $value === null || (is_string($value) && !strlen($value))) { |
25 | 28 | // don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be |
@@ -102,7 +105,7 @@ discard block |
||
102 | 105 | |
103 | 106 | /** |
104 | 107 | * Returns the day of the month. |
105 | - * @param boolean $includeOrdinals Include ordinal suffix to day, e.g. "th" or "rd" |
|
108 | + * @param boolean $includeOrdinal Include ordinal suffix to day, e.g. "th" or "rd" |
|
106 | 109 | * @return string |
107 | 110 | */ |
108 | 111 | public function DayOfMonth($includeOrdinal = false) { |
@@ -156,7 +159,7 @@ discard block |
||
156 | 159 | * Return a date formatted as per a CMS user's settings. |
157 | 160 | * |
158 | 161 | * @param Member $member |
159 | - * @return boolean | string A date formatted as per user-defined settings. |
|
162 | + * @return false|string | string A date formatted as per user-defined settings. |
|
160 | 163 | */ |
161 | 164 | public function FormatFromSettings($member = null) { |
162 | 165 | require_once 'Zend/Date.php'; |
@@ -108,7 +108,7 @@ |
||
108 | 108 | * Return a date and time formatted as per a CMS user's settings. |
109 | 109 | * |
110 | 110 | * @param Member $member |
111 | - * @return boolean | string A time and date pair formatted as per user-defined settings. |
|
111 | + * @return false|string | string A time and date pair formatted as per user-defined settings. |
|
112 | 112 | */ |
113 | 113 | public function FormatFromSettings($member = null) { |
114 | 114 | require_once 'Zend/Date.php'; |
@@ -15,7 +15,7 @@ discard block |
||
15 | 15 | * @param string $name |
16 | 16 | * @param int $wholeSize |
17 | 17 | * @param int $decimalSize |
18 | - * @param float $defaultValue |
|
18 | + * @param integer $defaultValue |
|
19 | 19 | */ |
20 | 20 | public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) { |
21 | 21 | $this->wholeSize = is_int($wholeSize) ? $wholeSize : 9; |
@@ -27,14 +27,14 @@ discard block |
||
27 | 27 | } |
28 | 28 | |
29 | 29 | /** |
30 | - * @return float |
|
30 | + * @return string |
|
31 | 31 | */ |
32 | 32 | public function Nice() { |
33 | 33 | return number_format($this->value, $this->decimalSize); |
34 | 34 | } |
35 | 35 | |
36 | 36 | /** |
37 | - * @return int |
|
37 | + * @return double |
|
38 | 38 | */ |
39 | 39 | public function Int() { |
40 | 40 | return floor($this->value); |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | } |
81 | 81 | |
82 | 82 | /** |
83 | - * @return float |
|
83 | + * @return integer |
|
84 | 84 | */ |
85 | 85 | public function nullValue() { |
86 | 86 | return 0; |
@@ -36,6 +36,9 @@ |
||
36 | 36 | |
37 | 37 | protected $whitelist = false; |
38 | 38 | |
39 | + /** |
|
40 | + * @param string $name |
|
41 | + */ |
|
39 | 42 | public function __construct($name = null, $options = array()) { |
40 | 43 | if(is_string($options)) { |
41 | 44 | $options = array('whitelist' => $options); |
@@ -101,6 +101,7 @@ discard block |
||
101 | 101 | |
102 | 102 | /** |
103 | 103 | * @param string |
104 | + * @param string|null $currency |
|
104 | 105 | */ |
105 | 106 | public function setCurrency($currency, $markChanged = true) { |
106 | 107 | $this->setField('Currency', $currency, $markChanged); |
@@ -151,6 +152,8 @@ discard block |
||
151 | 152 | } |
152 | 153 | |
153 | 154 | /** |
155 | + * @param string $currency |
|
156 | + * @param string $locale |
|
154 | 157 | * @return string |
155 | 158 | */ |
156 | 159 | public function getSymbol($currency = null, $locale = null) { |
@@ -162,6 +165,8 @@ discard block |
||
162 | 165 | } |
163 | 166 | |
164 | 167 | /** |
168 | + * @param string $currency |
|
169 | + * @param string $locale |
|
165 | 170 | * @return string |
166 | 171 | */ |
167 | 172 | public function getShortName($currency = null, $locale = null) { |
@@ -172,6 +177,8 @@ discard block |
||
172 | 177 | } |
173 | 178 | |
174 | 179 | /** |
180 | + * @param string $currency |
|
181 | + * @param string $locale |
|
175 | 182 | * @return string |
176 | 183 | */ |
177 | 184 | public function getCurrencyName($currency = null, $locale = null) { |
@@ -202,7 +209,7 @@ discard block |
||
202 | 209 | * Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()} |
203 | 210 | * |
204 | 211 | * @param string $title Optional. Localized title of the generated instance |
205 | - * @return FormField |
|
212 | + * @return MoneyField |
|
206 | 213 | */ |
207 | 214 | public function scaffoldFormField($title = null) { |
208 | 215 | $field = new MoneyField($this->getName()); |