silverstripe / silverstripe-framework

src/ORM/Hierarchy/Hierarchy.php

Doc Comments +2 added lines, -2 removed lines

@@ -379,7 +379,7 @@ 
 	/**
 	 * Return the IDs of all the marked nodes.
 	 *
-	 * @return array
+	 * @return integer[]
 	 */
 	public function markedNodeIDs() {
 		return array_keys($this->markedNodes);
@@ -756,7 +756,7 @@ 
 	 * Get the next node in the tree of the type. If there is no instance of the className descended from this node,
 	 * then search the parents.
 	 * @param string     $className Class name of the node to find.
-	 * @param string|int $root      ID/ClassName of the node to limit the search to
+	 * @param integer $root      ID/ClassName of the node to limit the search to
 	 * @param DataObject $afterNode Used for recursive calls to this function
 	 * @return DataObject
 	 */

src/ORM/ManyManyThroughQueryManipulator.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
 	}
 
 	/**
-	 * @param mixed $joinClass
+	 * @param string $joinClass
 	 * @return $this
 	 */
 	public function setJoinClass($joinClass)

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

src/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) {

src/ORM/Queries/SQLSelect.php

Doc Comments +2 added lines, -4 removed lines

@@ -65,7 +65,7 @@ 
 	/**
 	 * Construct a new SQLSelect.
 	 *
-	 * @param array|string $select An array of SELECT fields.
+	 * @param string $select An array of SELECT fields.
 	 * @param array|string $from An array of FROM clauses. The first one should be just the table name.
 	 * Each should be ANSI quoted.
 	 * @param array $where An array of WHERE clauses.
@@ -355,7 +355,7 @@ 
 	 *
 	 * @param string $value
 	 * @param string $defaultDirection
-	 * @return array A two element array: array($column, $direction)
+	 * @return string[] A two element array: array($column, $direction)
 	 */
 	private function getDirectionFromString($value, $defaultDirection = null) {
 		if(preg_match('/^(.*)(asc|desc)$/i', $value, $matches)) {
@@ -450,7 +450,6 @@ 
 	 * @see SQLSelect::addWhere() for syntax examples
 	 *
 	 * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $having,... Unlimited additional predicates
 	 * @return $this Self reference
 	 */
 	public function setHaving($having) {
@@ -465,7 +464,6 @@ 
 	 * @see SQLSelect::addWhere() for syntax examples
 	 *
 	 * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $having,... Unlimited additional predicates
 	 * @return $this Self reference
 	 */
 	public function addHaving($having) {

src/ORM/RelationList.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 	/**
 	 * Any number of foreign keys to apply to this list
 	 *
-	 * @return string|array|null
+	 * @return string|null
 	 */
 	public function getForeignID() {
 		return $this->dataQuery->getQueryParam('Foreign.ID');

src/ORM/UnsavedRelationList.php

Doc Comments +1 added lines, -1 removed lines

@@ -50,7 +50,7 @@
 	/**
 	 * Create a new UnsavedRelationList
 	 *
-	 * @param array $baseClass
+	 * @param string $baseClass
 	 * @param string $relationName
 	 * @param string $dataClass The DataObject class used in the relation
 	 */

src/ORM/Versioning/ChangeSetItem.php

Doc Comments +2 added lines, -2 removed lines

@@ -147,7 +147,7 @@ 
 	 * Find version of this object in the given stage
 	 *
 	 * @param string $stage
-	 * @return DataObject|Versioned
+	 * @return DataObject|null
 	 * @throws UnexpectedDataException
 	 */
 	protected function getObjectInStage($stage) {
@@ -160,7 +160,7 @@ 
 
 	/**
 	 * Find latest version of this object
-	 * @return DataObject|Versioned
+	 * @return DataObject|null
 	 * @throws UnexpectedDataException
 	 */
 	protected function getObjectLatestVersion() {

src/ORM/Versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -1065,7 +1065,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1185,7 +1185,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param Member|null $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1295,7 +1295,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -1371,7 +1371,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -1436,7 +1436,7 @@ 
 	/**
 	 * Determines if the current draft version is the same as live
 	 *
-	 * @return bool
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -2433,7 +2433,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {