silverstripe / silverstripe-framework

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/Security.php

Doc Comments +5 added lines, -5 removed lines

@@ -498,7 +498,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\DBField
 	 */
 	protected function generateLoginFormSet($forms) {
 		$viewData = new ArrayData(array(
@@ -784,7 +784,7 @@ 
 	 * For use in any subclass.
 	 *
 	 * @param string $name
-	 * @return array Returns the template(s) for rendering
+	 * @return string[] Returns the template(s) for rendering
 	 */
 	public function getIncludeTemplate($name) {
 		return array('Security_' . $name);
@@ -872,7 +872,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
@@ -959,7 +959,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');
@@ -1127,7 +1127,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;

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