silverstripe / silverstripe-framework

model/DataDifferencer.php

Doc Comments +1 added lines

@@ -47,6 +47,7 @@
 	 *
 	 * @param DataObject (Optional)
 	 * @param DataObject
+	 * @param DataObject|null $fromRecord
 	 */
 	public function __construct($fromRecord, DataObject $toRecord) {
 		if(!$toRecord) user_error("DataDifferencer constructed without a toRecord", E_USER_WARNING);

model/DataList.php

Doc Comments +9 added lines, -9 removed lines

@@ -157,7 +157,7 @@ 
 	 * Returns a new DataList instance with the specified query parameter assigned
 	 *
 	 * @param string|array $keyOrArray Either the single key to set, or an array of key value pairs to set
-	 * @param mixed $val If $keyOrArray is not an array, this is the value to set
+	 * @param string $val If $keyOrArray is not an array, this is the value to set
 	 * @return DataList
 	 */
 	public function setDataQueryParam($keyOrArray, $val = null) {
@@ -619,7 +619,7 @@ 
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
 	 * ORM have a value of 10.
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
 	 * @return DataList
 	 */
 	public function innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -637,7 +637,7 @@ 
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
 	 * ORM have a value of 10.
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
 	 * @return DataList
 	 */
 	public function leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -764,7 +764,7 @@ 
 	 * Return the maximum value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function max($fieldName) {
 		return $this->dataQuery->max($fieldName);
@@ -774,7 +774,7 @@ 
 	 * Return the minimum value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function min($fieldName) {
 		return $this->dataQuery->min($fieldName);
@@ -784,7 +784,7 @@ 
 	 * Return the average value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function avg($fieldName) {
 		return $this->dataQuery->avg($fieldName);
@@ -794,7 +794,7 @@ 
 	 * Return the sum of the values of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function sum($fieldName) {
 		return $this->dataQuery->sum($fieldName);
@@ -846,7 +846,7 @@ 
 	/**
 	 * Restrict the columns to fetch into this DataList
 	 *
-	 * @param array $queriedColumns
+	 * @param string[] $queriedColumns
 	 * @return DataList
 	 */
 	public function setQueriedColumns($queriedColumns) {
@@ -1119,7 +1119,7 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
+	 * @param integer $key
 	 * @return DataObject
 	 */
 	public function offsetGet($key) {

model/DataQuery.php

Doc Comments +9 added lines, -2 removed lines

@@ -166,7 +166,7 @@ 
 	/**
 	 * Ensure that the query is ready to execute.
 	 *
-	 * @param array|null $queriedColumns Any columns to filter the query by
+	 * @param string[] $queriedColumns Any columns to filter the query by
 	 * @return SQLSelect The finalised sql query
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -641,7 +641,7 @@ 
 	 * mappings to the query object state. This has to be called
 	 * in any overloaded {@link SearchFilter->apply()} methods manually.
 	 *
-	 * @param String|array $relation The array/dot-syntax relation to follow
+	 * @param string $relation The array/dot-syntax relation to follow
 	 * @return The model class of the related item
 	 */
 	public function applyRelation($relation) {
@@ -819,6 +819,7 @@ 
 
 	/**
 	 * Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.
+	 * @param string $key
 	 */
 	public function getQueryParam($key) {
 		if(isset($this->queryParams[$key])) return $this->queryParams[$key];
@@ -851,6 +852,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -860,6 +864,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

model/fieldtypes/Currency.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/fieldtypes/Date.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/fieldtypes/Datetime.php

Doc Comments +2 added lines, -2 removed lines

@@ -97,7 +97,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';
@@ -176,7 +176,7 @@ 
 	 * Use {@link clear_mock_now()} to revert to the current system date.
 	 * Caution: This sets a fixed date that doesn't increment with time.
 	 *
-	 * @param SS_Datetime|string $datetime Either in object format, or as a SS_Datetime compatible string.
+	 * @param string $datetime Either in object format, or as a SS_Datetime compatible string.
 	 */
 	public static function set_mock_now($datetime) {
 		if($datetime instanceof SS_Datetime) {

model/fieldtypes/Decimal.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/fieldtypes/HTMLText.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/fieldtypes/Time.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];