silverstripe / silverstripe-framework

Security/MemberAuthenticator.php

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
 	 * @param Form $form Optional: If passed, better error messages can be
 	 *                             produced by using
 	 *                             {@link Form::sessionMessage()}
-	 * @return bool|Member Returns FALSE if authentication fails, otherwise
+	 * @return Member|null Returns FALSE if authentication fails, otherwise
 	 *                     the member object
 	 * @see Security::setDefaultAdmin()
 	 */

Security/PasswordValidator.php

Doc Comments +4 added lines, -2 removed lines

@@ -28,6 +28,7 @@ 
 
 	/**
 	 * Minimum password length
+	 * @param integer $minLength
 	 */
 	public function minLength($minLength) {
 		$this->minLength = $minLength;
@@ -39,8 +40,8 @@ 
 	 *
 	 * Eg: $this->characterStrength(3, array("lowercase", "uppercase", "digits", "punctuation"))
 	 *
-	 * @param $minScore The minimum number of character tests that must pass
-	 * @param $testNames The names of the tests to perform
+	 * @param integer $minScore The minimum number of character tests that must pass
+	 * @param string[] $testNames The names of the tests to perform
 	 */
 	public function characterStrength($minScore, $testNames) {
 		$this->minScore = $minScore;
@@ -50,6 +51,7 @@ 
 
 	/**
 	 * Check a number of previous passwords that the user has used, and don't let them change to that.
+	 * @param integer $count
 	 */
 	public function checkHistoricalPasswords($count) {
 		$this->historicalPasswordCount = $count;

Security/Permission.php

Doc Comments +3 added lines, -3 removed lines

@@ -126,7 +126,7 @@ 
 	 *  will be checked for the current user
 	 * @param bool $strict Use "strict" checking (which means a permission
 	 *  will be granted if the key does not exist at all)?
-	 * @return int|bool The ID of the permission record if the permission
+	 * @return boolean|string The ID of the permission record if the permission
 	 *  exists; FALSE otherwise. If "strict" checking is
 	 *  disabled, TRUE will be returned if the permission does not exist at all.
 	 */
@@ -164,7 +164,7 @@ 
 	 * @param string $arg Optional argument (e.g. a permissions for a specific page)
 	 * @param bool $strict Use "strict" checking (which means a permission
 	 *  will be granted if the key does not exist at all)?
-	 * @return int|bool The ID of the permission record if the permission
+	 * @return boolean|string The ID of the permission record if the permission
 	 *  exists; FALSE otherwise. If "strict" checking is
 	 *  disabled, TRUE will be returned if the permission does not exist at all.
 	 */
@@ -724,7 +724,7 @@ 
 	/**
 	 * Get permissions
 	 *
-	 * @return array Associative array of permissions in this permission
+	 * @return string Associative array of permissions in this permission
 	 *               group. The array indicies are the permission codes as
 	 *               used in {@link Permission::check()}. The value is
 	 *               suitable for using in an interface.

Security/RememberLoginHash.php

Doc Comments +3 added lines

@@ -76,6 +76,9 @@
 		return $this->token;
 	}
 
+	/**
+	 * @param string $token
+	 */
 	public function setToken($token) {
 		$this->token = $token;
 	}

Security/SecurityToken.php

Doc Comments +4 added lines, -4 removed lines

@@ -62,7 +62,7 @@ 
 	protected $name = null;
 
 	/**
-	 * @param $name
+	 * @param string $name
 	 */
 	public function __construct($name = null) {
 		$this->name = ($name) ? $name : self::get_default_name();
@@ -113,7 +113,7 @@ 
 
 	/**
 	 * Returns the value of an the global SecurityToken in the current session
-	 * @return int
+	 * @return string
 	 */
 	public static function getSecurityID() {
 		$token = SecurityToken::inst();
@@ -196,7 +196,7 @@ 
 	/**
 	 * Get security token from request
 	 *
-	 * @param SS_HTTPREquest $request
+	 * @param SS_HTTPRequest $request
 	 * @return string
 	 */
 	protected function getRequestToken($request) {
@@ -216,7 +216,7 @@ 
 	 * care of this yourself.
 	 *
 	 * @param FieldList $fieldset
-	 * @return HiddenField|false
+	 * @return \Form
 	 */
 	public function updateFieldSet(&$fieldset) {
 		if(!$fieldset->fieldByName($this->getName())) {

core/Extensible.php

Doc Comments +2 added lines, -2 removed lines

@@ -369,8 +369,8 @@
 	 *
 	 * @param string $method the method name to call
 	 * @param mixed $a1
-	 * @param mixed $a2
-	 * @param mixed $a3
+	 * @param string $a2
+	 * @param boolean $a3
 	 * @param mixed $a4
 	 * @param mixed $a5
 	 * @param mixed $a6

ORM/FieldType/DBDate.php

Doc Comments +4 added lines, -1 removed lines

@@ -38,6 +38,9 @@ 
 	 */
 	private static $nice_format = 'd/m/Y';
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value, $record = null, $markChanged = true) {
 		if($value === false || $value === null || (is_string($value) && !strlen($value))) {
 			// don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be
@@ -194,7 +197,7 @@ 
 	 * Return a date formatted as per a CMS user's settings.
 	 *
 	 * @param Member $member
-	 * @return boolean | string A date formatted as per user-defined settings.
+	 * @return false|string | string A date formatted as per user-defined settings.
 	 */
 	public function FormatFromSettings($member = null) {
 		require_once 'Zend/Date.php';

ORM/FieldType/DBDecimal.php

Doc Comments +4 added lines, -4 removed lines

@@ -21,7 +21,7 @@ 
 	 * @param string $name
 	 * @param int $wholeSize
 	 * @param int $decimalSize
-	 * @param float|int $defaultValue
+	 * @param integer $defaultValue
 	 */
 	public function __construct($name = null, $wholeSize = 9, $decimalSize = 2, $defaultValue = 0) {
 		$this->wholeSize = is_int($wholeSize) ? $wholeSize : 9;
@@ -33,14 +33,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);
@@ -83,7 +83,7 @@ 
 	}
 
 	/**
-	 * @return float
+	 * @return integer
 	 */
 	public function nullValue() {
 		return 0;

forms/MemberDatetimeOptionsetField.php

Doc Comments +3 added lines

@@ -105,6 +105,9 @@
 		return $this->descriptionTemplate;
 	}
 
+	/**
+	 * @param string $template
+	 */
 	public function setDescriptionTemplate($template) {
 		$this->descriptionTemplate = $template;
 	}