silverstripe / silverstripe-framework

forms/UploadField.php

Doc Comments +3 added lines, -4 removed lines

@@ -202,7 +202,6 @@ 
 	 * @param string $title The field label.
 	 * @param SS_List $items If no items are defined, the field will try to auto-detect an existing relation on
 	 *                       @link $record}, with the same name as the field name.
-	 * @param Form $form Reference to the container form
 	 */
 	public function __construct($name, $title = null, SS_List $items = null) {
 
@@ -1052,7 +1051,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return UploadField_ItemHandler
+	 * @return UploadField_SelectHandler
 	 */
 	public function handleSelect(SS_HTTPRequest $request) {
 		if(!$this->canAttachExisting()) return $this->httpError(403);
@@ -1341,7 +1340,7 @@ 
 
 	/**
 	 * @param UploadFIeld $parent
-	 * @param int $item
+	 * @param int $itemID
 	 */
 	public function __construct($parent, $itemID) {
 		$this->parent = $parent;
@@ -1410,7 +1409,7 @@ 
 	 * Action to handle editing of a single file
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return ViewableData_Customised
+	 * @return HTMLText
 	 */
 	public function edit(SS_HTTPRequest $request) {
 		// Check form field state

model/Aggregate.php

Doc Comments +2 added lines, -1 removed lines

@@ -47,6 +47,7 @@ 
 	/** 
 	 * Clear the aggregate cache for a given type, or pass nothing to clear all aggregate caches.
 	 * {@link $class} is just effective if the cache backend supports tags.
+	 * @param string $class
 	 */
 	public static function flushCache($class=null) {
 		$cache = self::cache();
@@ -85,7 +86,7 @@ 
 	 * Build the SQLSelect to calculate the aggregate
 	 * This is a seperate function so that subtypes of Aggregate can change just this bit
 	 * @param string $attr - the SQL field statement for selection (i.e. "MAX(LastUpdated)")
-	 * @return SQLSelect
+	 * @return DataList
 	 */
 	protected function query($attr) {
 		$query = DataList::create($this->type)->where($this->filter);

model/DatabaseAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -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/DataObject.php

Doc Comments +12 added lines, -6 removed lines

@@ -549,7 +549,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
 	 */
@@ -953,6 +953,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) {
@@ -1581,10 +1582,10 @@ 
 	 *
 	 * @param string $componentName Name of the component
 	 * @param string|null $filter Deprecated. A filter to be inserted into the WHERE clause
-	 * @param string|null|array $sort Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted,
+	 * @param string $sort Deprecated. A sort expression to be inserted into the ORDER BY clause. If omitted,
 	 *                                the static field $default_sort on the component class will be used.
 	 * @param string $join Deprecated, use leftJoin($table, $joinClause) instead
-	 * @param string|null|array $limit Deprecated. A limit expression to be inserted into the LIMIT clause
+	 * @param string $limit Deprecated. A limit expression to be inserted into the LIMIT clause
 	 *
 	 * @return HasManyList The components of the one-to-many relationship.
 	 */
@@ -1644,7 +1645,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) {
@@ -2204,6 +2205,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2662,7 +2664,7 @@ 
 	 * can be saved into the Image table.
 	 *
 	 * @param string $fieldName Name of the field
-	 * @param mixed $value New field value
+	 * @param mixed $val New field value
 	 * @return DataObject $this
 	 */
 	public function setCastedField($fieldName, $val) {
@@ -3024,6 +3026,7 @@ 
 	 * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
 	 *
 	 * @param $fieldPath string
+	 * @param string $fieldName
 	 * @return string | null - will return null on a missing value
 	 */
 	public function relField($fieldName) {
@@ -3092,7 +3095,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 SQLQuery::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.
@@ -3143,6 +3146,7 @@ 
 
 	/**
 	 * @deprecated
+	 * @param string $class
 	 */
 	public function Aggregate($class = null) {
 		Deprecation::notice('4.0', 'Call aggregate methods on a DataList directly instead. In templates'
@@ -3164,6 +3168,7 @@ 
 
 	/**
 	 * @deprecated
+	 * @param string $relationship
 	 */
 	public function RelationshipAggregate($relationship) {
 		Deprecation::notice('4.0', 'Call aggregate methods on a relationship directly instead.');
@@ -3332,6 +3337,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

model/DB.php

Doc Comments +5 added lines, -4 removed lines

@@ -217,9 +217,8 @@ 
 	 * Given the database configuration, this method will create the correct
 	 * subclass of {@link SS_Database}.
 	 *
-	 * @param array $database A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
+	 * @param array $databaseConfig A map of options. The 'type' is the name of the subclass of SS_Database to use. For the
 	 *                        rest of the options, see the specific class.
-	 * @param string $name identifier for the connection
 	 *
 	 * @return SS_Database
 	 */
@@ -413,7 +412,7 @@ 
 
 	/**
 	 * Create a new table.
-	 * @param string $tableName The name of the table
+	 * @param string $table The name of the table
 	 * @param array$fields A map of field names to field types
 	 * @param array $indexes A map of indexes
 	 * @param array $options An map of additional options.  The available keys are as follows:
@@ -500,6 +499,8 @@ 
 
 	/**
 	 * @deprecated since version 4.0 Use DB::require_field instead
+	 * @param string $field
+	 * @param string $spec
 	 */
 	public static function requireField($table, $field, $spec) {
 		Deprecation::notice('4.0', 'Use DB::require_field instead');
@@ -563,7 +564,7 @@ 
 	/**
 	 * Checks a table's integrity and repairs it if necessary.
 	 *
-	 * @param string $tableName The name of the table.
+	 * @param string $table The name of the table.
 	 * @return boolean Return true if the table has integrity after the method is complete.
 	 */
 	public static function check_and_repair_table($table) {

model/fieldtypes/DBField.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/fieldtypes/Int.php

Doc Comments +3 added lines

@@ -52,6 +52,9 @@
 		return 0;
 	}
 
+	/**
+	 * @param integer $value
+	 */
 	public function prepValueForDB($value) {
 		if($value === true) {
 			return 1;

model/fieldtypes/Money.php

Doc Comments +6 added lines

@@ -236,6 +236,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getSymbol($currency = null, $locale = null) {
@@ -247,6 +249,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getShortName($currency = null, $locale = null) {
@@ -257,6 +261,8 @@ 
 	}
 
 	/**
+	 * @param string $currency
+	 * @param string $locale
 	 * @return string
 	 */
 	public function getName($currency = null, $locale = null) {

model/fieldtypes/PrimaryKey.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
 	/**
 	 * @param string $name
-	 * @param DataOject $object The object that this is primary key for (should have a relation with $name)
+	 * @param DataObject $object The object that this is primary key for (should have a relation with $name)
 	 */
 	public function __construct($name = null, $object) {
 		$this->object = $object;