@@ -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()); |
@@ -55,6 +55,9 @@ |
||
| 55 | 55 | if($this->value) return date($format, strtotime($this->value)); |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | + /** |
|
| 59 | + * @param string[] $parts |
|
| 60 | + */ |
|
| 58 | 61 | public function TwelveHour( $parts ) { |
| 59 | 62 | $hour = $parts[1]; |
| 60 | 63 | $min = $parts[2]; |
@@ -18,6 +18,9 @@ |
||
| 18 | 18 | DB::require_field($this->tableName, $this->name, $values); |
| 19 | 19 | } |
| 20 | 20 | |
| 21 | + /** |
|
| 22 | + * @param string $title |
|
| 23 | + */ |
|
| 21 | 24 | public function scaffoldFormField($title = null, $params = null) { |
| 22 | 25 | $selectBox = new DropdownField($this->name, $title); |
| 23 | 26 | $selectBox->setSource($this->getDefaultOptions()); |
@@ -41,6 +41,7 @@ discard block |
||
| 41 | 41 | * Set the key field for this map. |
| 42 | 42 | * |
| 43 | 43 | * @var string $keyField |
| 44 | + * @param string $keyField |
|
| 44 | 45 | */ |
| 45 | 46 | public function setKeyField($keyField) { |
| 46 | 47 | $this->keyField = $keyField; |
@@ -50,6 +51,7 @@ discard block |
||
| 50 | 51 | * Set the value field for this map. |
| 51 | 52 | * |
| 52 | 53 | * @var string $valueField |
| 54 | + * @param string $valueField |
|
| 53 | 55 | */ |
| 54 | 56 | public function setValueField($valueField) { |
| 55 | 57 | $this->valueField = $valueField; |
@@ -95,6 +97,7 @@ discard block |
||
| 95 | 97 | * |
| 96 | 98 | * @var string $key |
| 97 | 99 | * @var mixed $value |
| 100 | + * @param string $value |
|
| 98 | 101 | */ |
| 99 | 102 | public function unshift($key, $value) { |
| 100 | 103 | $oldItems = $this->firstItems; |
@@ -114,6 +117,7 @@ discard block |
||
| 114 | 117 | * |
| 115 | 118 | * @var string $key |
| 116 | 119 | * @var mixed $value |
| 120 | + * @param string $value |
|
| 117 | 121 | */ |
| 118 | 122 | public function push($key, $value) { |
| 119 | 123 | $oldItems = $this->lastItems; |
@@ -619,6 +619,11 @@ |
||
| 619 | 619 | 'ObjectTest_Extending_Extension' |
| 620 | 620 | ); |
| 621 | 621 | |
| 622 | + /** |
|
| 623 | + * @param integer $first |
|
| 624 | + * @param integer $second |
|
| 625 | + * @param integer $third |
|
| 626 | + */ |
|
| 622 | 627 | public function getResults(&$first, &$second, &$third) { |
| 623 | 628 | // Before extending should be invoked second |
| 624 | 629 | $this->beforeExtending('updateResult', function(&$first, &$second, &$third) { |
@@ -114,7 +114,7 @@ discard block |
||
| 114 | 114 | * Set a different instance than {@link Upload_Validator} |
| 115 | 115 | * for this upload session. |
| 116 | 116 | * |
| 117 | - * @param object $validator |
|
| 117 | + * @param Upload_Validator $validator |
|
| 118 | 118 | */ |
| 119 | 119 | public function setValidator($validator) { |
| 120 | 120 | $this->validator = $validator; |
@@ -363,7 +363,7 @@ discard block |
||
| 363 | 363 | /** |
| 364 | 364 | * Determines wether previous operations caused an error. |
| 365 | 365 | * |
| 366 | - * @return boolean |
|
| 366 | + * @return integer |
|
| 367 | 367 | */ |
| 368 | 368 | public function isError() { |
| 369 | 369 | return (count($this->errors)); |