silverstripe / silverstripe-framework

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

model/MySQLDatabase.php

Doc Comments +6 added lines, -1 removed lines

@@ -181,6 +181,7 @@ 
 	/**
 	 * Drop the database that this object is currently connected to.
 	 * Use with caution.
+	 * @param string $dbName
 	 */
 	public function dropDatabaseByName($dbName) {
 		$this->query("DROP DATABASE \"$dbName\"");
@@ -334,7 +335,7 @@ 
 	/**
 	 * Checks a table's integrity and repairs it if necessary.
 	 * @var string $tableName The name of the table.
-	 * @return boolean Return true if the table has integrity after the method is complete.
+	 * @return null|boolean Return true if the table has integrity after the method is complete.
 	 */
 	public function checkAndRepairTable($tableName) {
 		if(!$this->runTableCheckCommand("CHECK TABLE \"$tableName\"")) {
@@ -588,6 +589,10 @@ 
 		return $this->dbConn->affected_rows;
 	}
 
+	/**
+	 * @param string $msg
+	 * @param integer $errorLevel
+	 */
 	public function databaseError($msg, $errorLevel = E_USER_ERROR) {
 		// try to extract and format query
 		if(preg_match('/Couldn\'t run query: ([^\|]*)\|\s*(.*)/', $msg, $matches)) {

model/MySQLQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 	 * Hook the result-set given into a Query class, suitable for use by 
 	 * SilverStripe.
 	 *
-	 * @param database $database The database object that created this query.
+	 * @param MySQLDatabase $database The database object that created this query.
 	 * @param handle $handle the internal mysql handle that is points to the resultset.
 	 */
 	public function __construct(MySQLDatabase $database, $handle) {

model/SQLQuery.php

Doc Comments +3 added lines, -3 removed lines

@@ -158,7 +158,6 @@ 
 	 * </code>
 	 *
 	 * @param string|array $fields Field names should be ANSI SQL quoted. Array keys should be unquoted.
-	 * @param boolean $clear Clear existing select fields?
 	 * @return $this Self reference
 	 */
 	public function setSelect($fields) {
@@ -594,7 +593,7 @@ 
 	 * 
 	 * @param string $value
 	 * @param string $defaultDirection
-	 * @return array A two element array: array($column, $direction)
+	 * @return string[] A two element array: array($column, $direction)
 	 */
 	private function getDirectionFromString($value, $defaultDirection = null) {
 		if(preg_match('/^(.*)(asc|desc)$/i', $value, $matches)) {
@@ -1017,6 +1016,7 @@ 
 
 	/**
 	 * Returns true if this query can be sorted by the given field.
+	 * @param string $fieldName
 	 */
 	public function canSortBy($fieldName) {
 		$fieldName = preg_replace('/(\s+?)(A|DE)SC$/', '', $fieldName);
@@ -1072,7 +1072,7 @@ 
 	 * Return a new SQLQuery that calls the given aggregate functions on this data.
 	 * 
 	 * @param $column An aggregate expression, such as 'MAX("Balance")', or a set of them (as an escaped SQL statement)
-	 * @param $alias An optional alias for the aggregate column.
+	 * @param string $alias An optional alias for the aggregate column.
 	 */
 	public function aggregate($column, $alias = null) {
 		$clone = clone $this;

search/filters/SearchFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -289,7 +289,7 @@
 	/**
 	 * Determines case sensitivity based on {@link getModifiers()}.
 	 * 
-	 * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
+	 * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
 	 */
 	protected function getCaseSensitive() {
 		$modifiers = $this->getModifiers();

security/Member.php

Doc Comments +3 added lines, -2 removed lines

@@ -594,6 +594,7 @@ 
 
 	/**
 	 * Utility for generating secure password hashes for this member.
+	 * @param string $string
 	 */
 	public function encryptWithUserSettings($string) {
 		if (!$string) return null;
@@ -745,7 +746,7 @@ 
 	/**
 	 * Returns the current logged in user
 	 *
-	 * @return Member|null
+	 * @return DataObject|null
 	 */
 	public static function currentUser() {
 		$id = Member::currentUserID();
@@ -1217,7 +1218,7 @@ 
 	 *
 	 * @param array $groups Groups to consider or NULL to use all groups with
 	 *                      CMS permissions.
-	 * @return SQLMap Returns a map of all members in the groups given that
+	 * @return SS_Map Returns a map of all members in the groups given that
 	 *                have CMS permissions.
 	 */
 	public static function mapInCMSGroups($groups = null) {