sminnee / silverstripe-framework

ORM/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';

ORM/FieldType/DBDecimal.php

Doc Comments +4 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
 	 * @param string $name
 	 * @param int $wholeSize
 	 * @param int $decimalSize
-	 * @param float|int $defaultValue
+	 * @param integer $defaultValue
 	 */
 	public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
 		$this->wholeSize = is_int($wholeSize) ? $wholeSize : 9;
@@ -34,14 +34,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);
@@ -87,7 +87,7 @@ 
 	}
 
 	/**
-	 * @return float
+	 * @return integer
 	 */
 	public function nullValue() {
 		return 0;

ORM/FieldType/DBPrimaryKey.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
 	 */
 	protected $autoIncrement = true;
 
+	/**
+	 * @param boolean $autoIncrement
+	 */
 	public function setAutoIncrement($autoIncrement) {
 		$this->autoIncrement = $autoIncrement;
 		return $this;

ORM/FieldType/DBTime.php

Doc Comments +3 added lines

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

ORM/FieldType/DBYear.php

Doc Comments +3 added lines

@@ -24,6 +24,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());

ORM/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;

ORM/Queries/SQLConditionalExpression.php

Doc Comments -4 removed lines

@@ -374,7 +374,6 @@ 
 	 * @see SQLConditionalExpression::addWhere() for syntax examples
 	 *
 	 * @param mixed $where Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $where,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setWhere($where) {
@@ -460,7 +459,6 @@ 
 	 * </code>
 	 *
 	 * @param mixed $where Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $where,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addWhere($where) {
@@ -476,7 +474,6 @@ 
 	 * @see SQLConditionalExpression::addWhere()
 	 *
 	 * @param mixed $filters Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $filters,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setWhereAny($filters) {
@@ -490,7 +487,6 @@ 
 	 * @see SQLConditionalExpression::addWhere()
 	 *
 	 * @param mixed $filters Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $filters,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addWhereAny($filters) {

ORM/Versioning/ChangeSetItem.php

Doc Comments +2 added lines, -2 removed lines

@@ -130,7 +130,7 @@ 
 	 * Find version of this object in the given stage
 	 *
 	 * @param string $stage
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectInStage($stage) {
 		return Versioned::get_by_stage($this->ObjectClass, $stage)->byID($this->ObjectID);
@@ -139,7 +139,7 @@ 
 	/**
 	 * Find latest version of this object
 	 *
-	 * @return Versioned|DataObject
+	 * @return DataObject|null
 	 */
 	protected function getObjectLatestVersion() {
 		return Versioned::get_latest_version($this->ObjectClass, $this->ObjectID);

Security/Authenticator.php

Doc Comments +2 added lines, -1 removed lines

@@ -128,7 +128,7 @@ 
 	 * Remove a previously registered authenticator
 	 *
 	 * @param string $authenticator Name of the authenticator class to register
-	 * @return bool Returns TRUE on success, FALSE otherwise.
+	 * @return boolean|null Returns TRUE on success, FALSE otherwise.
 	 */
 	public static function unregister_authenticator($authenticator) {
 		if(call_user_func(array($authenticator, 'on_unregister')) === true) {
@@ -171,6 +171,7 @@ 
 	 * Set a default authenticator (shows first in tabs)
 	 *
 	 * @param string
+	 * @param string $authenticator
 	 */
 	public static function set_default_authenticator($authenticator) {
 		self::$default_authenticator = $authenticator;