silverstripe / silverstripe-framework

src/ORM/Connect/Database.php

Doc Comments +1 added lines, -1 removed lines

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

src/ORM/Connect/DBSchemaManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -295,7 +295,7 @@ 
 	 *   - array('fields' => array('A','B','C'), 'type' => 'index/unique/fulltext'): This gives you full
 	 *     control over the index.
 	 * @param boolean $hasAutoIncPK A flag indicating that the primary key on this table is an autoincrement type
-	 * @param array $options Create table options (ENGINE, etc.)
+	 * @param string|null $options Create table options (ENGINE, etc.)
 	 * @param array|bool $extensions List of extensions
 	 */
 	public function requireTable($table, $fieldSchema = null, $indexSchema = null, $hasAutoIncPK = true,
@@ -480,7 +480,7 @@ 
 	/**
 	 * Given an index spec determines the index type
 	 *
-	 * @param array|string $spec
+	 * @param string $spec
 	 * @return string
 	 */
 	protected function determineIndexType($spec) {
@@ -575,7 +575,7 @@ 
 	 *
 	 * @param string $table The table name.
 	 * @param string $field The field name.
-	 * @param array|string $spec The field specification. If passed in array syntax, the specific database
+	 * @param string $spec The field specification. If passed in array syntax, the specific database
 	 * 	driver takes care of the ALTER TABLE syntax. If passed as a string, its assumed to
 	 * 	be prepared as a direct SQL framgment ready for insertion into ALTER TABLE. In this case you'll
 	 * 	need to take care of database abstraction in your DBField subclass.

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

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

src/ORM/DataExtension.php

Doc Comments +6 added lines

@@ -78,9 +78,15 @@
 	public function can($member) {
 	}
 
+	/**
+	 * @param \SilverStripe\Security\Member|null $member
+	 */
 	public function canEdit($member) {
 	}
 
+	/**
+	 * @param \SilverStripe\Security\Member|null $member
+	 */
 	public function canDelete($member) {
 	}
 

src/ORM/DataList.php

Doc Comments +10 added lines, -10 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) {
@@ -520,7 +520,7 @@ 
 	 * Check if the given field specification could be interpreted as an unquoted relation name
 	 *
 	 * @param string $field
-	 * @return bool
+	 * @return integer
 	 */
 	protected function isValidRelationName($field) {
 		return preg_match('/^[A-Z0-9._]+$/i', $field);
@@ -635,7 +635,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()) {
@@ -653,7 +653,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()) {
@@ -780,7 +780,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);
@@ -790,7 +790,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);
@@ -800,7 +800,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);
@@ -810,7 +810,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);
@@ -862,7 +862,7 @@ 
 	/**
 	 * Restrict the columns to fetch into this DataList
 	 *
-	 * @param array $queriedColumns
+	 * @param string[] $queriedColumns
 	 * @return DataList
 	 */
 	public function setQueriedColumns($queriedColumns) {
@@ -1135,7 +1135,7 @@ 
 	/**
 	 * Returns item stored in list with index $key
 	 *
-	 * @param mixed $key
+	 * @param integer $key
 	 * @return DataObject
 	 */
 	public function offsetGet($key) {

src/ORM/DataObject.php

Doc Comments +7 added lines, -6 removed lines

@@ -2716,6 +2716,7 @@ 
 
 	/**
 	 * {@inheritdoc}
+	 * @param string $field
 	 */
 	public function castingHelper($field) {
 		if ($fieldSpec = $this->db($field)) {
@@ -2920,7 +2921,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canView($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2932,7 +2933,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canEdit($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2944,7 +2945,7 @@ 
 
 	/**
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canDelete($member = null) {
 		$extended = $this->extendedCan(__FUNCTION__, $member);
@@ -2958,7 +2959,7 @@ 
 	 * @param Member $member
 	 * @param array $context Additional context-specific data which might
 	 * affect whether (or where) this object could be created.
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canCreate($member = null, $context = array()) {
 		$extended = $this->extendedCan(__FUNCTION__, $member, $context);
@@ -3062,7 +3063,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) {
@@ -3132,7 +3133,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.

src/ORM/DataObjectSchema.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	/**
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('addto');

src/ORM/DataQuery.php

Doc Comments +2 added lines, -2 removed lines

@@ -98,7 +98,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
@@ -177,7 +177,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) {