silverstripe / silverstripe-framework

ORM/DataQuery.php

Doc Comments +9 added lines, -3 removed lines

@@ -100,7 +100,7 @@ 
 	/**
 	 * Remove a filter from the query
 	 *
-	 * @param string|array $fieldExpression The predicate of the condition to remove
+	 * @param string|null $fieldExpression The predicate of the condition to remove
 	 * (ignoring parameters). The expression will be considered a match if it's
 	 * contained within any other predicate.
 	 * @return DataQuery Self reference
@@ -179,7 +179,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) {
@@ -387,7 +387,7 @@ 
 	/**
 	 * Execute the query and return the result as {@link SS_Query} object.
 	 *
-	 * @return SS_Query
+	 * @return Connect\SS_Query
 	 */
 	public function execute() {
 		return $this->getFinalisedQuery()->execute();
@@ -1039,6 +1039,9 @@ 
 	 */
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		parent::__construct($base->dataClass);
 		$this->query = $base->query;
@@ -1048,6 +1051,9 @@ 
 		$base->where($this);
 	}
 
+	/**
+	 * @param string $filter
+	 */
 	public function where($filter) {
 		if($filter) {
 			$this->whereQuery->addWhere($filter);

ORM/FieldType/DBClassName.php

Doc Comments +3 added lines

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

ORM/FieldType/DBComposite.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]);

ORM/FieldType/DBCurrency.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)) {

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

Doc Comments +3 added lines

@@ -20,6 +20,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

@@ -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];

ORM/FieldType/DBYear.php

Doc Comments +3 added lines

@@ -18,6 +18,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/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
 	 */