sminnee / silverstripe-framework

Security/Authenticator.php

Doc Comments +2 added lines, -1 removed lines

@@ -128,7 +128,7 @@ 
 	 * Remove a previously registered authenticator
 	 *
 	 * @param string $authenticator Name of the authenticator class to register
-	 * @return bool Returns TRUE on success, FALSE otherwise.
+	 * @return boolean|null Returns TRUE on success, FALSE otherwise.
 	 */
 	public static function unregister_authenticator($authenticator) {
 		if(call_user_func(array($authenticator, 'on_unregister')) === true) {
@@ -171,6 +171,7 @@ 
 	 * Set a default authenticator (shows first in tabs)
 	 *
 	 * @param string
+	 * @param string $authenticator
 	 */
 	public static function set_default_authenticator($authenticator) {
 		self::$default_authenticator = $authenticator;

Security/ChangePasswordForm.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
 	/**
 	 * Constructor
 	 *
-	 * @param Controller $controller The parent controller, necessary to
+	 * @param \Controller|null $controller The parent controller, necessary to
 	 *                               create the appropriate form action tag.
 	 * @param string $name The method on the controller that will return this
 	 *                     form object.

Security/Group.php

Doc Comments +1 added lines

@@ -331,6 +331,7 @@
 	 * Overloaded to ensure the code is always descent.
 	 *
 	 * @param string
+	 * @param string $val
 	 */
 	public function setCode($val){
 		$this->setField("Code", Convert::raw2url($val));

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 use SilverStripe\ORM\HasManyList;
 use SilverStripe\ORM\ManyManyList;
 use SilverStripe\ORM\UnsavedRelationList;
-use Requirements;
 use FieldList;
 use TabSet;
 use Tab;

Security/Member.php

Doc Comments +3 added lines, -3 removed lines

@@ -1561,7 +1561,7 @@ 
 	 * This is likely to be customized for social sites etc. with a looser permission model.
 	 *
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
     public function canView($member = null) {
         //get member
@@ -1591,7 +1591,7 @@ 
 	 * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
 	 *
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
     public function canEdit($member = null) {
         //get member
@@ -1625,7 +1625,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
 	 *
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
      */
     public function canDelete($member = null) {
         if(!($member instanceof Member)) {

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

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

Security/Security.php

Unused Use Statements -1 removed lines

@@ -22,7 +22,6 @@
 use EmailField;
 use FormAction;
 use Convert;
-use Object;
 use ClassInfo;
 
 /**

Doc Comments +4 added lines, -4 removed lines

@@ -508,7 +508,7 @@ 
 	 * Combine the given forms into a formset with a tabbed interface
 	 *
 	 * @param array $forms List of LoginForm instances
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -893,7 +893,7 @@ 
 	 *
 	 * @param string $username The user name
 	 * @param string $password The password (in cleartext)
-	 * @return bool
+	 * @return false|null
 	 */
 	public static function setDefaultAdmin($username, $password) {
 		// don't overwrite if already set
@@ -980,7 +980,7 @@ 
 	 * @deprecated 4.0 Use the "Security.password_encryption_algorithm" config setting instead
 	 * @param string $algorithm One of the available password encryption
 	 *  algorithms determined by {@link Security::get_encryption_algorithms()}
-	 * @return bool Returns TRUE if the passed algorithm was valid, otherwise FALSE.
+	 * @return boolean|null Returns TRUE if the passed algorithm was valid, otherwise FALSE.
 	 */
 	public static function set_password_encryption_algorithm($algorithm) {
 		Deprecation::notice('4.0', 'Use the "Security.password_encryption_algorithm" config setting instead');
@@ -1148,7 +1148,7 @@ 
 	/**
 	 * Set to true to ignore access to disallowed actions, rather than returning permission failure
 	 * Note that this is just a flag that other code needs to check with Security::ignore_disallowed_actions()
-	 * @param $flag True or false
+	 * @param boolean $flag True or false
 	 */
 	public static function set_ignore_disallowed_actions($flag) {
 		self::$ignore_disallowed_actions = $flag;