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/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/DB.php

Doc Comments +5 added lines, -4 removed lines

@@ -217,9 +217,8 @@ 
 	 * Given the database configuration, this method will create the correct
 	 * subclass of {@link SS_Database}.
 	 *
-	 * @param array $database A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
+	 * @param array $databaseConfig A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
 	 *                        rest of the options, see the specific class.
-	 * @param string $name identifier for the connection
 	 *
 	 * @return SS_Database
 	 */
@@ -413,7 +412,7 @@ 
 
 	/**
 	 * Create a new table.
-	 * @param string $tableName The name of the table
+	 * @param string $table The name of the table
 	 * @param array$fields A map of field names to field types
 	 * @param array $indexes A map of indexes
 	 * @param array $options An map of additional options.  The available keys are as follows:
@@ -500,6 +499,8 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::require_field instead
+	 * @param string $table
+	 * @param string $field
 	 */
 	public static function requireField($table, $field, $spec) {
 		Deprecation::notice('4.0', 'Use DB::require_field instead');
@@ -563,7 +564,7 @@ 
 	/**
 	 * Checks a table's integrity and repairs it if necessary.
 	 *
-	 * @param string $tableName The name of the table.
+	 * @param string $table The name of the table.
 	 * @return boolean Return true if the table has integrity after the method is complete.
 	 */
 	public static function check_and_repair_table($table) {

model/fieldtypes/CompositeDBField.php

Doc Comments +3 added lines

@@ -205,6 +205,9 @@
 		return null;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function hasField($field) {
 		$fields = $this->compositeDatabaseFields();
 		return isset($fields[$field]);

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/DBClassName.php

Doc Comments +3 added lines

@@ -180,6 +180,9 @@
 		return $classNames;
 	}
 
+	/**
+	 * @param DBClassNameTest_ObjectSubClass $record
+	 */
 	public function setValue($value, $record = null, $markChanged = true) {
 		parent::setValue($value, $record, $markChanged);
 

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;