silverstripe / silverstripe-framework

model/ArrayList.php

Doc Comments +6 added lines, -7 removed lines

@@ -295,8 +295,8 @@ 
 	/**
 	 * Find the first item of this list where the given key = value
 	 *
-	 * @param type $key
-	 * @param type $value
+	 * @param string $key
+	 * @param string $value
 	 * @return type 
 	 */
 	public function find($key, $value) {
@@ -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/Database.php

Doc Comments +32 added lines, -1 removed lines

@@ -145,6 +145,8 @@ 
 	
 	/**
 	 * Returns the enum values available on the given field
+	 * @param string $tableName
+	 * @param string $fieldName
 	 */
 	abstract public function enumValuesForField($tableName, $fieldName);
 	
@@ -255,6 +257,7 @@ 
 	/**
 	 * @param string $table
 	 * @param string $options
+	 * @param boolean $advanced_options
 	 */
 	public function transCreateTable($table, $options = null, $advanced_options = null) {
 		$this->schemaUpdateTransaction[$table] = array(
@@ -269,6 +272,7 @@ 
 	/**
 	 * @param string $table
 	 * @param array $options
+	 * @param boolean $advanced_options
 	 */
 	public function transAlterTable($table, $options, $advanced_options) {
 		$this->transInitTable($table);
@@ -276,18 +280,35 @@ 
 		$this->schemaUpdateTransaction[$table]['advancedOptions'] = $advanced_options;
 	}
 	
+	/**
+	 * @param string $table
+	 * @param string $field
+	 */
 	public function transCreateField($table, $field, $schema) {
 		$this->transInitTable($table);
 		$this->schemaUpdateTransaction[$table]['newFields'][$field] = $schema;
 	}
+
+	/**
+	 * @param string $table
+	 */
 	public function transCreateIndex($table, $index, $schema) {
 		$this->transInitTable($table);
 		$this->schemaUpdateTransaction[$table]['newIndexes'][$index] = $schema;
 	}
+
+	/**
+	 * @param string $table
+	 * @param string $field
+	 */
 	public function transAlterField($table, $field, $schema) {
 		$this->transInitTable($table);
 		$this->schemaUpdateTransaction[$table]['alteredFields'][$field] = $schema;
 	}
+
+	/**
+	 * @param string $table
+	 */
 	public function transAlterIndex($table, $index, $schema) {
 		$this->transInitTable($table);
 		$this->schemaUpdateTransaction[$table]['alteredIndexes'][$index] = $schema;
@@ -319,7 +340,7 @@ 
 	 * @param string $table The name of the table
 	 * @param string $fieldSchema A list of the fields to create, in the same form as DataObject::$db
 	 * @param string $indexSchema A list of indexes to create. See {@link requireIndex()}
-	 * @param array $options
+	 * @param string|null $options
 	 */
 	public function requireTable($table, $fieldSchema = null, $indexSchema = null, $hasAutoIncPK=true,
 			$options = Array(), $extensions=false) {
@@ -786,6 +807,7 @@ 
 	 * Returns the WHERE clauses ready for inserting into a query.
 	 * Caution: Expects correctly quoted and escaped SQL fragments.
 	 * 
+	 * @param string $connective
 	 * @return string
 	 */
 	public function sqlWhereToString($where, $connective) {
@@ -944,6 +966,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
 	 */
@@ -956,6 +979,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
 	 */
@@ -986,6 +1010,10 @@ 
 	/*
 	 * Create a savepoint that you can jump back to if you encounter problems
 	 */
+
+	/**
+	 * @param string $savepoint
+	 */
 	abstract public function transactionSavepoint($savepoint);
 
 	/*
@@ -1015,6 +1043,7 @@ 
 	 * Returns if the lock is available.
 	 * See {@link supportsLocks()} to check if locking is generally supported.
 	 * 
+	 * @param string $name
 	 * @return Boolean
 	 */
 	public function canLock($name) {
@@ -1036,6 +1065,7 @@ 
 	 * 
 	 * @param String
 	 * @param Int Timeout in seconds
+	 * @param string $name
 	 * @return Boolean
 	 */
 	public function getLock($name, $timeout = 5) {
@@ -1047,6 +1077,7 @@ 
 	 * (if the execution aborts (e.g. due to an error) all locks are automatically released).
 	 * 
 	 * @param String
+	 * @param string $name
 	 * @return Boolean
 	 */
 	public function releaseLock($name) {

model/DataDifferencer.php

Doc Comments +2 added lines, -1 removed lines

@@ -46,7 +46,8 @@
 	 * If $fromRecord is null, this will represent a "creation".
 	 * 
 	 * @param DataObject (Optional)
-	 * @param DataObject 
+	 * @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, -7 removed lines

@@ -153,6 +153,9 @@ 
 		return $clone;
 	}
 
+	/**
+	 * @param string $val
+	 */
 	public function setDataQueryParam($keyOrArray, $val = null) {
 		$clone = clone $this;
 
@@ -171,7 +174,7 @@ 
 	/**
 	 * Returns the SQL query that will be used to get this DataList's records.  Good for debugging. :-)
 	 * 
-	 * @return SQLQuery
+	 * @return string
 	 */
 	public function sql() {
 		return $this->dataQuery->query()->sql();
@@ -716,7 +719,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);
@@ -726,7 +729,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);
@@ -736,7 +739,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);
@@ -746,7 +749,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);
@@ -817,7 +820,7 @@ 
 	/**
 	 * Restrict the columns to fetch into this DataList
 	 *
-	 * @param array $queriedColumns
+	 * @param string[] $queriedColumns
 	 * @return DataList
 	 */
 	public function setQueriedColumns($queriedColumns) {
@@ -1093,7 +1096,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 +13 added lines, -5 removed lines

@@ -307,6 +307,8 @@ 
 	/**
 	 * Returns the field class if the given db field on the class is a composite field.
 	 * Will check all applicable ancestor classes and aggregate results.
+	 * @param string $class
+	 * @param string $name
 	 */
 	public static function is_composite_field($class, $name, $aggregated = true) {
 		$key = $class . '_' . $name . '_' . (string)$aggregated;
@@ -497,7 +499,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
 	 */
@@ -800,7 +802,7 @@ 
 	 * This function is similar to toMap() but doesn't trigger the lazy-loading of all unfetched fields.
 	 * Obviously, this makes it a lot faster.
 	 *
-	 * @return array The data as a map.
+	 * @return boolean The data as a map.
 	 */
 	public function getQueriedDatabaseFields() {
 		return $this->record;
@@ -901,6 +903,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) {
@@ -1454,7 +1457,7 @@ 
 	 *
 	 * @param string $componentName Name of the component
 	 * @param string $filter A filter to be inserted into the WHERE clause
-	 * @param string|array $sort A sort expression to be inserted into the ORDER BY clause. If omitted, the static
+	 * @param string $sort 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|array $limit A limit expression to be inserted into the LIMIT clause
@@ -1506,7 +1509,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) {
@@ -1916,6 +1919,7 @@ 
 	 *
 	 * This is experimental, and is currently only a Postgres-specific enhancement.
 	 *
+	 * @param string $class
 	 * @return array or false
 	 */
 	public function database_extensions($class){
@@ -2374,7 +2378,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) {
@@ -2749,6 +2753,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) {
@@ -2864,6 +2869,7 @@ 
 
 	/**
 	 * @deprecated 3.1 Use DataList::create and DataList to do your querying
+	 * @param string $class
 	 */
 	public function Aggregate($class = null) {
 		Deprecation::notice('3.1', 'Call aggregate methods on a DataList directly instead. In templates'
@@ -2885,6 +2891,7 @@ 
 
 	/**
 	 * @deprecated 3.1 Use DataList::create and DataList to do your querying
+	 * @param string $relationship
 	 */
 	public function RelationshipAggregate($relationship) {
 		Deprecation::notice('3.1', 'Call aggregate methods on a relationship directly instead.');
@@ -3052,6 +3059,7 @@ 
 
 	/**
 	 * @see $sourceQueryParams
+	 * @param string $key
 	 * @return Mixed
 	 */
 	public function getSourceQueryParam($key) {

model/DataQuery.php

Doc Comments +8 added lines, -3 removed lines

@@ -140,6 +140,7 @@ 
 	/**
 	 * Ensure that the query is ready to execute.
 	 *
+	 * @param string[] $queriedColumns
 	 * @return SQLQuery
 	 */
 	public function getFinalisedQuery($queriedColumns = null) {
@@ -381,6 +382,7 @@ 
 
 	/**
 	 * Runs a raw aggregate expression.  Please handle escaping yourself
+	 * @param string $expression
 	 */
 	public function aggregate($expression) {
 		return $this->getFinalisedQuery()->aggregate($expression)->execute()->value();
@@ -483,7 +485,6 @@ 
 	 *  $query->where(array("\"Column\" = 'Value'", "\"Column\" != 'Value'"));
 	 * </code>
 	 *
-	 * @param string|array $where Predicate(s) to set, as escaped SQL statements.
 	 */
 	public function where($filter) {
 		if($filter) {
@@ -593,7 +594,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) {
@@ -770,6 +771,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];
@@ -800,6 +802,9 @@ 
 
 	protected $whereQuery;
 
+	/**
+	 * @param string $connective
+	 */
 	public function __construct(DataQuery $base, $connective) {
 		$this->dataClass = $base->dataClass;
 		$this->query = $base->query;
@@ -821,7 +826,7 @@ 
 	 *  $query->where(array("\"Column\" = 'Value'", "\"Column\" != 'Value'"));
 	 * </code>
 	 *
-	 * @param string|array $where Predicate(s) to set, as escaped SQL statements.
+	 * @param string $filter
 	 */
 	public function where($filter) {
 		if($filter) {

model/DB.php

Doc Comments +1 added lines, -2 removed lines

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

model/fieldtypes/Decimal.php

Doc Comments +4 added lines, -4 removed lines

@@ -15,7 +15,7 @@ 
 	 * @param string $name
 	 * @param int $wholeSize
 	 * @param int $decimalSize
-	 * @param float $defaultValue
+	 * @param integer $defaultValue
 	 */
 	public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
 		$this->wholeSize = is_int($wholeSize) ? $wholeSize : 9;
@@ -27,14 +27,14 @@ 
 	}
 	
 	/**
-	 * @return float
+	 * @return string
 	 */
 	public function Nice() {
 		return number_format($this->value, $this->decimalSize);
 	}
 	
 	/**
-	 * @return int
+	 * @return double
 	 */
 	public function Int() {
 		return floor($this->value);
@@ -80,7 +80,7 @@ 
 	}
 
 	/**
-	 * @return float
+	 * @return string
 	 */
 	public function nullValue() {
 		return "0.00";

model/Image.php

Doc Comments +2 added lines, -2 removed lines

@@ -126,7 +126,7 @@ 
 	 * An image exists if it has a filename.
 	 * Does not do any filesystem checks.
 	 * 
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function exists() {
 		if(isset($this->record["Filename"])) {
@@ -646,7 +646,7 @@ 
 	
 	/**
 	 * Get the orientation of this image.
-	 * @return ORIENTATION_SQUARE | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE
+	 * @return integer | ORIENTATION_PORTRAIT | ORIENTATION_LANDSCAPE
 	 */
 	public function getOrientation() {
 		$width = $this->getWidth();