silverstripe / silverstripe-framework

security/MemberAuthenticator.php

Doc Comments +2 added lines, -2 removed lines

@@ -134,7 +134,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()
 	 */
@@ -165,7 +165,7 @@ 
 	/**
 	 * Method that creates the login form for this authentication method
 	 *
-	 * @param Controller The parent controller, necessary to create the
+	 * @param Controller Controller parent controller, necessary to create the
 	 *                   appropriate form action tag
 	 * @return Form Returns the login form to use with this authentication
 	 *              method

security/MemberLoginForm.php

Doc Comments -1 removed lines

@@ -47,7 +47,6 @@
 	 * @param bool $checkCurrentUser If set to TRUE, it will be checked if a
 	 *                               the user is currently logged in, and if
 	 *                               so, only a logout button will be rendered
-	 * @param string $authenticatorClassName Name of the authenticator class that this form uses.
 	 */
 	public function __construct($controller, $name, $fields = null, $actions = null,
 								$checkCurrentUser = true) {

security/MemberPassword.php

Doc Comments +1 added lines

@@ -32,6 +32,7 @@
 	/**
 	 * Log a password change from the given member.
 	 * Call MemberPassword::log($this) from within Member whenever the password is changed.
+	 * @param Member $member
 	 */
 	public static function log($member) {
 		$record = new MemberPassword();

security/PasswordEncryptor.php

Doc Comments +6 added lines, -2 removed lines

@@ -85,6 +85,10 @@ 
 	 * but is necessary for retain compatibility with password hashed
 	 * with flawed algorithms - see {@link PasswordEncryptor_LegacyPHPHash} and
 	 * {@link PasswordEncryptor_Blowfish}
+	 * @param string $hash
+	 * @param string $password
+	 * @param string $salt
+	 * @param Member $member
 	 */
 	public function check($hash, $password, $salt = null, $member = null) {
 		return $hash === $this->encrypt($password, $salt, $member);
@@ -127,8 +131,7 @@ 
 	/**
 	 * Gets the cost that is set for the blowfish algorithm
 	 *
-	 * @param int $cost
-	 * @return null
+	 * @return integer
 	 */
 	public static function get_cost() {
 		return self::$cost;
@@ -240,6 +243,7 @@ 
 
 	/**
 	 * self::$cost param is forced to be two digits with leading zeroes for ints 4-9
+	 * @param string $password
 	 */
 	public function salt($password, $member = null) {
 		$generator = new RandomGenerator();

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;

tasks/EncryptAllPasswordsTask.php

Doc Comments +1 added lines

@@ -66,6 +66,7 @@
 
 	/**
 	 * @todo This should really be taken care of by TestRunner
+	 * @param string $msg
 	 */
 	protected function debugMessage($msg) {
 		if(class_exists('SapphireTest', false) && !SapphireTest::is_running_test()) {

tests/api/RestfulServiceTest.php

Doc Comments +2 added lines

@@ -208,6 +208,8 @@
 	 * Simulate cached response file for testing error requests that are supposed to have cache files
 	 *
 	 * @todo Generate the cachepath without hardcoding the cache data
+	 * @param RestfulServiceTest_MockErrorService $connection
+	 * @param string $subUrl
 	 */
 	private function createFakeCachedResponse($connection, $subUrl) {
 		$fullUrl = $connection->getAbsoluteRequestURL($subUrl);

tests/core/manifest/ConfigManifestTest.php

Doc Comments +3 added lines, -2 removed lines

@@ -10,7 +10,7 @@ 
 
 	/**
 	 * This is a helper method for getting a new manifest
-	 * @param $name
+	 * @param string $name
 	 * @return any
 	 */
 	protected function getConfigFixtureValue($name) {
@@ -20,6 +20,7 @@ 
 
 	/**
 	 * This is a helper method for displaying a relevant message about a parsing failure
+	 * @param string $path
 	 */
 	protected function getParsedAsMessage($path) {
 		return sprintf('Reference path "%s" failed to parse correctly', $path);
@@ -41,7 +42,7 @@ 
 
 	/**
 	 * A helper method to return a mock of the manifest in order to test expectations and reduce dependency
-	 * @param $methods
+	 * @param string[] $methods
 	 * @return SS_ConfigManifest
 	 */
 	protected function getManifestMock($methods) {

tests/core/startup/ErrorControlChainTest.php

Doc Comments +4 added lines

@@ -9,6 +9,10 @@
 class ErrorControlChainTest_Chain extends ErrorControlChain {
 
 	// Change function visibility to be testable directly
+
+	/**
+	 * @param string $memstring
+	 */
 	public function translateMemstring($memstring) {
 		return parent::translateMemstring($memstring);
 	}