silverstripe / silverstripe-framework

ORM/Hierarchy/Hierarchy.php

Doc Comments +3 added lines, -3 removed lines

@@ -419,7 +419,7 @@ 
 	/**
 	 * Return the IDs of all the marked nodes.
 	 *
-	 * @return array
+	 * @return integer[]
 	 */
 	public function markedNodeIDs() {
 		return array_keys($this->markedNodes);
@@ -636,7 +636,7 @@ 
 	/**
 	 * Return all the children that this page had, including pages that were deleted from both stage & live.
 	 *
-	 * @return DataList
+	 * @return \SilverStripe\ORM\DataList
 	 * @throws Exception
 	 */
 	public function AllHistoricalChildren() {
@@ -826,7 +826,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
 	 */

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

Doc Comments -3 removed lines

@@ -74,9 +74,6 @@
 	 * Given a list of assignments in any user-acceptible format, normalise the
 	 * value to a common array('SQL' => array(parameters)) format
 	 *
-	 * @param array $predicates List of assignments.
-	 * The key of this array should be the field name, and the value the assigned
-	 * literal value, or an array with parameterised information.
 	 * @return array List of normalised assignments
 	 */
 	protected function normaliseAssignments(array $assignments) {

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/Queries/SQLSelect.php

Doc Comments +2 added lines, -5 removed lines

@@ -61,7 +61,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.
@@ -115,7 +115,6 @@ 
 	 * </code>
 	 *
 	 * @param string|array $fields Field names should be ANSI SQL quoted. Array keys should be unquoted.
-	 * @param boolean $clear Clear existing select fields?
 	 * @return $this Self reference
 	 */
 	public function setSelect($fields) {
@@ -352,7 +351,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)) {
@@ -447,7 +446,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 self Self reference
 	 */
 	public function setHaving($having) {
@@ -462,7 +460,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 self Self reference
 	 */
 	public function addHaving($having) {

ORM/UnsavedRelationList.php

Doc Comments +1 added lines, -1 removed lines

@@ -146,7 +146,7 @@
 	 * Add a number of items to the relation.
 	 *
 	 * @param array $items Items to add, as either DataObjects or IDs.
-	 * @return DataList
+	 * @return UnsavedRelationList
 	 */
 	public function addMany($items) {
 		foreach($items as $item) {

ORM/ValidationResult.php

Doc Comments +1 added lines

@@ -21,6 +21,7 @@
 	/**
 	 * Create a new ValidationResult.
 	 * By default, it is a successful result.	Call $this->error() to record errors.
+	 * @param string $message
 	 */
 	public function __construct($valid = true, $message = null) {
 		$this->isValid = $valid;

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

ORM/Versioning/VersionedGridFieldItemRequest.php

Doc Comments +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
      *
      * @param array $data
      * @param Form $form
-	 * @return SS_HTTPResponse
+	 * @return \SS_HTTPResponse|null
      */
 	public function doArchive($data, $form) {
 		$record = $this->getRecord();