silverstripe / silverstripe-framework

src/Security/MemberAuthenticator/LostPasswordHandler.php

Doc Comments +4 added lines, -1 removed lines

@@ -55,6 +55,7 @@ 
     /**
      * Return a link to this request handler.
      * The link returned is supplied in the constructor
+     * @param string $action
      * @return string
      */
     public function link($action = null)
@@ -115,7 +116,7 @@ 
      * Factory method for the lost password form
      *
      * @skipUpgrade
-     * @return Form Returns the lost password form
+     * @return LoginForm Returns the lost password form
      */
     public function lostPasswordForm()
     {
@@ -247,6 +248,8 @@ 
 
     /**
      * @todo copypaste from FormRequestHandler - refactor
+     * @param string $link
+     * @return string
      */
     protected function addBackURLParam($link)
     {

src/Security/MemberAuthenticator/Authenticator.php

Doc Comments +1 added lines

@@ -53,6 +53,7 @@
      * @param $message
      * @param bool &$success Success flag
      * @param null|Member $member If the parent method already identified the member, it can be passed in
+     * @param null|boolean $success
      * @return Member Found member, regardless of successful login
      */
     protected function authenticateMember($data, &$message, &$success, $member = null)

src/Security/MemberAuthenticator/CookieAuthenticationHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -36,7 +36,7 @@ 
     /**
      * Set the name of the cookie used to track this device
      *
-     * @param string $cookieName
+     * @param string $deviceCookieName
      * @return null
      */
     public function setDeviceCookieName($deviceCookieName)
@@ -57,7 +57,7 @@ 
     /**
      * Set the name of the cookie used to store an login token
      *
-     * @param string $cookieName
+     * @param string $tokenCookieName
      * @return null
      */
     public function setTokenCookieName($tokenCookieName)

src/ORM/DataObject.php

Doc Comments +9 added lines, -8 removed lines

@@ -2165,7 +2165,7 @@ 
      * Called by {@link __get()} and any getFieldName() methods you might create.
      *
      * @param string $field The name of the field
-     * @return mixed The field value
+     * @return string|null The field value
      */
     public function getField($field)
     {
@@ -2447,6 +2447,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $field
      */
     public function castingHelper($field)
     {
@@ -2552,7 +2553,7 @@ 
      * </code>
      *
      * @param string $methodName Method on the same object, e.g. {@link canEdit()}
-     * @param Member|int $member
+     * @param Member|null $member
      * @param array $context Optional context
      * @return boolean|null
      */
@@ -2575,7 +2576,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -2588,7 +2589,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -2601,7 +2602,7 @@ 
 
     /**
      * @param Member $member
-     * @return boolean
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {
@@ -2616,7 +2617,7 @@ 
      * @param Member $member
      * @param array $context Additional context-specific data which might
      * affect whether (or where) this object could be created.
-     * @return boolean
+     * @return boolean|string
      */
     public function canCreate($member = null, $context = array())
     {
@@ -2731,7 +2732,7 @@ 
      * Traverses to a field referenced by relationships between data objects, returning the value
      * The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
      *
-     * @param $fieldName string
+     * @param string $fieldName string
      * @return string | null - will return null on a missing value
      */
     public function relField($fieldName)
@@ -2809,7 +2810,7 @@ 
      * @param string $callerClass The class of objects to be returned
      * @param string|array $filter A filter to be inserted into the WHERE clause.
      * Supports parameterised queries. See SQLSelect::addWhere() for syntax examples.
-     * @param string|array $sort A sort expression to be inserted into the ORDER
+     * @param string $sort A sort expression to be inserted into the ORDER
      * BY clause.  If omitted, self::$default_sort will be used.
      * @param string $join Deprecated 3.0 Join clause. Use leftJoin($table, $joinClause) instead.
      * @param string|array $limit A limit expression to be inserted into the LIMIT clause.

src/Security/CMSSecurity.php

Doc Comments +6 added lines

@@ -49,6 +49,9 @@ 
         return parent::login($request, Authenticator::CMS_LOGIN);
     }
 
+    /**
+     * @param string $action
+     */
     public function Link($action = null)
     {
         /** @skipUpgrade */
@@ -79,6 +82,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $title
+     */
     public function getResponseController($title)
     {
         // Use $this to prevent use of Page to render underlying templates

src/Security/Member.php

Doc Comments +5 added lines, -6 removed lines

@@ -422,7 +422,6 @@ 
     /**
      * @deprecated Use Security::setCurrentUser() or IdentityStore::logIn()
      *
-     * @param bool $remember If set to TRUE, the member will be logged in automatically the next time.
      */
     public function logIn()
     {
@@ -737,9 +736,9 @@ 
      * });
      * </code>
      *
-     * @param Member|null|int $member Member or member ID to log in as.
+     * @param null|Member $member Member or member ID to log in as.
      * Set to null or 0 to act as a logged out user.
-     * @param $callback
+     * @param \Closure $callback
      */
     public static function actAs($member, $callback)
     {
@@ -1489,7 +1488,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)
     {
@@ -1520,7 +1519,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -1555,7 +1554,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {

src/Security/Security.php

Doc Comments +3 added lines, -2 removed lines

@@ -601,7 +601,7 @@ 
      * Combine the given forms into a formset with a tabbed interface
      *
      * @param $forms
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     protected function generateLoginFormSet($forms)
     {
@@ -1241,6 +1241,7 @@ 
 
     /**
      * For the database_is_ready call to return a certain value - used for testing
+     * @param boolean $isReady
      */
     public static function force_database_is_ready($isReady)
     {
@@ -1284,7 +1285,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)
     {

src/Security/IdentityStore.php

Doc Comments +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
      * @param Member $member The member to log in.
      * @param Boolean $persistent boolean If set to true, the login may persist beyond the current session.
      * @param HTTPRequest $request The request of the visitor that is logging in, to get, for example, cookies.
-     * @param HTTPResponse $response The response object to modify, if needed.
+     * @return void
      */
     public function logIn(Member $member, $persistent, HTTPRequest $request);
 
@@ -26,7 +26,7 @@ 
      * Log any logged-in member out of this identity store.
      *
      * @param HTTPRequest $request The request of the visitor that is logging out, to get, for example, cookies.
-     * @param HTTPResponse $response The response object to modify, if needed.
+     * @return void
      */
     public function logOut(HTTPRequest $request);
 }