silverstripe / silverstripe-framework

model/FieldType/DBCurrency.php

Doc Comments +6 added lines

@@ -23,6 +23,9 @@ 
 	 */
 	private static $currency_symbol = '$';
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
 		parent::__construct($name, $wholeSize, $decimalSize, $defaultValue);
 	}
@@ -46,6 +49,9 @@ 
 		else return $val;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	public function setValue($value, $record = null, $markChanged = true) {
 		$matches = null;
 		if(is_numeric($value)) {

model/FieldType/DBDate.php

Doc Comments +5 added lines, -2 removed lines

@@ -20,6 +20,9 @@ 
  */
 class Date extends DBField {
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value, $record = null, $markChanged = true) {
 		if($value === false || $value === null || (is_string($value) && !strlen($value))) {
 			// don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be
@@ -102,7 +105,7 @@ 
 
 	/**
 	 * Returns the day of the month.
-	 * @param boolean $includeOrdinals Include ordinal suffix to day, e.g. "th" or "rd"
+	 * @param boolean $includeOrdinal Include ordinal suffix to day, e.g. "th" or "rd"
 	 * @return string
 	 */
 	public function DayOfMonth($includeOrdinal = false) {
@@ -156,7 +159,7 @@ 
 	 * Return a date formatted as per a CMS user's settings.
 	 *
 	 * @param Member $member
-	 * @return boolean | string A date formatted as per user-defined settings.
+	 * @return false|string | string A date formatted as per user-defined settings.
 	 */
 	public function FormatFromSettings($member = null) {
 		require_once 'Zend/Date.php';

model/FieldType/DBDatetime.php

Doc Comments +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
 	 * Return a date and time formatted as per a CMS user's settings.
 	 *
 	 * @param Member $member
-	 * @return boolean | string A time and date pair formatted as per user-defined settings.
+	 * @return false|string | string A time and date pair formatted as per user-defined settings.
 	 */
 	public function FormatFromSettings($member = null) {
 		require_once 'Zend/Date.php';

model/FieldType/DBDecimal.php

Doc Comments +4 added lines, -4 removed lines

@@ -15,7 +15,7 @@ 
 	 * @param string $name
 	 * @param int $wholeSize
 	 * @param int $decimalSize
-	 * @param float $defaultValue
+	 * @param integer $defaultValue
 	 */
 	public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
 		$this->wholeSize = is_int($wholeSize) ? $wholeSize : 9;
@@ -27,14 +27,14 @@ 
 	}
 
 	/**
-	 * @return float
+	 * @return string
 	 */
 	public function Nice() {
 		return number_format($this->value, $this->decimalSize);
 	}
 
 	/**
-	 * @return int
+	 * @return double
 	 */
 	public function Int() {
 		return floor($this->value);
@@ -80,7 +80,7 @@ 
 	}
 
 	/**
-	 * @return float
+	 * @return integer
 	 */
 	public function nullValue() {
 		return 0;

model/FieldType/DBHTMLText.php

Doc Comments +3 added lines

@@ -36,6 +36,9 @@
 
 	protected $whitelist = false;
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct($name = null, $options = array()) {
 		if(is_string($options)) {
 			$options = array('whitelist' => $options);

model/FieldType/DBMoney.php

Doc Comments +8 added lines, -1 removed lines

@@ -101,6 +101,7 @@ 
 
 	/**
 	 * @param string
+	 * @param string|null $currency
 	 */
 	public function setCurrency($currency, $markChanged = true) {
 		$this->setField('Currency', $currency, $markChanged);
@@ -151,6 +152,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getSymbol($currency = null, $locale = null) {
@@ -162,6 +165,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getShortName($currency = null, $locale = null) {
@@ -172,6 +177,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getCurrencyName($currency = null, $locale = null) {
@@ -202,7 +209,7 @@ 
 	 * Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()}
 	 *
 	 * @param string $title Optional. Localized title of the generated instance
-	 * @return FormField
+	 * @return MoneyField
 	 */
 	public function scaffoldFormField($title = null) {
 		$field = new MoneyField($this->getName());

model/FieldType/DBTime.php

Doc Comments +3 added lines

@@ -55,6 +55,9 @@
 		if($this->value) return date($format, strtotime($this->value));
 	}
 
+	/**
+	 * @param string[] $parts
+	 */
 	public function TwelveHour( $parts ) {
 		$hour = $parts[1];
 		$min = $parts[2];

model/FieldType/DBYear.php

Doc Comments +3 added lines

@@ -18,6 +18,9 @@
 		DB::require_field($this->tableName, $this->name, $values);
 	}
 
+	/**
+	 * @param string $title
+	 */
 	public function scaffoldFormField($title = null, $params = null) {
 		$selectBox = new DropdownField($this->name, $title);
 		$selectBox->setSource($this->getDefaultOptions());

model/Map.php

Doc Comments +4 added lines

@@ -41,6 +41,7 @@ 
 	 * Set the key field for this map.
 	 *
 	 * @var string $keyField
+	 * @param string $keyField
 	 */
 	public function setKeyField($keyField) {
 		$this->keyField = $keyField;
@@ -50,6 +51,7 @@ 
 	 * Set the value field for this map.
 	 *
 	 * @var string $valueField
+	 * @param string $valueField
 	 */
 	public function setValueField($valueField) {
 		$this->valueField = $valueField;
@@ -95,6 +97,7 @@ 
 	 *
 	 * @var string $key
 	 * @var mixed $value
+	 * @param string $value
 	 */
 	public function unshift($key, $value) {
 		$oldItems = $this->firstItems;
@@ -114,6 +117,7 @@ 
 	 *
 	 * @var string $key
 	 * @var mixed $value
+	 * @param string $value
 	 */
 	public function push($key, $value) {
 		$oldItems = $this->lastItems;