silverstripe / silverstripe-framework

model/ArrayList.php

Doc Comments +4 added lines, -5 removed lines

@@ -387,7 +387,7 @@ 
 	 *
 	 * Note that columns may be double quoted as per ANSI sql standard
 	 *
-	 * @return DataList
+	 * @return ArrayList
 	 * @see SS_List::sort()
 	 * @example $list->sort('Name'); // default ASC sorting
 	 * @example $list->sort('Name DESC'); // DESC sorting
@@ -523,6 +523,9 @@ 
 		return $list;
 	}
 
+	/**
+	 * @param integer $id
+	 */
 	public function byID($id) {
 		$firstElement = $this->filter("ID", $id)->first();
 
@@ -624,7 +627,6 @@ 
 	/**
 	 * Returns whether an item with $key exists
 	 *
-	 * @param mixed $key
 	 * @return bool
 	 */
 	public function offsetExists($offset) {
@@ -634,7 +636,6 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
 	 * @return DataObject
 	 */
 	public function offsetGet($offset) {
@@ -644,7 +645,6 @@ 
 	/**
 	 * Set an item with the key in $key
 	 *
-	 * @param mixed $key
 	 * @param mixed $value
 	 */
 	public function offsetSet($offset, $value) {
@@ -658,7 +658,6 @@ 
 	/**
 	 * Unset an item with the key in $key
 	 *
-	 * @param mixed $key
 	 */
 	public function offsetUnset($offset) {
 		unset($this->items[$offset]);

model/connect/Database.php

Doc Comments +5 added lines, -2 removed lines

@@ -406,6 +406,7 @@ 
 	 * - minutes
 	 * - seconds
 	 * This includes the singular forms as well
+	 * @param string $date
 	 * @return string SQL datetime expression to query for a datetime (YYYY-MM-DD hh:mm:ss) which is the result of
 	 *                the addition
 	 */
@@ -419,6 +420,7 @@ 
 	 *                       e.g. '"SiteTree"."Created"'
 	 * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime
 	 *                      like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"'
+	 * @param string $date1
 	 * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which
 	 *                is the result of the substraction
 	 */
@@ -646,7 +648,7 @@ 
 	 * @param boolean $create Flag indicating whether the database should be created
 	 * if it doesn't exist. If $create is false and the database doesn't exist
 	 * then an error will be raised
-	 * @param int|boolean $errorLevel The level of error reporting to enable for the query, or false if no error
+	 * @param boolean $errorLevel The level of error reporting to enable for the query, or false if no error
 	 * should be raised
 	 * @return boolean Flag indicating success
 	 */
@@ -681,7 +683,7 @@ 
 	/**
 	 * Returns the name of the currently selected database
 	 *
-	 * @return string|null Name of the selected database, or null if none selected
+	 * @return string Name of the selected database, or null if none selected
 	 */
 	public function getSelectedDatabase() {
 		return $this->connector->getSelectedDatabase();
@@ -806,6 +808,7 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::field_list instead
+	 * @param string $table
 	 */
 	public function fieldList($table) {
 		Deprecation::notice('4.0', 'Use DB::field_list instead');

model/connect/DBSchemaManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -38,7 +38,6 @@ 
 	/**
 	 * Injector injection point for database controller
 	 *
-	 * @param SS_Database $connector
 	 */
 	public function setDatabase(SS_Database $database) {
 		$this->database = $database;
@@ -104,6 +103,7 @@ 
 	 *
 	 * @var callable $callback
 	 * @throws Exception
+	 * @param Closure $callback
 	 */
 	public function schemaUpdate($callback) {
 		// Begin schema update
@@ -476,7 +476,7 @@ 
 	/**
 	 * Given an index spec determines the index type
 	 *
-	 * @param array|string $spec
+	 * @param string $spec
 	 * @return string
 	 */
 	protected function determineIndexType($spec) {
@@ -544,7 +544,7 @@ 
 	/**
 	 * Returns true if the given table is exists in the current database
 	 *
-	 * @param string $table Name of table to check
+	 * @param string $tableName Name of table to check
 	 * @return boolean Flag indicating existence of table
 	 */
 	abstract public function hasTable($tableName);

model/connect/MySQLSchemaManager.php

Doc Comments +3 added lines

@@ -115,6 +115,9 @@
 		$this->query("ALTER TABLE \"$tableName\" $alterations");
 	}
 
+	/**
+	 * @param string $tableName
+	 */
 	public function isView($tableName) {
 		$info = $this->query("SHOW /*!50002 FULL*/ TABLES LIKE '$tableName'")->record();
 		return $info && strtoupper($info['Table_type']) == 'VIEW';

model/DatabaseAdmin.php

Doc Comments +2 added lines, -2 removed lines

@@ -107,7 +107,7 @@ 
 	/**
 	 * Gets the url to return to after build
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	protected function getReturnURL() {
 		$url = $this->request->getVar('returnURL');
@@ -152,7 +152,7 @@ 
 	/**
 	 * Returns the timestamp of the time that the database was last built
 	 *
-	 * @return string Returns the timestamp of the time that the database was
+	 * @return integer|null Returns the timestamp of the time that the database was
 	 *                last built
 	 */
 	public static function lastBuilt() {

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

Doc Comments +9 added lines, -9 removed lines

@@ -157,7 +157,7 @@ 
 	 * Returns a new DataList instance with the specified query parameter assigned
 	 *
 	 * @param string|array $keyOrArray Either the single key to set, or an array of key value pairs to set
-	 * @param mixed $val If $keyOrArray is not an array, this is the value to set
+	 * @param string $val If $keyOrArray is not an array, this is the value to set
 	 * @return DataList
 	 */
 	public function setDataQueryParam($keyOrArray, $val = null) {
@@ -619,7 +619,7 @@ 
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
 	 * ORM have a value of 10.
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
 	 * @return DataList
 	 */
 	public function innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -637,7 +637,7 @@ 
 	 * @param int $order A numerical index to control the order that joins are added to the query; lower order values
 	 * will cause the query to appear first. The default is 20, and joins created automatically by the
 	 * ORM have a value of 10.
-	 * @param array $parameters Any additional parameters if the join is a parameterised subquery
+	 * @param string[] $parameters Any additional parameters if the join is a parameterised subquery
 	 * @return DataList
 	 */
 	public function leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = array()) {
@@ -764,7 +764,7 @@ 
 	 * Return the maximum value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function max($fieldName) {
 		return $this->dataQuery->max($fieldName);
@@ -774,7 +774,7 @@ 
 	 * Return the minimum value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function min($fieldName) {
 		return $this->dataQuery->min($fieldName);
@@ -784,7 +784,7 @@ 
 	 * Return the average value of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function avg($fieldName) {
 		return $this->dataQuery->avg($fieldName);
@@ -794,7 +794,7 @@ 
 	 * Return the sum of the values of the given field in this DataList
 	 *
 	 * @param string $fieldName
-	 * @return mixed
+	 * @return string
 	 */
 	public function sum($fieldName) {
 		return $this->dataQuery->sum($fieldName);
@@ -846,7 +846,7 @@ 
 	/**
 	 * Restrict the columns to fetch into this DataList
 	 *
-	 * @param array $queriedColumns
+	 * @param string[] $queriedColumns
 	 * @return DataList
 	 */
 	public function setQueriedColumns($queriedColumns) {
@@ -1119,7 +1119,7 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
+	 * @param integer $key
 	 * @return DataObject
 	 */
 	public function offsetGet($key) {

model/DataObject.php

Doc Comments +8 added lines, -5 removed lines

@@ -535,7 +535,7 @@ 
 	 * The destinationObject must be written to the database already and have an ID. Writing is performed
 	 * automatically when adding the new relations.
 	 *
-	 * @param $sourceObject the source object to duplicate from
+	 * @param DataObject $sourceObject the source object to duplicate from
 	 * @param $destinationObject the destination object to populate with the duplicated relations
 	 * @return DataObject with the new many_many relations copied in
 	 */
@@ -940,6 +940,7 @@ 
 	 * @param $includeRelations Boolean Merge any existing relations (optional)
 	 * @param $overwriteWithEmpty Boolean Overwrite existing left values with empty right values.
 	 *                            Only applicable with $priority='right'. (optional)
+	 * @param DataObject|null $rightObj
 	 * @return Boolean
 	 */
 	public function merge($rightObj, $priority = 'right', $includeRelations = true, $overwriteWithEmpty = false) {
@@ -1627,7 +1628,7 @@ 
 	/**
 	 * Find the foreign class of a relation on this DataObject, regardless of the relation type.
 	 *
-	 * @param $relationName Relation name.
+	 * @param string $relationName Relation name.
 	 * @return string Class name, or null if not found.
 	 */
 	public function getRelationClass($relationName) {
@@ -2203,6 +2204,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2850,7 +2852,7 @@ 
 	 * </code>
 	 *
 	 * @param string $methodName Method on the same object, e.g. {@link canEdit()}
-	 * @param Member|int $member
+	 * @param DataObject|null $member
 	 * @param array $context Optional context
 	 * @return boolean|null
 	 */
@@ -3006,7 +3008,7 @@ 
 	 * Traverses to a field referenced by relationships between data objects, returning the value
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
-	 * @param $fieldName string
+	 * @param string $fieldName string
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3075,7 +3077,7 @@ 
 	 * @param string $callerClass The class of objects to be returned
 	 * @param string|array $filter A filter to be inserted into the WHERE clause.
 	 * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
-	 * @param string|array $sort A sort expression to be inserted into the ORDER
+	 * @param string $sort A sort expression to be inserted into the ORDER
 	 * BY clause.  If omitted, self::$default_sort will be used.
 	 * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
 	 * @param string|array $limit A limit expression to be inserted into the LIMIT clause.
@@ -3281,6 +3283,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

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);