silverstripe / silverstripe-framework

src/ORM/Versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -1065,7 +1065,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1185,7 +1185,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param Member|null $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1295,7 +1295,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -1371,7 +1371,7 @@ 
 	 *
 	 * @param string $stage
 	 * @param Member $member
-	 * @return bool
+	 * @return boolean|string
 	 */
 	public function canViewStage($stage = 'Live', $member = null) {
 		$oldMode = Versioned::get_reading_mode();
@@ -1436,7 +1436,7 @@ 
 	/**
 	 * Determines if the current draft version is the same as live
 	 *
-	 * @return bool
+	 * @return string
 	 */
 	public function latestPublished() {
 		// Get the root data object class - this will have the version field
@@ -2433,7 +2433,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {

src/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;

src/Security/CMSSecurity.php

Doc Comments +6 added lines

@@ -52,6 +52,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		/** @skipUpgrade */
 		return Controller::join_links(Director::baseURL(), "CMSSecurity", $action);
@@ -68,6 +71,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $title
+	 */
 	public function getResponseController($title) {
 		// Use $this to prevent use of Page to render underlying templates
 		return $this;

src/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));

src/Security/Member.php

Doc Comments +3 added lines, -3 removed lines

@@ -1563,7 +1563,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
@@ -1593,7 +1593,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
@@ -1627,7 +1627,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)) {

src/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()
 	 */

src/Security/PasswordValidator.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
 	 * Eg: $this->characterStrength(3, array("lowercase", "uppercase", "digits", "punctuation"))
 	 *
 	 * @param int $minScore The minimum number of character tests that must pass
-	 * @param array $testNames The names of the tests to perform
+	 * @param string[] $testNames The names of the tests to perform
 	 * @return $this
 	 */
 	public function characterStrength($minScore, $testNames) {

src/Security/Permission.php

Doc Comments +2 added lines, -2 removed lines

@@ -121,7 +121,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.
 	 */
@@ -159,7 +159,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.
 	 */

src/Security/Permission_Group.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,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.