sminnee / silverstripe-framework

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

@@ -50,6 +50,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 +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) {

model/DataObject.php

Unused Use Statements -2 removed lines

@@ -1,9 +1,7 @@
 <?php
 
-use SilverStripe\Model\FieldType\DBPolymorphicForeignKey;
 use SilverStripe\Model\FieldType\DBField;
 use SilverStripe\Model\FieldType\DBDatetime;
-use SilverStripe\Model\FieldType\DBPrimaryKey;
 use SilverStripe\Model\FieldType\DBComposite;
 
 /**

Doc Comments +9 added lines, -4 removed lines

@@ -558,8 +558,8 @@ 
 
 	/**
 	 * Helper function to duplicate relations from one object to another
-	 * @param $sourceObject the source object to duplicate from
-	 * @param $destinationObject the destination object to populate with the duplicated relations
+	 * @param DataObject $sourceObject the source object to duplicate from
+	 * @param DataObject $destinationObject the destination object to populate with the duplicated relations
 	 * @param $name the name of the relation to duplicate (e.g. members)
 	 */
 	private function duplicateRelations($sourceObject, $destinationObject, $name) {
@@ -939,6 +939,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) {
@@ -2224,6 +2225,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -3033,7 +3035,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) {
@@ -3102,7 +3104,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.
@@ -3312,6 +3314,8 @@ 
 	/**
 	 * @see $sourceQueryParams
 	 * @param array
+	 * @param string $key
+	 * @param string $value
 	 */
 	public function setSourceQueryParam($key, $value) {
 		$this->sourceQueryParams[$key] = $value;
@@ -3319,6 +3323,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

model/Hierarchy.php

Doc Comments +1 added lines, -1 removed lines

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

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

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